Skip to content

Add style guide to Contribute to the docs #202

Add style guide to Contribute to the docs

Add style guide to Contribute to the docs #202

Triggered via pull request November 25, 2025 10:54
Status Success
Total duration 55s
Artifacts 1

vale-linting.yml

on: pull_request
Fit to window
Zoom out
Zoom in

Annotations

10 warnings and 10 notices
vale: contribute-docs/style-guide/grammar-spelling.md#L319
Elastic.BritishSpellings: Use American English spelling 'analyze' instead of British English 'analyse'.
vale: contribute-docs/style-guide/grammar-spelling.md#L318
Elastic.BritishSpellings: Use American English spelling 'authorize' instead of British English 'authorise'.
vale: contribute-docs/style-guide/grammar-spelling.md#L317
Elastic.BritishSpellings: Use American English spelling 'organize' instead of British English 'organise'.
vale: contribute-docs/style-guide/grammar-spelling.md#L303
Elastic.BritishSpellings: Use American English spelling 'visualization' instead of British English 'Visualisation'.
vale: contribute-docs/style-guide/grammar-spelling.md#L49
Elastic.Gender: Don't use 'he/she'.
vale: contribute-docs/style-guide/grammar-spelling.md#L40
Elastic.QuotesPunctuation: Put punctuation outside the quotation marks.
vale: contribute-docs/style-guide/formatting.md#L173
Elastic.EndPuntuaction: Don't end headings with punctuation
vale: contribute-docs/style-guide/accessibility.md#L218
Elastic.Latinisms: Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
vale: contribute-docs/style-guide/accessibility.md#L162
Elastic.QuotesPunctuation: Put punctuation outside the quotation marks.
vale: contribute-docs/style-guide/accessibility.md#L127
Elastic.Accessibility: Don't use language (such as 'vision-impaired') that defines people by their disability.
vale: contribute-docs/style-guide/accessibility.md#L170
Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI.
vale: contribute-docs/style-guide/accessibility.md#L162
Elastic.Negations: Consider rephrasing to avoid negative constructions like 'cannot access the content without'. Try stating what something IS rather than what it is NOT.
vale: contribute-docs/style-guide/accessibility.md#L150
Elastic.WordChoice: Consider using 'efficient' instead of 'simple', unless the term is in the UI.
vale: contribute-docs/style-guide/accessibility.md#L127
Elastic.WordChoice: Consider using 'efficient' instead of 'easy', unless the term is in the UI.
vale: contribute-docs/style-guide/accessibility.md#L94
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.
vale: contribute-docs/style-guide/accessibility.md#L91
Elastic.DeviceAgnosticism: Use device-agnostic language when possible. Use 'select' instead of 'tap'.
vale: contribute-docs/style-guide/accessibility.md#L35
Elastic.WordChoice: Consider using 'efficient' instead of 'easy', unless the term is in the UI.
vale: contribute-docs/style-guide/accessibility.md#L8
Elastic.Acronyms: 'WCAG' has no definition.
vale: contribute-docs/good-issues.md#L73
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.
vale: contribute-docs/good-issues.md#L17
Elastic.Wordiness: Consider using 'because' instead of 'since'.

Artifacts

Produced during runtime
Name Size Digest
vale-results Expired
4.13 KB
sha256:c2fc069d611c7c2a5910d64898068d0e4d8db17a7649dd3240152186a595233b