Skip to content

Conversation

@shainaraskas
Copy link
Collaborator

@shainaraskas shainaraskas commented Jan 26, 2026

Summary

part of #4117

Updates cumulative documentation guidance to clarify that pages should use only one dimension per page in applies_to frontmatter.

Also: reorganizes example scenarios by documentation maturity so they're less overwhelming

  • Added Dimensions section to the guidelines page with a table explaining Stack/Serverless, Deployment, and Product dimensions
    • Added dimension usage tips for choosing a primary dimension and handling secondary dimension information
  • Added an example to the scenarios page and an xref from the badge placement page

todo: docs-builder changes elastic/docs-builder#2567

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).

Tool(s) and model(s) used: Cursor

@github-actions
Copy link
Contributor

github-actions bot commented Jan 26, 2026

Vale Linting Results

Summary: 4 warnings, 4 suggestions found

⚠️ Warnings (4)
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.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 26, 2026

@shainaraskas
Copy link
Collaborator Author

will do a little cleanup of the gpt slop let slip by (etc, simple ...)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants