Skip to content

Deployment types guidance for writers#6745

Open
shainaraskas wants to merge 9 commits into
mainfrom
deployment-types-writer-guidance
Open

Deployment types guidance for writers#6745
shainaraskas wants to merge 9 commits into
mainfrom
deployment-types-writer-guidance

Conversation

@shainaraskas
Copy link
Copy Markdown
Member

@shainaraskas shainaraskas commented May 27, 2026

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

  • Anything too "internal" to share here that should be removed?
  • Anything unclear/duplicative?

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: claude opus 4.6/4.7

@shainaraskas shainaraskas changed the title ai slop [DRAFT] deployment types guidance May 27, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026

Elastic Docs Style Checker (Vale)

Summary: 2 warnings, 1 suggestion found

⚠️ Warnings (2): Fix when the suggestion improves clarity or correctness.
File Line Rule Message
contribute-docs/how-to/deployment-types/strategies.md 19 Elastic.Spelling 'labelable' is a possible misspelling.
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.

@shainaraskas shainaraskas changed the title [DRAFT] deployment types guidance Deployment types guidance for writers Jun 2, 2026
@shainaraskas shainaraskas marked this pull request as ready for review June 2, 2026 20:44
@shainaraskas shainaraskas requested a review from a team as a code owner June 2, 2026 20:44
@shainaraskas shainaraskas requested a review from eedugon June 2, 2026 20:44
@shainaraskas
Copy link
Copy Markdown
Member Author

@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
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