Uploaded image for project: 'Lucene - Core'
  1. Lucene - Core
  2. LUCENE-9459

"Getting Started" guide for Luke

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: modules/luke
    • Labels:
    • Lucene Fields:
      New

      Description

      While Luke has been very popular, widely accepted tool to Lucene users (including Solr and Elasticsearch users) for 10+ years, it lacks good documentation and/or user guide. Although Luke is a GUI tool that describes itself, it's not good for new users.

      The lack of documentation is partly due to my laziness though, there is some inherent difficulty of explaining such low-level tool; if you don't know Lucene you don't understand Luke's capability or usefulness, if you once understand Lucene at some level, it's obvious to you and no explanation is needed.  

      Nonetheless, it would be great if we have "Getting Started" documentation for Luke on our web site for new users/devs.

      We may be able to have a Markdown file with some screenshots and usage descriptions, then convert it to HTML by Gradle task,  so that we can publish it with whole API documentation.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              tomoko Tomoko Uchida
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated: