Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat(public-dashboard): Feb release-Update document for Public dashboard GA #19748

Draft
wants to merge 29 commits into
base: develop
Choose a base branch
from

Conversation

sujitnewrelic
Copy link
Contributor

  • Updated the exiting topics
  • Adding New pages

- Updated the exiting topics
- Adding New pages
@sujitnewrelic sujitnewrelic added content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers labels Jan 19, 2025
@sujitnewrelic sujitnewrelic self-assigned this Jan 19, 2025
Copy link

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.

We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes).

Copy link

netlify bot commented Jan 19, 2025

Deploy Preview for docs-website-netlify ready!

Name Link
🔨 Latest commit 380506b
🔍 Latest deploy log https://app.netlify.com/sites/docs-website-netlify/deploys/679a0738dae27f0008ea0280
😎 Deploy Preview https://deploy-preview-19748--docs-website-netlify.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).


1. Go to <DNT>**[one.newrelic.com > Dashboards](https://one.newrelic.com//dashboards)**</DNT>.
2. Open the dashboard you want to share.
3. Navigate to <DNT>**<Icon name="fe-more-horizontal"/> > Metadata**</DNT>, and copy the entity guid of the dasboard.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GUID

3. Navigate to <DNT>**<Icon name="fe-more-horizontal"/> > Metadata**</DNT>, and copy the entity guid of the dasboard.

<CollapserGroup>
<Collapser id="create-dashboard-url-nerdgraph" title="Create a live dashboard URL.">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove period at the end. Do this for all the collapsers here


<CollapserGroup>
<Collapser id="create-dashboard-url-nerdgraph" title="Create a live dashboard URL.">
To create a live dashboard URL:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is already in the heading of the collapser, why repeat?

}
```
The live dashboard URL appears in the response as follows. You can share this URL with anyone to render the dashboard publicaly.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove "as follows"
Second sentence - This is a public URL so you can share it with anyone.

<Collapser id="update-dashboard-url-nerdgraph" title="Update a live dashboard URL.">
Make sure you have the [permissions](/docs/query-your-data/explore-query-data/dashboards/prerequisites-to-share-dashboards-charts/#permissions-to-custom-role) to modify the configuration of the shared dashboard.

For example, to update the time period for the URL to be live:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove "For example"

id="check-policy-status"
title="Check status of the Live URL Creation policy status in accounts"
>
As an Authentication Domain Manager, you can check the current status of the <DNT>**Live URL Creation**</DNT> policy in specific accounts. Use the [NerdGraph API explorer](https://one.newrelic.com/nerdgraph-graphiql) to construct a [graph API call](/docs/apis/nerdgraph/get-started/nerdgraph-explorer) as following. Replace `1, 2, 3` with actual account IDs. If you don't provide the account IDs, the call returns the status of your authorized account. You can query up to 100 accounts simultaneously.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as follows

}
```
A sample response appears as following:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a sample response

}
```
A sample response appears as following. If you have provided an unknown account ID, the response will show `UNAUTHORIZED` error code.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a sample response.


## Access management [#access-management]

As an Administrator, perform the following steps to grant access to a user for [managing live dashboard and chart URLs](/docs/query-your-data/explore-query-data/dashboards/share-charts-dashboards-externally/#dashboard). Check with the user about there specific needs and accordingly do the configuration. To learn more about user management, see [User management tutorial](/docs/accounts/accounts-billing/new-relic-one-user-management/account-user-mgmt-tutorial/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not "see" "refer"


<Step>
### Add user, role, and account to a group [#group-access]
[Create a new group](/docs/accounts/accounts-billing/new-relic-one-user-management/account-user-mgmt-tutorial/#group-access) for dashboard sharing, or manage an existing group to set up as following:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as follows

<Step>
### Add user, role, and account to a group [#group-access]
[Create a new group](/docs/accounts/accounts-billing/new-relic-one-user-management/account-user-mgmt-tutorial/#group-access) for dashboard sharing, or manage an existing group to set up as following:
1. Add the user under <DNT>**Members**</DNT>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For all the steps reason, location, action.

@@ -69,6 +69,7 @@ Use dashboards to:
* Explore and contextualize data with [advanced tooltips and zoom-in functions](#key-visual-tools) to monitor what your systems are doing in real time.
* Search your dashboards for attributes and metrics.
* [Report custom data](/docs/data-apis/custom-data/get-custom-data-from-any-source/) to New Relic and your dashboards from any source.
* [Create publicly accessible live dashboard URLs](/docs/query-your-data/explore-query-data/dashboards/share-charts-dashboards-externally/#dashboard) to share insights with stakeholders outside your New Relic organization.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reason. location, action

This feature includes multiple security layers and conditions to ensure controlled and secure data sharing. To share dashboards or charts publicly, ensure the following setup is in place. Refer to the [Security and access management](/docs/query-your-data/explore-query-data/dashboards/prerequisites-to-share-dashboards-charts) for setup details:
* The `Live url control` permission is enabled for the account with the dashboard.
* The custom role and permissions are configured for you to share dashboards and charts.
* The accounts sourcing the dashboard or chart are having grants for your role to share data externally.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

chart have grants for

<TabsPageItem id="chart">

## Share your chart [#share-chart-externally]
To share a chart with external users, ensure you have completed all the setups outlined in the [Prerequisites](#prerequisites-public-dashboard). To generate a shareable link for your chart:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all the setup steps

<Callout variant="tip">You can create and manage live dashboard URLs through both the **UI** and the [NerdGraph API](/docs/apis/nerdgraph/examples/manage-live-dashboard-urls-via-api). </Callout>

<CollapserGroup>
<Collapser id="create-dashboard-url" title="Create a live dashboard URL from the UI.">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove periods from all headings in this collapser

5. Click <DNT>**Continue**</DNT>. The <DNT>**Share dashboard**</DNT> dialog appears.
6. Assign a duration for the URL to be live. The URL expires after the specified duration.
7. Click <DNT>**Save changes**</DNT>. A notification appears about the successful creation of the URL, and it is copied to your clipboard.
8. To render the shared dashboard page, click the notification, or manually browse it in a new tab with the copied URL.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

browse to it

Copy link
Contributor

@vpayyapilly vpayyapilly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix and resubmit

Editorial review comment implementation
Updated the editorial review comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants