[feat]: Restructure public dashboard docs with get-started tutorial and split pages#23869
Open
sujitnewrelic wants to merge 11 commits intodevelopfrom
Open
[feat]: Restructure public dashboard docs with get-started tutorial and split pages#23869sujitnewrelic wants to merge 11 commits intodevelopfrom
sujitnewrelic wants to merge 11 commits intodevelopfrom
Conversation
… docs - New: get-started-sharing-dashboards-publicly.mdx — step-by-step tutorial covering Advanced Compute check, Live URL Creation policy enablement, access management, and creating a live URL (NR-528104) - New: share-dashboards-publicly.mdx — reference doc for dashboard sharing only, with redirect from old combined page URL - New: share-charts-publicly.mdx — focused reference doc for chart sharing only, with redirect from old combined page anchor - Deleted: share-charts-dashboards-externally.mdx — replaced by two split docs - Updated navigation to nest three new pages under "Share publicly" section - Updated 9 English source files to point links to new split doc paths Co-Authored-By: Claude <noreply@anthropic.com>
|
Hi @sujitnewrelic 👋 Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days. Please ensure the propsed changes look good by building it first in your local environment. Refer to this contribution guide to get the site up and running in your local. If you really require a preview url, reach out to one of the writers and they will generate one for you. |
Deleted orphaned translation files across es, fr, jp, kr, and pt locales following removal of share-charts-dashboards-externally.mdx and other upstream source file deletions. Run via yarn i18n-utility delete-orphans. Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
Author
|
netlify build |
🚀 Netlify Preview Building!If the build is successful, the preview for this pull request will be available at the following URL (usually takes 10-20 minutes): https://nr-528104-get-started-public-dashboards--docs-website-netlify.netlify.app |
Restores 47 translated files that were deleted by the delete-orphans run. i18n files should not be modified as part of this documentation update. Co-Authored-By: Claude <noreply@anthropic.com>
sujitnewrelic
added
content
Contributor
Author
|
netlify build |
Co-Authored-By: Claude <noreply@anthropic.com>
Resolve i18n rename/delete conflicts by keeping develop versions of updated release note translation files. Co-Authored-By: Claude <noreply@anthropic.com>
- Rename get-started page to overview of public sharing for both dashboards and charts; remove dashboard-only setup steps - Move access management (policy enablement, roles, group setup) inline into share-dashboards-publicly and share-charts-publicly - Replace detailed group-setup steps with reference to user-mgmt tutorial - Delete standalone prerequisites-to-share-dashboards-charts page; redirect captured in get-started page frontmatter - Remove security page from nav; update NerdGraph API doc links - All permissions-to-custom-role links updated to #configure-roles anchor Co-Authored-By: Claude <noreply@anthropic.com>
|
Re-adds the pain-point/solution scenario from the original combined doc (service disruption, real-time customer visibility) that was omitted during the restructure. Also adds the password protection context note. Co-Authored-By: Claude <noreply@anthropic.com>
Updates page title, nav entry, and all DocTile references. Co-Authored-By: Claude <noreply@anthropic.com>
…lability callout - Rename page title and nav entry to Introduction to public sharing - Replace Availability inline text with original <Callout variant="important"> covering both dashboard and chart availability in one note Co-Authored-By: Claude <noreply@anthropic.com>
Covers interactive capabilities (time range, view mode, TV mode) for both dashboards and charts in the intro page, as it applies to both. Co-Authored-By: Claude <noreply@anthropic.com>
Now covered in the Introduction to public sharing page. Co-Authored-By: Claude <noreply@anthropic.com>
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
2 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.
Key changes
get-started-sharing-dashboards-publicly.mdx— step-by-step tutorial that walks users through the complete setup flow: Advanced Compute prerequisite check → enable Live URL Creation policy (per account, via NerdGraph) → configure access management (custom role + group) → create and share a live URL. Modeled on the Kafka self-hosted doc structure using<Steps>component.share-dashboards-publicly.mdx— standalone reference doc for dashboard sharing. Splits out from the old combined doc. Includes redirect from the old URL (share-charts-dashboards-externally).share-charts-publicly.mdx— focused, simplified reference doc for chart sharing only. Includes redirect from the old#chartanchor URL.share-charts-dashboards-externally.mdx— replaced by the two split docs above.dashboards.yml): Added nested "Share publicly" section with all three new pages in order.Addresses
NR-528104 — Enhance Public Dashboards Documentation with Guided Tutorial
Test plan
yarn verify-mdxpasses (confirmed: 0 MDX errors)get-started-sharing-dashboards-publiclypage loads and<Steps>component renders correctlyshare-dashboards-publiclypage loads with all collapsers functionalshare-charts-publiclypage loads cleanlyshare-charts-dashboards-externallyredirects toshare-dashboards-publicly#chartanchor URL redirects toshare-charts-publicly🤖 Generated with Claude Code