Skip to content

Conversation

@colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Jan 9, 2026

Related to elastic/docs-builder#2135 and elastic/docs-builder#2322 and

Summary

  • Update existing cumulative docs contributing guidelines
  • Add examples that include ranges
  • Update get started content as needed

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

cc @florent-leborgne @vishaangelova @shainaraskas

@colleenmcginnis colleenmcginnis self-assigned this Jan 9, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 9, 2026

Vale Linting Results

Summary: 4 suggestions found

💡 Suggestions (4)
File Line Rule Message
contribute-docs/how-to/cumulative-docs/example-scenarios.md 285 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.
contribute-docs/how-to/cumulative-docs/example-scenarios.md 618 Elastic.EmDashes Don't put a space before or after a dash.
contribute-docs/how-to/cumulative-docs/example-scenarios.md 646 Elastic.Wordiness Consider using 'because' instead of 'Since'.
contribute-docs/how-to/cumulative-docs/guidelines.md 294 Elastic.Wordiness Consider using 'impossible' instead of 'not possible'.

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.

@colleenmcginnis colleenmcginnis marked this pull request as ready for review January 9, 2026 16:23
@colleenmcginnis colleenmcginnis requested review from a team as code owners January 9, 2026 16:23
Copy link
Contributor

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @colleenmcginnis, LGTM

Copy link
Collaborator

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

didn't spot anything other than what florent called out

there's some debt in how we describe "the schism" that I spotted but I don't think it needs to be addressed in this PR

shainaraskas

This comment was marked as duplicate.

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
@colleenmcginnis colleenmcginnis enabled auto-merge (squash) January 9, 2026 20:57
@colleenmcginnis colleenmcginnis merged commit a650e6d into main Jan 9, 2026
8 of 9 checks passed
@colleenmcginnis colleenmcginnis deleted the update-cumulative-docs branch January 9, 2026 20:59
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.

4 participants