lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Steven A Rowe <sar...@syr.edu>
Subject RE: Broken javadocs->site docs links
Date Thu, 06 Nov 2008 21:38:13 GMT
Hi Doug,

On 11/06/2008 at 4:22 PM, Doug Cutting wrote:
> Broken links in released docs might be fixed by adding
> redirects to the website, by editing:
> 
> http://svn.apache.org/repos/asf/lucene/.htaccess

This would not entirely fix the issue; each version's javadocs should link to the same version
of the site docs, rather than to the latest version (which is what I assume you mean here).
 

For example, the 2.3.2 version of the the o.a.l.document package summary should link to the
2.3.2 version of gettingstarted.html, instead of to the 2.4.0 version (currently the latest).


> The trunk javadocs should not be published on the website.  We should
> only publish released documentation.

The trunk javadocs are published on hudson.zones.apache.org, and are linked to from the Developers
page on the site.  Are you arguing that the trunk javadocs should not be published anywhere
at all?

Steve

> Steven A Rowe wrote:
> > When the Lucene Java website transitioned to versioning
> > some of the documentation, links from some javadocs were not
> > modified to follow the resources.  I found broken links to
> > gettingstarted.html, queryparsersyntax.html, and
> > fileformats.html from the javadocs, in both the 2.4.0 and the
> > trunk javadocs.  Here is one example, to gettingstarted.html
> > (the link text is "demo"):
> > 
> > 
> <http://lucene.apache.org/java/2_4_0/api/org/apache/lucene/document/package-summary.html>
> > 
> <http://hudson.zones.apache.org/hudson/job/Lucene-trunk/javadoc//org/apache/lucene/document/package-summary.html>
> > 
> > The javadocs for o.a.l.search.Similarity fixes this for
> > queryparsersyntax.html in the versioned site docs by using a
> > relative URL, but since the versioned documentation does not
> > appear to be included in the Hudson build, the link is broken
> > for the trunk javadocs (link text: "query syntax"):
> > 
> <http://hudson.zones.apache.org/hudson/job/Lucene-trunk/javadoc/org/apache/lucene/search/Similarity.html>
> > 
> > How should this be fixed?
> > 
> > For the versioned javadocs, the links clearly should be to
> > the versioned site documentation.  If all of the absolute
> > URLs were changed to be relative URLs, as in
> > o.a.l.search.Similarity's javadocs, then the versioned
> > javadocs issue would be resolved.  The trunk javadocs links,
> > however, would remain broken.
> > 
> > For the trunk javadocs, the links would ideally be to trunk
> > versions of the site documentation, but I can't find trunk
> > versions of the versioned site documentation on Hudson.  Is
> > this intentional?
 


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


Mime
View raw message