docs: document template functions, docs validation, and create commands#17406
Open
mjwolf wants to merge 1 commit intoelastic:mainfrom
Open
docs: document template functions, docs validation, and create commands#17406mjwolf wants to merge 1 commit intoelastic:mainfrom
mjwolf wants to merge 1 commit intoelastic:mainfrom
Conversation
- Complete template functions section in finishing-touches.md with all 6 available functions (fields, event, inputDocs, url, generatedHeader, alertRuleTemplates) and usage examples - Add documentation structure validation section explaining how to enable docs_structure_enforced in validation.yml and skip specific sections - Update build-create-package.md with detailed wizard options for both elastic-package create package and create data-stream commands - Add cross-references between documentation-guidelines.md and finishing-touches.md for template functions and validation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
🔍 Preview links for changed docs |
Contributor
Vale Linting ResultsSummary: 2 suggestions found 💡 Suggestions (2)
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. |
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.
Proposed commit message
This updates the extend documentation to include information on some new tooling features which have been added/updated recently.
available functions (fields, event, inputDocs, url, generatedHeader,
alertRuleTemplates) and usage examples
docs_structure_enforced in validation.yml and skip specific sections
elastic-package create package and create data-stream commands
finishing-touches.md for template functions and validation
🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com
Checklist
changelog.ymlfile.