[jbosstools-issues] [JBoss JIRA] (TOOLSDOC-310) redirect /latest to /reference where the latest released docs can be found
Max Rydahl Andersen (JIRA)
jira-events at lists.jboss.org
Wed Apr 17 06:15:54 EDT 2013
[ https://issues.jboss.org/browse/TOOLSDOC-310?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12767967#comment-12767967 ]
Max Rydahl Andersen commented on TOOLSDOC-310:
----------------------------------------------
huh...
on jboss.org/tools/docs/reference the html contains *exact* links to http://docs.jboss.org/tools/4.0.1.Final/en/GettingStartedGuide/html_single/index.html
This means it needs updating *everytime*.
If it /reference site pointed to for example:
http://docs.jboss.org/tools/4.0.x-latest/en/GettingStartedGuide/html_single/index.html
There would be zero maintanence besides updating that symbolic link.
Additionally *other* docs reference our docs - this is not just about us and our internal links.
And finally, /reference is a wall of text, slow to load and I (as a user) have to know how to scroll down to find 3.3.x etc. docs.
I'm not asking for links to more wall of texts - I'm asking for links being more direct, see the examples I gave for seam3 and richfaces.
The latest now reference something at a higher level than what latest was used for.
We want to *remove* the need to have to use or update via magnolia - even if we had a text file this was in I cannot see how updating a *single* symbolic link is considered more work than having to update (wether manual or scripted) the long list of links on a webpage.
> redirect /latest to /reference where the latest released docs can be found
> --------------------------------------------------------------------------
>
> Key: TOOLSDOC-310
> URL: https://issues.jboss.org/browse/TOOLSDOC-310
> Project: Documentation for JBoss Tools and Developer Studio
> Issue Type: Feature Request
> Security Level: Public(Everyone can see)
> Reporter: Max Rydahl Andersen
> Assignee: Michelle Murray
>
> for some reason https://github.com/jbosstools/jbosstools-documentation/pull/48 removed the latest link assuming latest is used to point to the nightly build.
> That is not what it is for.
> It is to point to the latest docs made available.
> This link (before: http://docs.jboss.org/tools/latest/) was used to point to the last latest documentation.
> I believe this should be put back since this is how other docs refer to the latest version.
> We could even go so ar to create a docs.jboss.org/tools/4.0, docs.jboss.org/tools/3.3 etc. folder each with their /latest link in them.
> Latest links are trivial to make with sftp as part of the release upload anyway thus should be all possible to script if it is too cumbersome to remember.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
More information about the jbosstools-issues
mailing list