-
Notifications
You must be signed in to change notification settings - Fork 197
Document dimensions for applies_to tags #4819
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
shainaraskas
wants to merge
3
commits into
main
Choose a base branch
from
dimensions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
+159
−62
Conversation
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
Contributor
Vale Linting ResultsSummary: 4 warnings, 4 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| contribute-docs/_snippets/dimensions.md | 7 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
| contribute-docs/how-to/cumulative-docs/example-scenarios.md | 39 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'vs'. |
| contribute-docs/how-to/cumulative-docs/guidelines.md | 66 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
| contribute-docs/how-to/cumulative-docs/reference.md | 24 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
💡 Suggestions (4)
| File | Line | Rule | Message |
|---|---|---|---|
| contribute-docs/how-to/cumulative-docs/example-scenarios.md | 20 | Elastic.WordChoice | Consider using 'efficient, basic' instead of 'simple', unless the term is in the UI. |
| contribute-docs/how-to/cumulative-docs/example-scenarios.md | 22 | Elastic.WordChoice | Consider using 'efficient, basic' instead of 'simple', unless the term is in the UI. |
| contribute-docs/how-to/cumulative-docs/example-scenarios.md | 22 | Elastic.WordChoice | Consider using 'efficient, basic' instead of 'simple', unless the term is in the UI. |
| contribute-docs/how-to/cumulative-docs/example-scenarios.md | 433 | Elastic.Wordiness | Consider using 'because' instead of 'Since'. |
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
shainaraskas
commented
Jan 26, 2026
Collaborator
Author
|
will do a little cleanup of the gpt slop let slip by ( |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
part of #4117
Updates cumulative documentation guidance to clarify that pages should use only one dimension per page in
applies_tofrontmatter.Also: reorganizes example scenarios by documentation maturity so they're less overwhelming
todo: docs-builder changes elastic/docs-builder#2567
Generative AI disclosure
Tool(s) and model(s) used: Cursor