Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Won't Fix
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: modules/examples
    • Labels:
      None
    • Lucene Fields:
      New

      Description

      The much maligned demo, while useful, could use a breath of fresh air. This issue is to start collecting requirements about what people would like to see in a demo and what they don't like in the current one.

      Ideas (not necessarily in order of importance):
      1. More in-depth tutorial explaining indexing/searching
      2. Multilingual support/demonstration
      3. Better demonstration of querying capabilities: Spans, Phrases, Wildcards, Filters, sorting, etc.
      4. Dealing with different content types and pointers to resources
      5. Wiki use cases links – I think it would be cool to solicit people to contribute use cases to the docs.
      6. Demonstration of contrib packages, esp. Highlighter
      7. Performance issues/factors/tradeoffs. Lucene lessons learned and best practices

      Advanced tutorials:
      1. Hadoop + Lucene
      2. Writing custom analyzers/filters/tokenizers
      3. Changing Scoring
      4. Payloads (when they are committed)

      Please contribute what else you would like to see. I may be able to address some of these issues for my ApacheCon talk, but not all of them.

        Activity

        Hide
        Erik Hatcher added a comment -

        The examples from Lucene in Action are freely available and Otis and I are fine with assigning the ASL to them (its currently unspecified but implicitly ASLd). If these would be useful, at least the Indexer.java and Searcher.java which are better demos than current demo application, we're free to use that as a starter. All the code could be contributed if folks are ok with that.

        In fact, maybe Otis and I should do the 2nd edition codebase within the Lucene svn somewhere so that it serves as a built-in example.

        Show
        Erik Hatcher added a comment - The examples from Lucene in Action are freely available and Otis and I are fine with assigning the ASL to them (its currently unspecified but implicitly ASLd). If these would be useful, at least the Indexer.java and Searcher.java which are better demos than current demo application, we're free to use that as a starter. All the code could be contributed if folks are ok with that. In fact, maybe Otis and I should do the 2nd edition codebase within the Lucene svn somewhere so that it serves as a built-in example.
        Hide
        Grant Ingersoll added a comment -

        I'm all for that the examples from LIA, but I also think the key part
        is the documentation that goes with it. I don't think it should be a
        requirement to buy LIA (even though I think everyone should )
        in order to understand the demo. So, we would have to figure out
        some way to get it documented w/o infringing on LIA, which may prove
        difficult.

        -Grant

        --------------------------
        Grant Ingersoll
        Center for Natural Language Processing
        http://www.cnlp.org

        Read the Lucene Java FAQ at http://wiki.apache.org/jakarta-lucene/
        LuceneFAQ

        Show
        Grant Ingersoll added a comment - I'm all for that the examples from LIA, but I also think the key part is the documentation that goes with it. I don't think it should be a requirement to buy LIA (even though I think everyone should ) in order to understand the demo. So, we would have to figure out some way to get it documented w/o infringing on LIA, which may prove difficult. -Grant -------------------------- Grant Ingersoll Center for Natural Language Processing http://www.cnlp.org Read the Lucene Java FAQ at http://wiki.apache.org/jakarta-lucene/ LuceneFAQ
        Hide
        Erik Hatcher added a comment -

        That was my concern as well, Grant. At least the LIA code is fairly well self documenting (we used JUnit for a reason and the build file itself is a nice example of how to launch applications and examples from a common starting point.

        What other documentation would be needed to make this a palatable?

        Show
        Erik Hatcher added a comment - That was my concern as well, Grant. At least the LIA code is fairly well self documenting (we used JUnit for a reason and the build file itself is a nice example of how to launch applications and examples from a common starting point. What other documentation would be needed to make this a palatable?
        Hide
        Grant Ingersoll added a comment -

        Hmm, might be cool to make things real for the demo by using either the Wikipedia download or the Reuters download. Thus, we could make the demo a Best Practices place as well.

        Show
        Grant Ingersoll added a comment - Hmm, might be cool to make things real for the demo by using either the Wikipedia download or the Reuters download. Thus, we could make the demo a Best Practices place as well.

          People

          • Assignee:
            Unassigned
            Reporter:
            Grant Ingersoll
          • Votes:
            3 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development