[
https://issues.apache.org/jira/browse/LUCENE-9459?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17176403#comment-17176403
]
Tomoko Uchida commented on LUCENE-9459:
---------------------------------------
Hi [~ctargett],
{quote}instead of asking readers of the Ref Guide to go somewhere else to find
out how to use Luke, they can learn about it right there and we still have a
single file to maintain.
{quote}
good input, thanks! I think we firstly should follow Lucene convention
(Markdown), but we could convert .md file to .adoc file when building
documentation (there may be converter tool, or we may be able to write a simple
tool for that).
> "Getting Started" guide for Luke
> ---------------------------------
>
> Key: LUCENE-9459
> URL: https://issues.apache.org/jira/browse/LUCENE-9459
> Project: Lucene - Core
> Issue Type: Improvement
> Components: modules/luke
> Reporter: Tomoko Uchida
> Priority: Major
> Labels: newdev
>
> 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.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
