[jira] [Commented] (SOLR-14829) Default components are missing facet_module and terms in documentation

["Ishan Chattopadhyaya (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SOLR-14829?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17190430#comment-17190430 ] 

Ishan Chattopadhyaya commented on SOLR-14829:
---------------------------------------------

Thanks [~jbaiter]. I'll take a look soon (unless Cassandra beats me to it).

bq.     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
bq.    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?

These are very important concerns and something we need to tackle going forward for better consistency. I can offer historical perspective on why it is this way, but I think we should seriously think of streamlining this going forward -- there is no reason why this inconsistency should persist. Would you like to open a new JIRA issue on those concerns so that I can invite a wider discussion around it from some of the committers who are in the best position to resolve this (e.g. [~ctargett], [~hossman], [~yonik], et. al.)?

Just want to share your Twitter thread here, because I believe it is a very illustrative example of where Solr needs improvement: https://twitter.com/jbaiter_/status/1301518376246874116. FYI, [~arafalov] is leading an effort for improving our examples. We have discussed some other aspects of getting started documentation here: https://issues.apache.org/jira/browse/SOLR-14726.

> Default components are missing facet_module and terms in documentation
> ----------------------------------------------------------------------
>
>                 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
>    Affects Versions: 8.6.2
>            Reporter: Johannes Baiter
>            Assignee: Ishan Chattopadhyaya
>            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-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org