Improvements for the Index basics overview page#5279
Draft
yetanothertw wants to merge 4 commits intomainfrom
Draft
Improvements for the Index basics overview page#5279yetanothertw wants to merge 4 commits intomainfrom
yetanothertw wants to merge 4 commits intomainfrom
Conversation
Contributor
Vale Linting ResultsSummary: 1 warning, 6 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| solutions/observability/apm/explore-data-in-elasticsearch.md | 21 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
💡 Suggestions (6)
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/monitor/orchestrators/ece-monitoring-ece-set-retention.md | 48 | Elastic.Clone | Use Clone only when referring to cloning a GitHub repository or creating a copy that is linked to the original. Often confused with 'copy' and 'duplicate'. |
| explore-analyze/alerts-cases/watcher/watcher-ui.md | 40 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'See', unless the term is in the UI. |
| manage-data/data-store.md | 16 | Elastic.Versions | Use 'and later' instead of 'and higher' when referring to versions. |
| manage-data/data-store/index-management.md | 269 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
| manage-data/data-store/templates/index-template-management.md | 15 | Elastic.Wordiness | Consider using 'all' instead of 'all of '. |
| manage-data/ingest/transform-enrich/set-up-an-enrich-processor.md | 64 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
Contributor
kilfoyle
reviewed
Mar 3, 2026
| * To show details click the policy name. | ||
| * To perform operations, click the policy name or use the buttons in the **Actions** column. | ||
| * To create new policies, use the **Create enrich policy** wizard. | ||
| * **Naming and aliases**: Use clear index naming patterns and [aliases](/manage-data/data-store/aliases.md) to simplify query targets and support index changes with minimal disruption. |
Contributor
There was a problem hiding this comment.
Suggested change
| * **Naming and aliases**: Use clear index naming patterns and [aliases](/manage-data/data-store/aliases.md) to simplify query targets and support index changes with minimal disruption. | |
| * **Naming and aliases**: Use clear naming patterns for your indices and [aliases](/manage-data/data-store/aliases.md) to simplify query targets and support index changes with minimal disruption. |
Otherwise, I think it could be interpreted that one should use both i) clear index naming patterns, and ii) aliases. Whereas I think the intention is that they both be named intuitively.
kilfoyle
reviewed
Mar 3, 2026
| * **Index or data stream**: Use a regular index when you need frequent updates or deletes. Use a [data stream](/manage-data/data-store/data-streams.md) for append-only timestamped data such as logs, events, and metrics. | ||
|
|
||
| You must execute a new enrich policy before you can use it with an enrich processor or {{esql}} query. When executed, an enrich policy uses enrich data from the policy's source indices to create a streamlined system index called the enrich index. The policy uses this index to match and enrich incoming documents. | ||
| ## Next steps |
Contributor
There was a problem hiding this comment.
"Next steps" to me suggests that the previous part of the doc had a series of steps, but it's mostly conceptual rather than task. I'm not sure what to suggest though. Maybe "Start working with indices", "Learn more", "What's next?". It's also okay as is. :-)
kilfoyle
reviewed
Mar 3, 2026
| @@ -0,0 +1,275 @@ | |||
| --- | |||
Contributor
There was a problem hiding this comment.
I like the idea of breaking this management content off into a separate page. 👍
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #5221
Problem statement
At present the Index basics page includes a collection of content types. It performs the following tasks:
Another problematic page is the parent Data store overview page that needs to be edited in tandem as it should be providing more wayfinding guidance for the other related topics in this section (templates, mappings, aliases, data streams, and so on).
Changes
WIP
Generative AI disclosure
Used Claude 4.6 Opus High to check and update links