[
https://issues.apache.org/jira/browse/SOLR-14829?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17191009#comment-17191009
]
Johannes Baiter commented on SOLR-14829:
----------------------------------------
{quote}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
{quote}
Sure, I'll try to get a better picture of the code/architecture first, though,
so I have a better picture of it and am not just ranting based on some
superficial observations :-)
{quote}In your own/custom definition of your request handler, do you need to
actually list these components at all, vs just rely on the default list? I
think most people by far let the defaults happen.
{quote}
Yeah, in my case I have a custom highlight component that I want to have on my
handler. Sure, there's {{first-components}} and {{last-components}}, which
would probably better for this case.
But I think we can agree that if there's an option to define your own
{{components}}, the documentation on the defaults for this option should be
correct so that users can operate under the right assumptions? Especially since
the documentation treats {{first-components}}, {{last-components}} and
{{components}} as equals, i.e. there's no comment indicating that the former
two might be preferable because they're "safer"?
> 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, examples
> 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-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
