You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Robert Muir (JIRA)" <ji...@apache.org> on 2011/05/31 15:36:47 UTC
[jira] [Commented] (LUCENE-3166) src/site should not be built under
/docs
[ https://issues.apache.org/jira/browse/LUCENE-3166?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13041578#comment-13041578 ]
Robert Muir commented on LUCENE-3166:
-------------------------------------
I like this solution: it removes the confusing docs/ folder, and eliminates a step (the cp -r) to updating the website.
So when you want to update the website, you just run forrest until you are happy, and press commit.
> 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