initial search configuration documentation #1050
Conversation
|
Looks like I jumped the gun on the second commit. Let me know when you are done with your review, @librarychik, and I'll do the rest of the fixes then. |
docs/user-documentation/searching.md
Outdated
|
|
||
| Some fields, such as the 'Body' ('body') field provided by Drupal, have multiple subfields which can be completely different values or variations on the same value. Click on the plus-sign next to the field to show the available subfields. In most cases repository managers can click the 'Add' button by the field and ignore the subfields as it will index the field as it is rendered to users. Only select the subfields if you understand the field's type, the value returned by the subfield, and how it will impact user searching. Similar to the complex fields, entity reference fields, such as Tags ('field_tags'), allow you to select fields from the referenced entity to index. | ||
|
|
||
| Once the fields are added they can be configured further on the 'Fields' tab, although the label, machine name, and type usually don't need to be changed. The 'Type' setting has several different types of Full-text processing available, which may be of interest. Each is described in the expandable 'Data Types' box at the bottom of the page. The 'Boost' setting allows repository managers to increase the weight of particular fields when calculating search relevancy. |
There was a problem hiding this comment.
Change: The 'Type' dropdown has several different options of Full-text processing available which may be of interest.
There was a problem hiding this comment.
It would be positive to speak about field properties and not subfields. There is not such a think of a subfield in drupal 8. Fields can have many properties, some exposed and indexable other not (search api limitations) and even the default, visible and renderable value is a property, the a default one (->value).
There was a problem hiding this comment.
@DiegoPino, right. I was using my internal conceptualization of Fields (when I was trying to figure out how they worked) rather than the Drupal terminology. I'll fix it.
There was a problem hiding this comment.
@DiegoPino, I've updated this part. Let me know what you think.
There was a problem hiding this comment.
This passes my scrutiny. @DiegoPino, feel free to merge once you're good with this.
|
@DiegoPino and @dannylamb are we good on this? |
|
This reads good and is approved by danny. |
docs/user-documentation/searching.md
Outdated
| - 'Datasource' indicates what types of entities are being indexed and how many have. | ||
| - 'Tracker' states which item tracker is being used. | ||
| - 'Server' provides a link to the SOLR server's configuration page. | ||
| - 'Server index status' is a count of the total number of items returned from an unfiltered empty search. Generally speaking, this should match the total number of items indexed. See the [Drupal 7 Search API FAQ](https://www.drupal.org/node/2009804#server-index-status) for more details. |
There was a problem hiding this comment.
Should the link say Drupal 8 search api FAQ? Or is that the old documentation?
There was a problem hiding this comment.
Yes, that link was for the Drupal 7 Search API (which is were I found out about it); but I see that this FAQ was pulled over into the Drupal 8 documentation, so I will update the link.
|
I reads good. I added a question. If that Drupal 7 link is Ok i can merge asap. Thanks for addressing my concerns |
|
@seth-shaw-unlv thanks, do you want me to squash or preserve the commits? |
|
@DiegoPino squash away. |
|
Thanks for giving it another look and merging @DiegoPino ❤️ |
GitHub Issue: #1040
This PR is part of the March 2019 documentation sprint, and includes work on the user docs for 'Set Up and Configure Searching' as outlined at https://docs.google.com/spreadsheets/d/1wI_K5Y0XJSIBXoJ84VxObcy8TT07TuypIE_P3C0rnzU/edit#gid=0.
Interested parties
@Islandora-CLAW/committers