Skip to content

Commit

Permalink
Authoring in progress
Browse files Browse the repository at this point in the history
  • Loading branch information
sujitnewrelic committed Jan 22, 2025
1 parent 6cda719 commit ed5794b
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 33 deletions.
14 changes: 14 additions & 0 deletions src/content/docs/apis/nerdgraph/examples/nerdgraph-dashboards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,20 @@ Here are operations related to creating, reading, updating, and deleting (CRUD).
Revoke publicly accessible live dashboard URL.
</td>
</tr>

<tr>
<td>
`dashboardUpdateLiveUrlCreationPolicies()`
</td>

<td>
mutation
</td>

<td>
Only an Authentication Domain Manager can use this mutation to enable or disable the <DNT>**Live Url Creation**</DNT> policy for accounts. Users can create live URLs for dashboards only in accounts where this policy is enabled.
</td>
</tr>

</tbody>
</table>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ Each of the following personas has specific responsibilities in this process:
* **Authentication domain manager**: Controls the feature's enablement in account level.
* **Administrator**: Configures custom roles and permissions for users to manage live URLs.

## Feature enablement [#feature-enablement]
## Policy enablement [#policy-enablement]
For sharing dashboards publicly, the Authentication domain manager needs to check and enable the <DNT>**Live Url Creation**</DNT> policy at the account level. This is not applicable to chart sharing. The Authentication domain manager can check the status of this policy in accounts, and enable or disable it only via NerdGraph API.

Check failure on line 25 in src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx#L25

[Microsoft.Contractions] Use 'isn't' instead of 'is not'.
Raw output
{"message": "[Microsoft.Contractions] Use 'isn't' instead of 'is not'.", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx", "range": {"start": {"line": 25, "column": 165}}}, "severity": "ERROR"}

<CollapserGroup>
<Collapser
id="check-policy-status"
title="Check status of the <DNT>**Live Url Creation**</DNT> policy in accounts"
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.

Check notice on line 32 in src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx#L32

[new-relic.ComplexWords] Consider using 'give' or 'offer' instead of 'provide'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'give' or 'offer' instead of 'provide'.", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx", "range": {"start": {"line": 32, "column": 377}}}, "severity": "INFO"}

Expand Down Expand Up @@ -78,7 +78,7 @@ For sharing dashboards publicly, the Authentication domain manager needs to chec

<Collapser
id="enable-disable-policy"
title="Enable or disable the <DNT>**Live Url Creation**</DNT> policy in accounts"
title="Enable or disable the Live Url Creation policy in accounts"
>
As an Authentication Domain Manager, you can enable or disable the <DNT>**Live Url Creation**</DNT> policy in specific accounts. Ensure you have authorization for these 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 given here with the following changes:
* Replace `1, 2, 3` with actual account IDs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,9 @@ Click a dashboard to open its charts. A dashboard page includes these features:
id="dash-share"
title="Share your dashboard"
>
You can [share your dashboard with your internal team](/docs/query-your-data/explore-query-data/dashboards/share-dashboard-internally) via a permalink. To share the dashboard with viewers outside your New Relic organization, you need to create publicly accessible live dashboard URLs and share them. This can be done using both the [UI](/docs/query-your-data/explore-query-data/dashboards/share-charts-dashbords-externally) and [NerdGraph](/docs/apis/nerdgraph/examples/manage-live-dashboard-urls-via-api). When sharing the dashboard externally, you can set an expiration date for the shared dashboard URL.
You can [share your dashboard with your internal team](/docs/query-your-data/explore-query-data/dashboards/share-charts-dashboards-internally) via a permalink. To share the dashboard with viewers outside your New Relic organization, you need to create publicly accessible live dashboard URLs and share them. This can be done using both the [UI](/docs/query-your-data/explore-query-data/dashboards/share-charts-dashbords-externally) and [NerdGraph](/docs/apis/nerdgraph/examples/manage-live-dashboard-urls-via-api). When sharing the dashboard externally, you can set a time period for the shared dashboard URL to remain live.

<Callout variant="caution"> Anyone with the live dashboard URL can view all the information from the dashboard. Share information carefully and in accordance with your company's internal policies and procedures.</Callout>
<Callout variant="caution"> Anyone with a live dashboard URL for an externally shared dashboard can view all the information on that dashboard. Share information carefully, adhering to your company's internal policies and procedures.</Callout>

</Collapser>

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Share dashboards and charts internally
tags:
- Share dashboards internally
- Share charts internally
- Internal sharing
- Dashboards
- Charts
metaDescription: 'Share dashboards and charts within the team.'
redirects:
freshnessValidatedDate: 2025-01-16
---

## Share your dashboards internally [#share-dashboards-internally]

You can share any dashboard within your team using any of the following options:

* Copy the dashboard's permalink by clicking the link icon in the top right of a dashboard. Permalinks share a direct link to the dashboard.


Or


* Copy your dashboard in <DNT>** JSON**</DNT> format as follows, and share it within your team.
1. Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Dashboards**</DNT>.
2. Click the <Icon name="fe-more-horizontal"/> icon in the top right corner of the dashboard.
3. Select <DNT>**Copy JSON to clipboard**</DNT>.
4. Paste the JSON code into a message or document to share it with your team.


## Share your charts internally [#share-charts-internally]
Similar to dashboards, you can share charts within your team by following these steps:

1. Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Dashboards**</DNT>.
2. Open the dashboard that contains the chart you want to share.

Check notice on line 35 in src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashboards-internally.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashboards-internally.mdx#L35

[new-relic.ComplexWords] Consider using 'has' instead of 'contains'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'has' instead of 'contains'.", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashboards-internally.mdx", "range": {"start": {"line": 35, "column": 28}}}, "severity": "INFO"}
3. Select <DNT>**View query**</DNT> from the <Icon name="fe-more-horizontal"/> menu of the chart. The query opens in the Query builder.
4. From the Query builder, click <DNT>**Copy query link**</DNT>. The link is copied to your clipboard.

Check notice on line 37 in src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashboards-internally.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashboards-internally.mdx#L37

[Microsoft.Passive] 'is copied' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'is copied' looks like passive voice.", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashboards-internally.mdx", "range": {"start": {"line": 37, "column": 75}}}, "severity": "INFO"}
5. Share it with your team member via email, chat, or any other communication tool.


This file was deleted.

2 changes: 1 addition & 1 deletion src/nav/dashboards.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ pages:
- title: Share dashboards and charts
pages:
- title: Share internally
path: /docs/query-your-data/explore-query-data/dashboards/share-dashboard-internally
path: /docs/query-your-data/explore-query-data/dashboards/share-charts-dashboards-internally
- title: Share externally
path: /docs/query-your-data/explore-query-data/dashboards/share-charts-dashbords-externally
- title: Security and access management for external sharing
Expand Down

0 comments on commit ed5794b

Please sign in to comment.