Lucene - Core
  1. Lucene - Core
  2. LUCENE-3166

src/site should not be built under /docs

    Details

    • Lucene Fields:
      New

      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.

        Activity

        Hide
        Robert Muir added a comment -

        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.

        Show
        Robert Muir added a comment - 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.
        Hide
        Robert Muir added a comment -

        Also as a reminder: if we go this route, we need to update the HowToUpdateTheWebsite wiki page to match.

        Show
        Robert Muir added a comment - Also as a reminder: if we go this route, we need to update the HowToUpdateTheWebsite wiki page to match.
        Hide
        Robert Muir added a comment -

        Does anyone have any opinions on this proposal? If not, I'd like to begin working on this soon so we don't have this blocker sitting out there for 3.3...

        Show
        Robert Muir added a comment - Does anyone have any opinions on this proposal? If not, I'd like to begin working on this soon so we don't have this blocker sitting out there for 3.3...
        Hide
        Shai Erera added a comment -

        Does anyone have any opinions on this proposal?

        Don't know if it counts (since I opened it), but +1 to follow this proposal !

        Show
        Shai Erera added a comment - Does anyone have any opinions on this proposal? Don't know if it counts (since I opened it), but +1 to follow this proposal !
        Hide
        Robert Muir added a comment -

        bulk close for 3.3

        Show
        Robert Muir added a comment - bulk close for 3.3

          People

          • Assignee:
            Unassigned
            Reporter:
            Shai Erera
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development