Skip to content

Style improvements for API contribution guide#5398

Open
lcawl wants to merge 6 commits intoelastic:mainfrom
lcawl:api-check
Open

Style improvements for API contribution guide#5398
lcawl wants to merge 6 commits intoelastic:mainfrom
lcawl:api-check

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Mar 6, 2026

Audit https://www.elastic.co/docs/contribute-docs/api-docs against elastic docs review skills and address vale linting messages.

Summary

Here's a summary of everything that was changed based on the review skills:

High priority — errors fixed:

  • overview.md: "All Elastic API docs follows" → "follow"
  • kibana-api-docs-quickstart.md: "the the [checklist]" → "the [checklist]"
  • elasticsearch-api-docs-quickstart.md: "OpenAPIdocs" → "OpenAPI docs"

Medium priority — style and consistency:

  • organize-annotate.md: Renamed heading "Add Open API document info" → "Add OpenAPI document info" and updated the self-referencing anchor link
  • checklist.md: Updated the anchor link to match the renamed heading
  • index.md + guidelines.md: Changed "Open API" (two words) → "OpenAPI" in prose
  • help.md: Replaced "pretty complicated, and there's lots of moving parts. It takes a village" with "complex, with many interdependent components"; removed "please"; changed "API ownership table" → "API docs workflows table"; added full frontmatter block

Lower priority — enhancements:

  • All 10 files: Added description and applies_to (with empty stack:/serverless: values) to frontmatter. overview.md and guidelines.md had no frontmatter at all and received complete blocks.
  • guidelines.md + checklist.md: Clarified "5-45 characters" refers specifically to API operation summaries
  • guidelines.md: Added Kibana tab to the "Lint your API docs" section with the validate_oas_docs.js command and a link to the Kibana quickstart

The following changes were to address the feedback from the linter:

Part 1 – Latinisms

  • checklist.md: "tags etc." → "tags, and so on"
  • elasticsearch-api-docs-quickstart.md: "i.e. helpful" → "(helpful for users)"
  • organize-annotate.md: "e.g.," → "for example," (3 places), "via" → "through", "eg:" → "for example:", "etc." → "and so on"

Part 2 – DontUse

  • elasticsearch-api-docs-quickstart.md: "quite complex" → "complex", "not just errors" → "not only errors"
  • overview.md: "very basic spec" → "basic spec"

Part 3 – WordChoice

  • overview.md: "simple overview" → "basic overview", "first-class citizen" → "top-level citizen"
  • elasticsearch-api-docs-quickstart.md: "may be false alarms" → "can be false alarms"
  • kibana-api-docs-quickstart.md: "see the" → "refer to the", "may change" → "can change"
  • guidelines.md: "Use simple verbs" → "Use basic verbs", "disabled" → "turned off"

Part 4 – Wordiness

  • elasticsearch-api-docs-quickstart.md: "Some of the linter errors" → "Some linter errors"
  • organize-annotate.md: "Since we now only publish" → "Because we now only publish"

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: composer-1.5, clause-4.6-sonnet-medium

@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

Vale Linting Results

Summary: 2 warnings, 3 suggestions found

⚠️ Warnings (2)
File Line Rule Message
contribute-docs/api-docs/kibana-api-docs-quickstart.md 137 Elastic.QuotesPunctuation Place punctuation inside closing quotation marks.
contribute-docs/index.md 28 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'.
💡 Suggestions (3)
File Line Rule Message
contribute-docs/api-docs/kibana-api-docs-quickstart.md 3 Elastic.Clone Use cloning only when referring to cloning a GitHub repository or creating a copy that is linked to the original. Often confused with 'copy' and 'duplicate'.
contribute-docs/api-docs/organize-annotate.md 168 Elastic.Semicolons Use semicolons judiciously.
contribute-docs/api-docs/organize-annotate.md 342 Elastic.Semicolons Use semicolons judiciously.

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.

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.

1 participant