How-to guides
Find practical guides for common documentation tasks.
Learn how to write good issues for documentation.
Learn how to update Integrations documentation, which follows a different workflow than other Elastic documentation.
This content is still in development. If you have questions about how to write cumulative documentation while contributing, reach out to @elastic/docs in the related GitHub issue or PR.
Learn about the cumulative documentation model and how to tag content for different versions and deployments.
- Write cumulative documentation - Overview and when to tag content
- Guidelines - Detailed tagging guidance
- Badge placement - Where to place applies_to tags
- Example scenarios - Common contribution scenarios
- Reference - Complete applies_to syntax reference
We document all deployment types together in a single source of truth where possible. These resources help you work within the cumulative docs model when content varies by deployment, including tips to recognize when content is deployment-sensitive, and guidance on how to shape content based on how it varies.
- Document deployment types in Elastic Docs - Overview and how the resources fit together
- Deployment types reference for docs contributors - The deployment types, stack components and flavors available on each, and where user-facing tasks differ
- Strategies for documenting across deployment types - Editorial approaches, IA placement, and review symptoms