Document the `query_scope` search index option
Les mainteneurs répondent en général sous 1 jour
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 18/100
- Type d'issue
- Documentation
- Clarté
- Clairement spécifiée
- Activité
- À l'abandon
- Stack technique
- php
- Domaine
- documentation
Piste de recherche
The work is the Search page of the docs repo, plus the 5 to 6 upgrade guide's mention of query scopes. The behaviour to describe is in Statamic\Search\Searchables\Provider::applyQueryScope() in the CMS source on 6.x. Pull request #1998 is already open against this issue, so review it before starting; a newcomer's contribution would be a review comment, not a second PR.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
The query_scope option for search indexes, added in statamic/cms#13126 (6.0), isn't documented on the Search page. The page covers filter, and the 5 to 6 upgrade guide already recommends query scopes over filtering for custom searchables, but it doesn't say how to set one on an index.
From Statamic\Search\Searchables\Provider::applyQueryScope() and the built-in searchables on 6.x, these are worth covering:
- The value is a scope handle. The scope is applied to the query before any items are loaded, which is why it's faster than
filteron large indexes. - Unlike
filter, it doesn't override the native filters, so draft entries are still left out of the index. - The entries, terms and users searchables apply it. The assets searchable doesn't.
I'll open a PR for this.
- Langage dominant
- PHP
- Étoiles
- 133
- Forks
- 405
- Merge moyen
- 21 h 45 min
- PR mergées (30 j)
- 12
Préparer son environnement
Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de statamic/docs
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 75/100
Les mainteneurs répondent en général sous 1 jour
-
Chunked UploadsOuverte
Difficulté 1/5 1-3 heures Accessibilité débutants 65/100
Les mainteneurs répondent en général sous 1 jour
-
Installation / Deployment Guides
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 3/5 1-2 jours Accessibilité débutants 40/100
Les mainteneurs répondent en général sous 1 jour
-
Document how conditions treat empty and null valuesPeut-être pris @joshdaugherty l’a pris il y a 11 jours. Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 25/100
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de statamic/docs
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
Les mainteneurs répondent en général sous 2 jours
-
b:1.9 t:enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
Les mainteneurs répondent en général sous 3 jours
-
backend bug
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100