lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Chris Hostetter <hossman_luc...@fucit.org>
Subject Re: site javadocs and resolved issue 678
Date Tue, 31 Oct 2006 22:22:48 GMT

: 1. Site documentation is generated as part of Lucene build, and is
: versioned with Lucene.
: 2. Wiki documentation is not versioned with Lucene, and unrelated to the
: build.
: 3. Improvements to documentation would be nice to have in the public site
: (e.g. scoring) even before released.
: 4. Documentation changes e.g. file-format, query syntax - would be quite
: confusing to have in the public site before released, unless it is clearly
: stated that "this is for most current build" and online documentation for
: past releases is available elsewhere.

as far as i know, all of the docs on the site that are version specific
(ie: have had changes made to them at some point that are not backwards
compatible) already specify which version they are current for .. see the
overview sections of the query syntax and file format docs to understand
what i mean.

In my opinion, the fact that the entire site is included with each release
makes it really easy to say that the documentation on the site (both the
xdocs and the javadocs) should be for the "trunk", and people with
questions about specific releases should consult the docs included with
the release ... if we also want to have those versions linkable online
that's fine, but i feel like the "default" should be the most bleeding
edge stuff so more people can spot mistakes or ask questions about things
that are confusing.




-Hoss


---------------------------------------------------------------------
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