docs: document Markdown panel library save and reuse (#5695)#6087
Draft
florent-leborgne wants to merge 1 commit intomainfrom
Draft
docs: document Markdown panel library save and reuse (#5695)#6087florent-leborgne wants to merge 1 commit intomainfrom
florent-leborgne wants to merge 1 commit intomainfrom
Conversation
Made-with: Cursor
Contributor
🔍 Preview links for changed docs |
Contributor
✅ Vale Linting ResultsNo 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
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 #5695 with the following changes:
explore-analyze/visualize/text-panels.md: adds a newSave and reuse Markdown panels across dashboardssection, scoped tostack: ga 9.4andserverless: ga, with subsections for saving a Markdown panel to the Visualize Library, adding a saved Markdown panel from the library, and unlinking one from the library. Also wraps the existing creation steps under a newCreate a Markdown panelH2 and adds a tagged sentence to the intro that points to the new section so the new capability is discoverable from the page lead.explore-analyze/visualize.md: extends theMarkdown textrow in the panels and visualizations table with a tagged sentence noting that Markdown panels can now be saved to the Visualize Library to reuse across dashboards.Out of scope (intentionally not documented)
The issue also mentions the new Markdown REST API (
POST /api/markdown/{id?},GET /api/markdown/{id},PUT /api/markdown/{id},DELETE /api/markdown/{id},GET /api/markdown) introduced by elastic/kibana#251975.Verifying against the source, the routes use
commonRouteConfigfromsrc/platform/plugins/shared/dashboard_markdown/server/api/constants.ts, which setsaccess: 'internal'with the comment"This route is in development and not yet intended for public use."and the description"This functionality is in technical preview and may be changed or removed in a future release.". The endpoints are also gated behind an?apiVersion=1query parameter (seeenableQueryVersion: true).Given the API is explicitly internal and in technical preview, I have not added any user-facing API reference content for it. We can revisit this once the routes are promoted to a public, stable version.
Resolves
Closes #5695