apache / apache/lucene

"Getting Started" guide for Luke [LUCENE-9459]

Open
#10,499 6 comments 0 reactions 0 assignees View on GitHub
legacy-jira-label:newdev legacy-jira-priority:Major module:luke type:enhancement
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

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.

---
Migrated from [LUCENE-9459](https://issues.apache.org/jira/browse/LUCENE-9459) by Tomoko Uchida (@mocobeta), updated Sep 02 2020

Contributor guide

Open the contributing guide

Research direction

Start by reviewing Luke and the existing web/API documentation publication flow, then identify where a Markdown guide and its Gradle conversion task belong. Cover installation or launch, core usage, screenshots, and the Lucene knowledge needed to understand Luke; done means the guide is published as HTML for new users.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, markdown
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.