lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Hoss Man (JIRA)" <j...@apache.org>
Subject [jira] Commented: (LUCENE-2499) Many of the links on the LuceneFAQ result in 404 errors
Date Mon, 14 Jun 2010 22:11:14 GMT

    [ https://issues.apache.org/jira/browse/LUCENE-2499?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12878772#action_12878772
] 

Hoss Man commented on LUCENE-2499:
----------------------------------

at the current moment, the problem is that those links *do* redirect to hudson, but the redirect
doesn't use the correct base path.

The way we got to this situation (as i understand it)

# nightly docs use to be hosted on lucene.apache.org
# it was decided that only the "official" docs for each released version should live on lucene.apache.org,
and that the nightly docs should only exist on hudson since they are for developers only -
a redirect was added for any old links
# the javadoc directory structure was changed, so that there is a top level directory, with
subdirectories for "all", "core" and each contrib.

The simplest way to make those URLs work is to update the existing hudson redirect so that
http://lucene.apache.org/java/docs/api/ redirects to http://hudson.zones.apache.org/hudson/job/Lucene-trunk/javadoc/all/
instead of http://hudson.zones.apache.org/hudson/job/Lucene-trunk/javadoc/

But that still doesn't address the original reason why the redirect was added: to stop "featuring"
nightly docs for typical users.

I would suggest that what we should do (especially now that we have parallel development going
on in both 3x and 4x branches) is support long lived URLs for the docs from the "latest" release
of each branch

All of these URLs should "work", and none should redirect anywhere else -- they should surface
identical content...

* http://lucene.apache.org/java/3_0_1/ 
* http://lucene.apache.org/java/3_0-latest/
* http://lucene.apache.org/java/3-latest/
* http://lucene.apache.org/java/latest/

...when 3.0.2 is an official release, we add http://lucene.apache.org/java/3_0_2/ and the
content on all of the "latest" URLs becomes identical to it.  when 4.0.0 is released then
we add...
* http://lucene.apache.org/java/4_0_0/ 
* http://lucene.apache.org/java/4_0-latest/
* http://lucene.apache.org/java/4-latest/
...which are all identical, and make http://lucene.apache.org/java/latest/ a mirror of them
as well.

The main idea being: you can link to the docs at whatever level of granularity makes sense
based on context.  In a FAQ about IndexSearcher, you can probably just link to the javadocs
under http://lucene.apache.org/java/latest/ ... but if you are referencing a new method added
in 4.2, then you probably want to link to http://lucene.apache.org/java/4-latest/ ... and
if you are referencing a bug fix in a partiular point release, then you might want to link
directly to it.

As far as the implementation -- simple directory symlinks are probably the easiest way to
go.



> Many of the links on the LuceneFAQ result in 404 errors
> -------------------------------------------------------
>
>                 Key: LUCENE-2499
>                 URL: https://issues.apache.org/jira/browse/LUCENE-2499
>             Project: Lucene - Java
>          Issue Type: Improvement
>          Components: Website
>            Reporter: Erick Erickson
>            Assignee: Uwe Schindler
>            Priority: Minor
>
> http://wiki.apache.org/lucene-java/LuceneFAQ
> exmples:
> http://lucene.apache.org/java/docs/api/org/apache/lucene/queryParser/QueryParser.html#setLowercaseExpandedTerms(boolean)
> http://lucene.apache.org/java/docs/api/org/apache/lucene/search/Filter.html
> http://lucene.apache.org/java/docs/api/org/apache/lucene/search/CachingWrapperFilter.html
> Uwe's comment:
> We could add an additional entry to .htaccess that redirects to the latest released version.
We have something similar, but that points to Hudson.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


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


Mime
View raw message