[
https://issues.apache.org/jira/browse/SOLR-13662?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16981197#comment-16981197
]
David Smiley commented on SOLR-13662:
-------------------------------------
If we consider the scope of this issue to be not only the CLI but also
substantially the ref guide documentation, then keep it open. We don't have a
docs specific issue and since the work has already happened under this issue,
then here it is. I will add my high level structural comments about the docs
without getting into line-by-line (yet).
[~ichattopadhyaya] [~noble.paul] [~ctargett] please review my high level points
here. I nominate myself to make the changes but I want this strategy vetted
first.
Solr already has some documentation about the notion of plugins, so we must
contend with that in a wholistic review instead of just adding some new adoc
into our tree somewhere. Solr has a second level "Solr Plugins" nav
category/page -- "solr-plugins.adoc" that is underneath "The Well-Configured
Solr Instance". Such category pages are rather important to get right in
communicating the big ideas to frame what this is all about and at a high level
what does Solr offer. I also think our page organization is rather important
for the same reason and for discoverability. I'm not sure I like the category
"The Well-Configured Solr Instance". It's opening sentence (an important
sentence to get right) claims it's about performance. I would not have guessed!
What do we think about moving Solr Plugins to the top level, assuming we beef
it up, which I'm about to describe?
The solr-plugins.adoc page today has a decent opening couple paragraphs
speaking in broad strokes, but then has only one last paragraph relating to the
"Blob Store API" & runtimeLib. That system is currently the only child page.
Little does the user know this is deprecated functionality. I advocate that we
make this section of our guide (Solr Plugins) more comprehensive. We already
have a decent page "resource-and-plugin-loading.adoc" covering lib directives
that is very pertinent to Solr Plugins that is currently located beneath
"Configuring solrconfig.xml". I think that _used to_ be a great place for it
before there was a "Solr Plugins" nav but now I think it's here beneath Solr
Plugins. Ishan/Noble placed the "Package Management" "package-manager.adoc"
underneath "The Well-Configured Solr Instance" but I very much disagree; I feel
this must go beneath "Solr Plugins".
I think we should communicate 3 paths:
# Place jars of plugins in certain "lib" dirs or reference via solrconfig.xml
lib directive (similar)
# Use the new Package Manager system
# Use the old Blob Store & Runtime Lib system
On this page we can point out some broad pros/cons (e.g. not supporting schema
plugins), but further details will be on the respective pages.
Cassandra, can we use folders to organize our .adoc files instead of having
them all in one super-long list?
> Package manager CLI
> -------------------
>
> Key: SOLR-13662
> URL: https://issues.apache.org/jira/browse/SOLR-13662
> Project: Solr
> Issue Type: Sub-task
> Security Level: Public(Default Security Level. Issues are Public)
> Reporter: Noble Paul
> Assignee: Ishan Chattopadhyaya
> Priority: Major
> Attachments: plugin-cli.png
>
> Time Spent: 15.5h
> Remaining Estimate: 0h
>
> Design details and usage details are here:
> https://docs.google.com/document/d/15b3m3i3NFDKbhkhX_BN0MgvPGZaBj34TKNF2-UNC3U8/edit?ts=5d86a8ad#
--
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
