Document the `query_scope` search index option
维护者通常 1 天内回复
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 18/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 停滞
- 技术栈
- php
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- PHP
- 星标
- 133
- 派生
- 405
- 平均合并
- 21 小时 45 分钟
- 30 天内合并 PR
- 12
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
statamic/docs 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 40/100
维护者通常 1 天内回复
-
Document how conditions treat empty and null values可能已有人在做 @joshdaugherty 于 11 天前认领。 未关闭
难度 1/5 1 小时以内 新手友好度 25/100
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 25/100
维护者通常 1 天内回复
-
Spaceless tag可能已有人在做 @marcorieser 于 86 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 15/100
维护者通常 1 天内回复
-
维护者通常 1 天内回复
相似的 Issue
-
sync-en
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
sync-en
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 4 天内回复
-
Перевод устарел
难度 1/5 1 小时以内 新手友好度 85/100
-
bug
难度 2/5 半天 新手友好度 76/100
m3ue/m3u-editor#1604 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 70/100
femiwiki/docker-mediawiki#1497 ·
维护者通常 1 天内回复