[jbosstools-issues] [JBoss JIRA] (TOOLSDOC-310) redirect /latest to /reference where the latest released docs can be found

Nick Boldt (JIRA) jira-events at lists.jboss.org
Fri Apr 19 13:57:53 EDT 2013


    [ https://issues.jboss.org/browse/TOOLSDOC-310?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12768911#comment-12768911 ] 

Nick Boldt commented on TOOLSDOC-310:
-------------------------------------

Other than the fact that the 4.0.0.Final folder no longer has an index page, and needs to contain one, I see your suggestions [~maxandersen] as being more effort than is justified.

Here are my concerns:

a) even if https://www.jboss.org/tools/docs/reference/ pointed at http://docs.jboss.org/tools/4.0.x/ instead of http://docs.jboss.org/tools/4.0.1.Final/, we'd still have to update the page when 4.1 is released. And as there's no plan for a 4.0.2 at this time, the only next time we'd have to update the page is when 4.1 is released. Your argument that there's more maintenance to be done here is only valid IFF a 4.0.2 or 3.3.3 happens for which the docs need to be rebuilt. Plus, I don't really mind using Magnolia as I have to use it once every 6 weeks to do milestone releases anyway. Changing a line of text in a field in Magnolia it is actually less work IMHO than creating a topic branch, pulling updates from origin, committing a  code change, pushing to my fork, generating a PR, waiting for the PR to be approved, pushing the PR, and deleting my topic branch.

b) moving things into subfolders gains exactly nothing except that we then have subfolders. What problem are you trying to solve by nesting? We can still have a symlink to "latest". Is there a usecase for 3.3/latest and 4.0/latest ? Because I can't see the need. Has anyone other than yourself requested this? (Is there a customer or community requirement?)

c) First you asked for 4.0.x, then you asked for 4.0/latest. Which is your preferred approach? 

d) Regarding symlinks, you are welcome to do it your way (which is the way I used to until eng-ops changed stuff on the server) but when that doesn't work, read this and do it my way instead: https://engineering.redhat.com/rt/Ticket/Display.html?id=191655 :D
                
> 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: Nick Boldt
>
> 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