lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Shai Erera (JIRA)" <j...@apache.org>
Subject [jira] [Created] (LUCENE-3166) src/site should not be built under /docs
Date Tue, 31 May 2011 13:04:47 GMT
src/site should not be built under /docs
----------------------------------------

                 Key: LUCENE-3166
                 URL: https://issues.apache.org/jira/browse/LUCENE-3166
             Project: Lucene - Java
          Issue Type: Improvement
          Components: general/javadocs, general/website
            Reporter: Shai Erera
            Priority: Blocker
             Fix For: 3.3, 4.0


I noticed that the source package contains a "docs" subdir with all the site's docs. Also,
the root has index.html which nicely points to all those documents. However, it also points
to the Javadocs which are absent. If you "ant javadocs", they are built under build/docs/api,
which makes the links in index.html still invalid.

Iterating on it shortly, Robert and I think that the following should be done:
# have src/site docs built under src/site/build. Today they already are, but later "cp -r"
under /docs, so we should remove the copy instruction.
# have "ant docs" or "ant generate-docs" which generates javadocs + copy src/site/build under
build/docs. Then all links will still work.
# remove "docs" from svn and keep them under src/site/build.

Marking it a blocker for 3.3 so we revisit before then.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

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


Mime
View raw message