crunch-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Gabriel Reid (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CRUNCH-327) Add a "current" version link to the API docs in the website
Date Thu, 06 Mar 2014 20:12:43 GMT

    [ https://issues.apache.org/jira/browse/CRUNCH-327?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13922991#comment-13922991
] 

Gabriel Reid commented on CRUNCH-327:
-------------------------------------

I've just made an attempt to get this working, without much success.

I attempted to just create a symlink called "current" in under https://svn.apache.org/repos/asf/crunch/site/trunk/content/apidocs/,
but that doesn't seem to work.

Going through the CMS documentation [1], it appears that symlinks aren't natively supported
by the CMS, and the only way to create a symlink is to manually update the production copy
of the website. Although this would work for now, I think that it would unnecessarily complicate
the release process.

The options that I see now are:
* have two copies of the latest API docs, one with the version number and one with "current"
* put a page with some kind of javascript redirect in an index.html under the "current" directory,
and update that with each new release

I think that both of those options are pretty awful, so I'm somewhat inclined to drop this.
On the other hand, I'd really like it if we could automatically link to the latest javadocs
in the user guide. Does anyone else have any better ideas (or a deeper understanding of the
CMS)?

[1] https://www.apache.org/dev/cmsref.html#mail-link

> Add a "current" version link to the API docs in the website
> -----------------------------------------------------------
>
>                 Key: CRUNCH-327
>                 URL: https://issues.apache.org/jira/browse/CRUNCH-327
>             Project: Crunch
>          Issue Type: Improvement
>          Components: Site
>            Reporter: Gabriel Reid
>            Priority: Minor
>
> It's a common pattern for java projects to have a (sym)link to the "current" version
their API docs, in addition to versions that include the actual version number in the URL
(for example: http://avro.apache.org/docs/current/api/java/index.html).
> Having such a thing in place would also make it possible to have links in the User Guide
always point to the current version of the API, instead of a hardcoded version number.



--
This message was sent by Atlassian JIRA
(v6.2#6252)

Mime
View raw message