[hibernate-dev] The stable docs are outdated

[Steve Ebersole]

First, that would indicate that something is wrong with the ORM release
task.  The `stageDocumentationForUpload` task does create a symlink for
stable pointing to 5.0.  Clearly something is broken there.

Second, is that really the intent for "stable"?  When we first starting
doing "stable" the intent was to have stable URLs for bookmarking etc.
What you describe, and how we actually handle it (at least on the ORM
side), is more of a "current".  As we fix google indexing and revamp the
ORM docs I think this is the perfect time to reconsider all of this.  Like
if this is really meant to point to current docs, why are we calling it
"stable" instead of "current" like the rest of the sane universe? ;)

Also in terms of ontology, I'd prefer to invert the URL pattern here a
bit.  So currently we have `hibernate/stable/{project}/...`.  This causes
problems in terms of releasing because every project's release has to do a
sftp/rsync to the root Hibernate directory (`hibernate/`) on the doc server
to update the "stable" symlink.  Which is dangerous.  I'd prefer that we
invert that to instead be `hibernate/{project}/stable` (or better yet
`hibernate/{project}/current`).  We can keep the
`hibernate/stable/{project}/...`
symlinks; they'd simply point to `hibernate/{project}/current` and never
even have to be updated.

So, using ORM e.g., we'd have:

* hibernate/orm/4.3 (real directory with docs)
* hibernate/orm/5.0 (real directory with docs)
* hibernate/orm/current (symlink currently pointing to hibernate/orm/5.0)
* hibernate/stable/core (static symlink pointing to hibernate/orm/current)

On Thu, Jan 7, 2016 at 7:42 AM Vlad Mihalcea <mihalcea.vlad at gmail.com>
wrote:

> Hi,
>
> I realized that the stable docs reference is pointing to 4.0.1.Final
>
> http://docs.jboss.org/hibernate/stable/core/javadocs/
>
> and not to 5.0.6
>
> https://docs.jboss.org/hibernate/orm/5.0/javadocs/
>
> Shouldn't we update the stable docs to the latest reference?
> This would be desirable if you choose to instruct Google to index the
> stable docs only.
>
> Vlad
> _______________________________________________
> hibernate-dev mailing list
> hibernate-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/hibernate-dev
>