docs: add manage dashboards as code how-to (#5448)#7029
Draft
florent-leborgne wants to merge 1 commit into
Draft
docs: add manage dashboards as code how-to (#5448)#7029florent-leborgne wants to merge 1 commit into
florent-leborgne wants to merge 1 commit into
Conversation
Add a how-to guide for treating dashboards as version-controlled code: export the dashboards API-compatible JSON, store it in Git, review changes in pull requests, and deploy across environments. Covers Elastic-specific concerns (managing IDs across environments, references to saved objects, inline vs library panels) and points to the Terraform provider. Add bidirectional cross-links from the building, programmatically, and sharing pages, plus a toc entry. Co-authored-by: Cursor <cursoragent@cursor.com>
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. |
Contributor
Contributor
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! 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
1 participant
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
This PR addresses #5448 by adding a how-to guide for managing dashboards as version-controlled code. Since the issue was filed, the building blocks it anticipated have landed (the Create dashboards programmatically overview, and the dashboards API-compatible JSON export on the Sharing dashboards page). What was still missing is the end-to-end workflow and the cross-environment practical concerns. This PR fills that gap with a focused, Elastic-specific how-to rather than duplicating the existing overview content.
explore-analyze/dashboards/manage-dashboards-as-code.md(new): how-to covering the export → store in Git → review in PRs → deploy workflow, plus managing IDs across environments, references to saved objects, inline vs. library panels, and a pointer to the Terraform provider. Taggedpreview 9.4+/ serverlesspreviewto match the dashboards API.explore-analyze/dashboards/building.md: adds a link to the new page from the "Once you have a dashboard, you can also" list.explore-analyze/dashboards/create-dashboards-programmatically.md: adds a prose cross-reference to the new workflow page.explore-analyze/dashboards/sharing.md: adds a cross-reference from the JSON export section.explore-analyze/toc.yml: registers the new page under Building dashboards.Resolves
Closes #5448
Notes for reviewers