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

Sat Apr 20 06:14:53 EDT 2013

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

Max Rydahl Andersen commented on TOOLSDOC-310:
----------------------------------------------

>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. 

That is *one* time a year.

>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. 

I'm not following you. I'm talking about getting a structure that works for the future where there are plenty of releases and having one structure that works for all is to me better than a mix.

>Plus, I don't really mind using Magnolia as I have to use it once every 6 weeks to do milestone releases >anyway. 

Magnolia is going away, it is not versionable, it is not sharable, permissions are a bitch to manage...

>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.

No idea why this is relevant. My suggestion is about creating a symbolic link. No need for PR's every 6 weeks.
(but I find it super valuable it is actually possible to do a PR so others can help and improve, with magnolia no such thing)

>b) moving things into subfolders gains exactly nothing except that we then have subfolders. What problem >are you trying to solve by nesting? 

That we stop having to move things into "archived". i.e. less work, less changing urls.

>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?)

Yes, as mentioned before other docs link to /latest assuming it is 3.3.x docs.

You can search this jira for the /latest url and find an issue like https://issues.jboss.org/browse/JBIDE-12243

Beyond that it is similar to what other projects do (seam, richfaces, infinispan and others), gives *less* work and easier to manage and use for users (stable urls) so I don't grok why you do not see the need/advantage.

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

I don't care. 

>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 

No idea why you are having problems the existing links works fine and I just created one inside archives - it works perfectly.

What I did find is that things I symbolic links in /tools directly gets a permission denied when fetching from browser, so yes something is wrong but all existing links works fine thus i'll ping helpdesk to see what is wrong.

> 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: Max Rydahl Andersen
>
> 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