Document the `query_scope` search index option
Mantenedores costumam responder em até 1 dia
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 18/100
- Tipo de issue
- Documentação
- Clareza
- Claramente especificada
- Status de atividade
- Estagnada
- Stack de tecnologia
- php
- Domínio
- documentation
Direção de pesquisa
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.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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.
- Linguagem predominante
- PHP
- Estrelas
- 133
- Forks
- 405
- Merge médio
- 21h 45min
- PRs com merge (30d)
- 12
Preparar o ambiente
Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de statamic/docs
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 75/100
Mantenedores costumam responder em até 1 dia
-
Chunked UploadsAberta
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 65/100
Mantenedores costumam responder em até 1 dia
-
Installation / Deployment Guides
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 40/100
Mantenedores costumam responder em até 1 dia
-
Document how conditions treat empty and null valuesTalvez já em andamento @joshdaugherty assumiu há 11 dias. Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 25/100
Mantenedores costumam responder em até 1 dia
Todas as issues de statamic/docs
Issues semelhantes
-
needs-triage Platform(Default)
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
Mantenedores costumam responder em até 1 dia
-
[Store] RstLoader detects headings inside indented code blocksTalvez já em andamento @lazerg assumiu hoje. AbertaBug Status: Needs Review Store
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
Mantenedores costumam responder em até 1 dia
-
bug repo:ckeditor
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
-
No Code Attached Yet
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
joomla/joomla-cms#48611 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
Mantenedores costumam responder em até 1 dia