SOLR-14572 document missing SearchComponents #1581

epugh · 2020-06-15T20:25:38Z

Description

Learned about a existing SearchComponent from 2012. Went to look at the related Ref Guide page and saw it was missing, plus two other components.

Solution

Add a table linking to the JavaDocs. Also point to the http://solr.cool website.

Tests

ant build of the ref guide.

Checklist

Please review the following and check all that apply:

[ X] I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
[ X] I have created a Jira issue and added the issue ID to my pull request title.
[ X] I have given Solr maintainers access to contribute to my PR branch. (optional but recommended)
[X ] I have developed this patch against the master branch.
I have run ant precommit and the appropriate test suite.
I have added tests for my changes.
[ X] I have added documentation for the Ref Guide (for Solr changes only).

Merge branch 'patch-1' of https://github.com/ohtwadi/lucene-solr

…al site with components.

gerlowskija

Had a few questions you might care to think about, but nothing necessarily negative, just curiosities.

LGTM.

gerlowskija · 2020-06-16T10:41:30Z

solr/solr-ref-guide/src/requesthandlers-and-searchcomponents-in-solrconfig.adoc

@@ -169,3 +169,15 @@ Many of the other useful components are described in sections of this Guide for
 * `TermVectorComponent`, described in the section <<the-term-vector-component.adoc#the-term-vector-component,The Term Vector Component>>.
 * `QueryElevationComponent`, described in the section <<the-query-elevation-component.adoc#the-query-elevation-component,The Query Elevation Component>>.
 * `TermsComponent`, described in the section <<the-terms-component.adoc#the-terms-component,The Terms Component>>.
+
+Other components that ship with Solr include:


I'm surprised you put these components in a separate table, rather than appending them to the existing list right above here. Any particular reason you kept this list separate from the list above?

These each have a detailed section in the Ref Guide, and in fact I was thinking of moving the Get component, which is covered in the Ref Guide up to here as well. Having said that, I'm rethinking the way the page lists the components out, and maybe taking a bigger pass through.

gerlowskija · 2020-06-16T10:47:19Z

solr/solr-ref-guide/src/requesthandlers-and-searchcomponents-in-solrconfig.adoc

+[cols="20,40,40",options="header"]
+|===
+|Component Name |Class Name |More Information
+|phrases |`solr.PhrasesIdentificationComponent` | Learn more in the {solr-javadocs}org/apache/solr/handler/component/PhrasesIdentificationComponent.html[PhrasesIdentificationComponent] java class.


I understand the desire to avoid duplication here with the Javadoc content, but it might still be nice to have a 1 sentence description, so readers don't have to click through just to figure out whether they're interested.

That said, even without that, this PR raises the visibility of these components which is a Good Thing. So I'm happy either way.

Thanks @gerlowskija.. In looking at the page a day later, I think that a table that is more in the vein of `Component Name, Class Name (?), Purpose, More Information, where More Information is some links might be the way to go. Or, dropping the Class Name as kind of an implementaiton detail that you can look up on the More Information page. Which maybe gets me back to just one big list! I'll mull some more.

Sounds good. You've clearly put more thought into it than I have, so I'll be happy with whatever you land on.

dsmiley · 2020-06-16T16:25:53Z

solr/solr-ref-guide/src/requesthandlers-and-searchcomponents-in-solrconfig.adoc

+* `ResponseLogComponent`, used to record which documents are returned to the user via the Solr log, described in the {solr-javadocs}solr-core/org/apache/solr/handler/component/ResponseLogComponent.html[ResponseLogComponent] javadocs.
+* `PhrasesIdentificationComponent`, used to identify & score "phrases" found in the input string, based on shingles in indexed fields, described in the {solr-javadocs}solr-core/org/apache/solr/handler/component/PhrasesIdentificationComponent.html[PhrasesIdentificationComponent] javadocs.
+
+Lastly, you may be interested in some other components created by the community and listed on the https://solr.cool/#searchcomponents[Solr Cool] website.


It's great to mention outside resources, though I'd like to point out that SearchComponent is merely one of many abstractions you could write a plugin for. Maybe we should mention "Solr Cool" in exactly one suitable place (about Solr plugins generally) instead of potentially many places.

I was wondering about actually linking to the specific types of plugins on the Solr Cool site?

solr-cool/solr-cool.github.io#19

I was wondering about not adding that link in this PR, and doing a separate one with links from the relevant portions of the ref guide. Or maybe we need to have one place in ref guide with "related projects" or something? I'm hopeful that solr.cool ends up being a clearing house of community created extensions to Solr of all kinds ;-)

Yeah let's separate external plugin advocacy to another issue and address that comprehensively.

Makes sense.

…it differently

* Add an example explaining how to use * fix up JavaDoc formatting * add missing SearchComponents that ship with Solr, and point to external site with components. * fix path * simplify page layout by consolidating to lists * add missing components that are documented elsewhere in refguide * try to get pathing to pass precommit * remove mention of solr.cool, in favour of a seperate PR that handles it differently

* upstream/master: (218 commits) LUCENE-9412 Do not validate jenkins HTTPS cert LUCENE-8962: add ability to selectively merge on commit (apache#1552) Replace DWPT.DocState with simple method parameters (apache#1594) LUCENE-9402: Let MultiCollector handle minCompetitiveScore (apache#1567) SOLR-14574: Fix or suppress warnings in solr/core/src/test (part 2) SOLR-14561 CoreAdminAPI's parameters instanceDir and dataDir are now validated (apache#1572) SOLR-14532: Add *.iml files to gitignore SOLR-14577: Return BAD REQUEST when field is missing in terms QP (apache#1588) SOLR-14574: Fix or suppress warnings in solr/core/src/test (part 1) remove debug code LUCENE-9408: roll back only called once enforcement LUCENE-8962: Allow waiting for all merges in a merge spec (apache#1585) SOLR-14572 document missing SearchComponents (apache#1581) LUCENE-9359: Avoid test failures when the extra file is a dir. SOLR-14573: Fix or suppress warnings in solrj/src/test LUCENE-9353: Move terms metadata to its own file. (apache#1473) Cleanup TermsHashPerField (apache#1573) SOLR-14558: Record all log lines in SolrLogPostTool (apache#1570) LUCENE-9404: simplify checksum calculation of ByteBuffersIndexOutput LUCENE-9403: tune BufferedChecksum.DEFAULT_BUFFERSIZE ...

ohtwadi and others added 10 commits June 13, 2018 15:11

Add an example explaining how to use

3eff02b

prep to fix javadocs

4203bd8

Merge branch 'patch-1' of https://github.com/ohtwadi/lucene-solr

Merge branch 'master' of http://github.com/apache/lucene-solr

0589de6

fix up JavaDoc formatting

9be75f6

Merge branch 'master' of https://github.com/apache/lucene-solr

25e8456

Merge branch 'master' of https://github.com/apache/lucene-solr

f77a336

Merge branch 'master' of https://github.com/apache/lucene-solr

8ed5b6f

Merge branch 'master' of https://github.com/apache/lucene-solr

4fa8488

add missing SearchComponents that ship with Solr, and point to extern…

681352c

…al site with components.

fix path

8f0901c

gerlowskija reviewed Jun 16, 2020

View reviewed changes

epugh added 3 commits June 16, 2020 10:35

simplify page layout by consolidating to lists

0385672

add missing components that are documented elsewhere in refguide

e77499a

try to get pathing to pass precommit

8dac2c1

dsmiley reviewed Jun 16, 2020

View reviewed changes

remove mention of solr.cool, in favour of a seperate PR that handles …

9648f28

…it differently

epugh merged commit 207efbc into apache:master Jun 17, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SOLR-14572 document missing SearchComponents #1581

SOLR-14572 document missing SearchComponents #1581

epugh commented Jun 15, 2020 •

edited

Loading

gerlowskija left a comment

gerlowskija Jun 16, 2020

epugh Jun 16, 2020

gerlowskija Jun 16, 2020

epugh Jun 16, 2020

gerlowskija Jun 16, 2020

dsmiley Jun 16, 2020

epugh Jun 16, 2020

dsmiley Jun 16, 2020

epugh Jun 17, 2020

SOLR-14572 document missing SearchComponents #1581

SOLR-14572 document missing SearchComponents #1581

Conversation

epugh commented Jun 15, 2020 • edited Loading

Description

Solution

Tests

Checklist

gerlowskija left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

epugh commented Jun 15, 2020 •

edited

Loading