Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.5, 4.0-ALPHA
    • Component/s: modules/facet
    • Labels:
      None
    • Lucene Fields:
      New, Patch Available

      Description

      In LUCENE-3079 I've uploaded a userguide for the faceting module. I'd like to discuss where is the best place to include the module. We include it with the code (in our SVN), so that it's always attached to some branch (or in other words a release). That way we can have versions of it per releases that reflect API changes.

      This document is like the file format document, or any other document we put under site-versioned. So we have two places:

      • facet/docs
      • site/userguides

      Unlike the site, which its PDFs are built automatically by Forrest, we cannot convert ODT to PDF with it, so it's a challenge to put it there. What we do today (in our SVN) is whoever updates the userguide, creates a PDF too, that's easy from OpenOffice.

      I'll upload the file later when I'm in front of it.

      1. facet-userguide.pdf
        283 kB
        Shai Erera
      2. LUCENE-3261.patch
        42 kB
        Shai Erera

        Activity

        Uwe Schindler made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        Hide
        Uwe Schindler added a comment -

        Bulk close after release of 3.5

        Show
        Uwe Schindler added a comment - Bulk close after release of 3.5
        Shai Erera made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        Hide
        Shai Erera added a comment -

        Committed revision 1175340 (3x).
        Committed revision 1175341 (trunk).

        Show
        Shai Erera added a comment - Committed revision 1175340 (3x). Committed revision 1175341 (trunk).
        Shai Erera made changes -
        Fix Version/s 3.5 [ 12317877 ]
        Fix Version/s 4.0 [ 12314025 ]
        Lucene Fields [New] [New, Patch Available]
        Shai Erera made changes -
        Attachment LUCENE-3261.patch [ 12496385 ]
        Hide
        Shai Erera added a comment -

        Patch against 3x. Adds userguide.html as well as fixes facet/build.xml to include the example code with the javadocs.

        I think this is ready to commit.

        Show
        Shai Erera added a comment - Patch against 3x. Adds userguide.html as well as fixes facet/build.xml to include the example code with the javadocs. I think this is ready to commit.
        Hide
        Shai Erera added a comment -

        Yes, we should include it. I wasn't sure about the source format though ... if I add the .odt version, is that acceptable? Should I maybe add both .odt and .pdf and we release just the PDF? Or .. perhaps I'll just convert it to HTML. I'll see how much work is needed for that.

        Show
        Shai Erera added a comment - Yes, we should include it. I wasn't sure about the source format though ... if I add the .odt version, is that acceptable? Should I maybe add both .odt and .pdf and we release just the PDF? Or .. perhaps I'll just convert it to HTML. I'll see how much work is needed for that.
        Hide
        Uwe Schindler added a comment -

        When looking into the TARBALL of Lucene 3.4, I missed this great guide in the facet contrib directory. Would it not be a good idea to include it in the module root dir?

        Show
        Uwe Schindler added a comment - When looking into the TARBALL of Lucene 3.4, I missed this great guide in the facet contrib directory. Would it not be a good idea to include it in the module root dir?
        Shai Erera made changes -
        Field Original Value New Value
        Attachment facet-userguide.pdf [ 12484723 ]
        Hide
        Shai Erera added a comment -

        Attaching the userguide from LUCENE-3079.

        Show
        Shai Erera added a comment - Attaching the userguide from LUCENE-3079 .
        Shai Erera created issue -

          People

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

            Dates

            • Created:
              Updated:
              Resolved:

              Development