[
https://issues.apache.org/jira/browse/SOLR-14829?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17201841#comment-17201841
]
Alexandre Rafalovitch commented on SOLR-14829:
----------------------------------------------
Ok, the [Reference Guide
page|https://lucene.apache.org/solr/guide/8_6/requesthandlers-and-searchcomponents-in-solrconfig.html]
is rather a mess. Here is a couple of things that need cleaning up:
* defaults, appends, and invariants are defined as part of SearchHandler,
should be all handlers
* we mention initParams (in general section, good) but not useParams
* it is very hard to notice that SearchComponents references (components,
first-components, last-components) are actually section *inside* SearchHandlers
only, partially because they are so far apart
* we don't actually explain how to declare a custom search component explicitly
(some definitions are available on linked pages)
* we don't have example of UpdateRequestHandlers either in the doc or in
solrconfig.xml (because they all became implicit)
* we don't mention UpdateRequestProcessors, which could be viewed as a parallel
pipeline to SearchComponents
I am going to try refactoring that page.
> Update default components information in Reference Guide and solrconfig.xml
> files
> ---------------------------------------------------------------------------------
>
> Key: SOLR-14829
> URL: https://issues.apache.org/jira/browse/SOLR-14829
> Project: Solr
> Issue Type: Bug
> Security Level: Public(Default Security Level. Issues are Public)
> Components: documentation, examples
> Affects Versions: 8.6.2
> Reporter: Johannes Baiter
> Assignee: Alexandre Rafalovitch
> Priority: Minor
> Attachments: SOLR-14829.patch
>
>
> In the reference guide, the list of search components that are enabled by
> default is missing the {{facet_module}} and {{terms}} components. The terms
> component is instead listed under "other useful components", while the
> {{FacetModule}} is never listed anywhere in the documentation, despite it
> being neccessary for the JSON Facet API to work.
> This is also how I stumbled upon this, I spent hours trying to figure out why
> JSON-based faceting was not working with my setup, after taking a glance at
> the {{SearchHandler}} source code based on a hunch, it became clear that my
> custom list of search components (created based on the list in the reference
> guide) was to blame.
> A patch for the documentation gap is attached, but I think there are some
> other issues with the naming/documentation around the two faceting APIs that
> may be worth discussing:
> * The names {{facet_module}} / {{FacetModule}} are very misleading, since
> the documentation is always talking about the "JSON Facet API", but the term
> "JSON" does not appear in the name of the component nor does the component
> have any documentation attached that mentions this
> * Why is the {{FacetModule}} class located in the {{search.facet}} package
> while every single other search component included in the core is located in
> the {{handler.component}} package?
--
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
