Skip to content

docs: document template functions, docs validation, and create commands#17406

Open
mjwolf wants to merge 1 commit intoelastic:mainfrom
mjwolf:update-extend-docs
Open

docs: document template functions, docs validation, and create commands#17406
mjwolf wants to merge 1 commit intoelastic:mainfrom
mjwolf:update-extend-docs

Conversation

@mjwolf
Copy link
Contributor

@mjwolf mjwolf commented Feb 13, 2026

Proposed commit message

This updates the extend documentation to include information on some new tooling features which have been added/updated recently.

  • 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

Co-Authored-By: Claude noreply@anthropic.com

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

- 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>
@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

Vale Linting Results

Summary: 2 suggestions found

💡 Suggestions (2)
File Line Rule Message
docs/extend/build-create-package.md 51 Elastic.WordChoice Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI.
docs/extend/finishing-touches.md 164 Elastic.WordChoice Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI.

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.

@andrewkroh andrewkroh added the documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. label Feb 13, 2026
Copy link
Contributor

@kgeller kgeller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These look great!

Copy link
Collaborator

@mrodm mrodm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants