The Wayback Machine - https://web.archive.org/web/20200604024752/https://github.com/spring-projects/spring-framework/issues/24526
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation - add link to latest current version in the reference #24526

Open
maciejwalkowiak opened this issue Feb 14, 2020 · 3 comments
Open

Documentation - add link to latest current version in the reference #24526

maciejwalkowiak opened this issue Feb 14, 2020 · 3 comments
Assignees
Milestone

Comments

@maciejwalkowiak
Copy link

@maciejwalkowiak maciejwalkowiak commented Feb 14, 2020

Search engines results often lead to old versions of Spring Framework reference and it is becoming a habit to go to address bar and change the version in the URL to current.

As I imagine it's not straightforward to optimise reference website for promoting latest current version in search results, one solution I have in mind is to add for every version older than current an information like:

This is the documentation for an older version of Spring Framework. If you’re looking for the current documentation click here.

Sample how it is done in VueJS docs:

image

Ideally it would link to the same page/section of the reference or redirect to reference home if section does not exist in the latest current version.

@rstoyanchev
Copy link
Contributor

@rstoyanchev rstoyanchev commented Feb 20, 2020

If you're looking at some 4.3.x version, or even older, would you consider current to be 4.3.26 or 5.2.3? Needless to say there is quite a bit of a difference between the two.

Generally when using a search engine, you should see links that point to the "current" Spring Framework reference, https://docs.spring.io/spring/docs/current/spring-framework-reference/. If that is not the case it would be useful to know.

For anything else pointing to a very specific version, it's not clear if the intent is to actually point to that branch or not.

@maciejwalkowiak
Copy link
Author

@maciejwalkowiak maciejwalkowiak commented Feb 20, 2020

In such scenario I would consider the latest stable - 5.2.3 - to be current. If I'm stuck on older version I would be most likely searching explicitly for this version.

Screenshot_20200220-204806_Chrome
In this example, first result links to 5.0.0-build-snapshot, second result to 4.1. There's no easy way to find out which is current just by looking at search results.

@rstoyanchev
Copy link
Contributor

@rstoyanchev rstoyanchev commented Mar 13, 2020

Thanks for the example.

Doc pages have a "canonical" header pointing to the "current" version but in this case, the canonical reference is a 404 (oops!). I guess the rules for adding canonical references to requests are brittle because of structural changes. We can and will address that issue, reviewing all rules for canonical links, but we'll also take some further steps.

Re-think SEO strategy for doc pages, e.g. to prevent indexing of older versions, e.g. snapshots and duplicate maintenance versions, but we've some differences of opinion on whether to index "current" only or also major/minor versions. We'll have to do some homework on SEO for multi-version doc pages, but also suggestions or pointers welcome!

Consider drop-down that lists the latest for currently active branches.

SEO updates should ensure you arrive at "current" when coming through a search engine. A drop-down with links to the docs for currently maintained branches would help when following a link to a specific version.

In the mean time, check for the "current" alias in the URL and/or manually switch to it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 participants
You can’t perform that action at this time.