[
https://issues.apache.org/jira/browse/LUCENE-9459?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17176367#comment-17176367
]
Cassandra Targett commented on LUCENE-9459:
-------------------------------------------
Just a note here since the Solr Ref Guide came up in the issue that spawned
this (SOLR-13412), if you write the getting started guide in AsciiDoc format
(.adoc), then it will be tremendously simple for the Ref Guide to just consume
it entirely. Meaning, 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. This would be true after the
project repo split also.
It's just an option, though - I know Lucene doesn't have a process today for
converting .adoc files to HTML for the website or javadocs, so it might be too
complicated and a link from the Ref Guide (when we get there) is easier. That
would be fine, I just wanted to throw it out there as an option.
> "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
