[Docs][Dashboards] Add 'Create programmatically' overview page#5927
Merged
florent-leborgne merged 29 commits intomainfrom May 5, 2026
Merged
[Docs][Dashboards] Add 'Create programmatically' overview page#5927florent-leborgne merged 29 commits intomainfrom
florent-leborgne merged 29 commits intomainfrom
Conversation
Contributor
🔍 Preview links for changed docs |
Contributor
Vale Linting ResultsSummary: 1 warning found
|
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/dashboards/create-dashboard.md | 19 | Elastic.QuotesPunctuation | Place punctuation inside closing quotation marks. |
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.
Member
FYI renaming that to |
5 tasks
leemthompo
reviewed
Apr 16, 2026
This was referenced Apr 16, 2026
Adds a new overview page to help users choose between the Dashboards API, Lens Visualizations API, Agent Builder chat, and the Kibana dashboards agent skill when creating dashboards outside the UI. Replaces the link-farm approach with a decision table and substantive per-option guidance including use cases, output types, and key limitations. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
- Remove 'Lens' branding throughout; use 'Visualizations API' and 'visualizations' - Fix em dashes: use commas or new sentences instead - Remove 'currently', 'straightforward', 'out of the box', 'choose to save' - Fix ambiguous pronoun antecedent in agent skill section - Fix 'without touching the UI' → 'produce dashboards from natural language instructions' - Fix in-memory sentence structure (em dash → two sentences) Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
- Fix two broken internal links: /explore-analyze/query-your-data-with-esql.md
→ /explore-analyze/query-filter/languages/esql-kibana.md
- Replace bare 'Kibana' with {{product.kibana}} substitution (Vale warning)
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
… fix applies_to syntax - Rename create-programmatically.md → create-dashboards-programmatically.md for a clearer URL - Update page anchor, toc.yml, and building.md link accordingly - Fix applies_to syntax: preview 9.4 → preview 9.4+ (explicit "and later" form) Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
building.md: - Remove standalone 'Create programmatically' section; replace with a single inline sentence pointing to the new page — the page now leads naturally to both UI and programmatic paths without the section feeling bolted on create-dashboards-programmatically.md: - Rewrite intro: lead with benefit, not "this is useful when..." - Table: rename columns to 'When to choose this' / 'What you get'; tighten row descriptions from the user's perspective; clarify agent skill output; add MCP server to Agent Builder row - Prose: active voice throughout; remove padding; fold in MCP server mention for Agent Builder; cleaner Visualizations API section intro Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
- Two 'via' → 'using' (Elastic.Latinisms rule)
- Two bare 'Kibana' → '{{product.kibana}}' substitution (table row + section heading)
- Remove 'chatbot' (Elastic.Spelling flag) — simplified to 'AI application'
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
…n skill - Fix remaining 'via' → 'using' in Agent Builder section (Vale Latinisms) - Add note about elasticsearch-esql skill as a companion to kibana-dashboards for agents that need schema discovery and ES|QL query generation Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
florent-leborgne
force-pushed
the
dashboards-create-programmatically
branch
from
92ce310 to
f40d67f
Compare
leemthompo
reviewed
Apr 16, 2026
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
leemthompo
approved these changes
Apr 16, 2026
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
- building.md: add 3-path decision table (UI / programmatic / AI); type: overview - create-dashboard.md: rename to 'Create a dashboard from the UI'; add navigation_title, type: how-to; replace agent-skill callout with a 9.4+/serverless tip linking to the two new creation paths - create-dashboards-programmatically.md: scope to APIs only (Dashboards API + Visualizations API); move AI content to new page; add navigation_title - create-dashboards-using-ai.md: new overview page for Agent Builder and the Kibana dashboards agent skill (content split from programmatic page) - toc.yml: add create-dashboards-using-ai.md under building.md Made-with: Cursor
Made-with: Cursor
Member
Author
|
@leemthompo thx for your earlier reviews - I updated the structure after chatting with Teresa - so feel free to take another look |
leemthompo
approved these changes
Apr 20, 2026
Member
leemthompo
left a comment
leemthompo
left a comment
There was a problem hiding this comment.
IA refactor makes sense! Looks even better to me.
…cs host Made-with: Cursor
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
… dashboards-api-spec
This was referenced May 6, 2026
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
3 participants
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.
Summary
Restructures the dashboard creation docs into three focused pages under a unified Building dashboards section landing.
Before: A single "Create programmatically" page covering APIs and AI tools together, with no overview linking all creation paths.
After:
building.md— Section landing with a 3-path decision table (UI / programmatic / AI), helping users choose the right approach before they dive in. Each row links to a dedicated page.create-dashboard.md— Renamed to "Create a dashboard from the UI". Adds `navigation_title: Create from the UI` for a shorter nav label, `type: how-to`, and a 9.4+/serverless tip surfacing the two new paths for users who land here out of habit.create-dashboards-programmatically.md— Scoped to REST APIs only (Dashboards API + Visualizations API). AI content moved to the new page. Adds `navigation_title: Create programmatically`.create-dashboards-using-ai.md— New overview page for Agent Builder (chat UI, Chat API, MCP server) and the Kibana dashboards agent skill. Adds `navigation_title: Create using AI`.toc.yml— Adds the new AI page under `building.md`.Design rationale
Each page now matches a single user intent: UI builders, API/DevOps engineers, and AI tool builders each land on content written for them. The decision table in `building.md` serves explorers who aren't sure which path to take. Cross-references between pages are symmetric: each child page tips to the other path.
Files changed
Test plan