[LUCENE-3166] src/site should not be built under /docs

• Type: Improvement
• Status: Closed
• Priority: Blocker
• Resolution: Fixed
• Fix Version/s: 3.3, 4.0-ALPHA
• Component/s: general/javadocs, general/website
• Lucene Fields: New
• Assignee: Unassigned
• Reporter: Shai Erera
• Created: 31/May/11 13:03
• Updated: 28/Aug/22 12:48
• Resolved: 11/Jun/11 21:33

Description

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:

1. 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.
2. have "ant docs" or "ant generate-docs" which generates javadocs + copy src/site/build under build/docs. Then all links will still work.
3. remove "docs" from svn and keep them under src/site/build.

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