Deployment types guidance for writers#6745
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Elastic Docs Style Checker (Vale)Summary: 1 warning, 1 suggestion found
|
| File | Line | Rule | Message |
|---|---|---|---|
| contribute-docs/how-to/deployment-types/strategies.md | 33 | Elastic.DontUse | Don't use 'just'. |
💡 Suggestions (1): Optional style improvements. Apply when helpful.
| File | Line | Rule | Message |
|---|---|---|---|
| contribute-docs/how-to/deployment-types/about.md | 56 | 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.
|
@yetanothertw longer term perhaps we can pull the checklist from here into an über checklist with all of the review stuff in it. just wanted to capture the patterns to watch for while they were still fresh. |
…/docs-content into deployment-types-writer-guidance
yetanothertw
left a comment
There was a problem hiding this comment.
This is so so good and very much needed info! Thank you for documenting it 🙇♀️
I've left a few minor suggestions, nothing blocking.
Co-authored-by: Vlada Chirmicci <vlada.chirmicci@elastic.co>
marciw
left a comment
There was a problem hiding this comment.
👏 👏 👏 Very nicely done! Small comments, mostly optional.
Thank you for your service to contributors and writers everywhere
Co-authored-by: Marci W <333176+marciw@users.noreply.github.com>
Summary
Pulled long-lived bits from Edu's Deployment types and our docs presentation and my detailed degree of difference brainstorm and vlada's draft review checklist to create some more prescriptive guidance on documenting deployment types.
Let AI synthesize and then edited down a lot.
For reviewers
Generative AI disclosure
Tool(s) and model(s) used: claude opus 4.6/4.7