[hibernate-issues] [Hibernate-JIRA] Commented: (HHH-3435) Organize hibernate online docs

[Hardy Ferentschik (JIRA)]

    [ http://opensource.atlassian.com/projects/hibernate/browse/HHH-3435?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_30971 ] 

Hardy Ferentschik commented on HHH-3435:
----------------------------------------

Interesting. All of the three link point indeed to the same documentation. Looking at the webserver they all point to the same directory 'v3'. 'core' and 'reference' are just symbolic links to' v3'.  I am not sure what the initial thinking behind this was. The link used on the main documentation page (http://www.hibernate.org/5.html) is http://www.hibernate.org/hib_docs/v3/reference/en/html_single/ . Personally I would also prefer http://www.hibernate.org/hib_docs/core/reference/en/html_single/  since it would be more consistent with the other projects. However, I am not sure where you actually found all these links.

We could just try to locate all the links on the wiki and try to consistently point them to one target. To make sure that eg old bookmarks still work we could add some Apache Rewrite rules to the web server. 

Regarding the version number on the download page. I agree that it is a pain to update them, but I think we need them. As far as I know we only publish the documentation for GA releases whereas we don't update the documentation for CR releases. For this reason it is important to know for which version the documentation applies. It also gives the user some indication what the last 'stable' version is.

> Organize hibernate online docs
> ------------------------------
>
>                 Key: HHH-3435
>                 URL: http://opensource.atlassian.com/projects/hibernate/browse/HHH-3435
>             Project: Hibernate3
>          Issue Type: Task
>          Components: documentation
>            Reporter: Diego Plentz
>
> Today, we have:
> http://www.hibernate.org/hib_docs/core/reference/en/html_single/
> http://www.hibernate.org/hib_docs/reference/en/html_single/
> http://www.hibernate.org/hib_docs/v3/reference/en/html_single/
> I think that we must keep *just* /core (and create a redirect for the old ones, just to keep the links working).
> PS: Must update the docs.
> Another thing,
> http://www.hibernate.org/5.html could be changed to not include the last release version, so, when a new version is launched, we don't need to change the wiki page just to update the version number. So, instead of, for example:
> English (3.2.2 GA) 	 Online HTML 	 Single page HTML 	 PDF print version
> We will have:
> English 	 Online HTML 	 Single page HTML 	 PDF print version

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://opensource.atlassian.com/projects/hibernate/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira