Automattic / Automattic/jetpack

Search: clean up, clarify, and document all document fields

Open
#16,904 1 comment 0 reactions 0 assignees View on GitHub
[Feature] Search [Status] Search Index Change Docs
Dominant language
PHP
Stars
1.8k
Forks
898
Avg merge
1d 18h
Merged PRs (30d)
774

Description

We have a lot of fields in the search index. Not all of them are necessarily useful and not all of them are the best way to use Elasticsearch. We should clean them all up, and then document them on: https://jetpack.com/support/search/advanced-search-document-fields/

A lot of these are documented [here](https://developer.wordpress.com/elasticsearch-post-doc-schema-v2/), but especially because of Gutenberg I am not certain that we should keep all of them. Also, fields that we decide not to document should probably get removed from the index.

Fields that exist but are not documented:
- the "deprecated" url fields
- location
- langs field (probability of each language)
- all of the content extraction stuff: https://developer.wordpress.com/elasticsearch-post-doc-schema-v2/#es-mapping-post-content-extracted

Contributor guide

Open the contributing guide

Research direction

Start by comparing the existing Elasticsearch post document schema with the Advanced Search Document Fields page and the listed undocumented fields, including deprecated URL fields, location, langs, and content extraction. Determine which fields should remain indexed and which should be documented or removed. Done means the index fields and public documentation are aligned, with decisions covering Gutenberg-related fields.

Written by the indexing model from the issue text.

Assessment

Tech stack
elasticsearch
Domain
documentation, search
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.