Style improvements for API contribution guide#5398
Open
lcawl wants to merge 6 commits intoelastic:mainfrom
Open
Style improvements for API contribution guide#5398lcawl wants to merge 6 commits intoelastic:mainfrom
lcawl wants to merge 6 commits intoelastic:mainfrom
Conversation
Contributor
Vale Linting ResultsSummary: 2 warnings, 3 suggestions found
|
| 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.
Contributor
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
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.
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 linkchecklist.md: Updated the anchor link to match the renamed headingindex.md+guidelines.md: Changed "Open API" (two words) → "OpenAPI" in prosehelp.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 blockLower priority — enhancements:
descriptionandapplies_to(with emptystack:/serverless:values) to frontmatter.overview.mdandguidelines.mdhad no frontmatter at all and received complete blocks.guidelines.md+checklist.md: Clarified "5-45 characters" refers specifically to API operation summariesguidelines.md: Added Kibana tab to the "Lint your API docs" section with thevalidate_oas_docs.jscommand and a link to the Kibana quickstartThe 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
Tool(s) and model(s) used: composer-1.5, clause-4.6-sonnet-medium