Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upDocumentation - add link to latest current version in the reference #24526
Comments
|
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. |
|
Thanks for the example. Doc pages have a 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. |



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:
Sample how it is done in VueJS docs:
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.