Conversation
Vale Linting ResultsSummary: 2 warnings found
|
| File | Line | Rule | Message |
|---|---|---|---|
| docs/extend/yaml-dashboards.md | 42 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| docs/extend/yaml-dashboards.md | 136 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'vs'. |
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.
|
|
||
| ## How it works | ||
|
|
||
| A YAML dashboard file defines one or more dashboards using a structured schema. The [kb-yaml-to-lens](https://github.com/strawgate/kb-yaml-to-lens) compiler converts these YAML definitions into Kibana-compatible JSON files that are stored in the package's `kibana/dashboard/` directory. |
There was a problem hiding this comment.
Do we have any plans to move this to an elastic-owned repo? I'm a little hesitant about linking to build tools in personal repos from our public integration docs.
There was a problem hiding this comment.
The new documentation file docs/extend/yaml-dashboards.md is not included in docs/extend/toc.yml, so it won't appear in the documentation navigation. Consider adding it under the "Build a new integration" section, possibly as a sibling to create-dashboards.md (line 17) or under "Integrations guidelines" alongside dashboard-guidelines.md (line 40).
Example addition to toc.yml:
# Option 1: Under build-new-integration, after create-dashboards.md
- file: create-dashboards.md
- file: yaml-dashboards.md # Add here
# Option 2: Under integrations-guidelines, after dashboard-guidelines.md
- file: dashboard-guidelines.md
- file: yaml-dashboards.md # Add hereWhy is Claude responding? | Type @claude to interact further
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
No description provided.