From aa2f74a6c681577493d0c5d936acb9cfd913f7dd Mon Sep 17 00:00:00 2001 From: Kristina Date: Thu, 30 Nov 2023 08:19:07 -0600 Subject: [PATCH] Navigation: More updates to the docs for admin subsections (#78857) * Add more subnav to docs * Add bold around UX text --- docs/sources/administration/correlations/_index.md | 2 +- .../add-permissions-to-create-new-correlations/index.md | 4 ++-- .../correlations/create-a-new-correlation/index.md | 4 ++-- docs/sources/administration/service-accounts/index.md | 7 ++++++- docs/sources/developers/http_api/_index.md | 2 +- .../configure-security/configure-team-sync.md | 2 +- 6 files changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/sources/administration/correlations/_index.md b/docs/sources/administration/correlations/_index.md index e6231af7a94..6a8b332c5a8 100644 --- a/docs/sources/administration/correlations/_index.md +++ b/docs/sources/administration/correlations/_index.md @@ -28,7 +28,7 @@ Explore visualizations that currently support showing links based on correlation - [Logs Panel]({{< relref "./use-correlations-in-visualizations#correlations-in-logs-panel">}}) - [Table]({{< relref "./use-correlations-in-visualizations#correlations-in-table">}}) -You can configure correlations using [provisioning]({{< relref "../provisioning" >}}), the **Administration > Correlation** page in Grafana or directly in [Explore]({{< relref "../../explore/correlations-editor-in-explore" >}}). +You can configure correlations using [provisioning]({{< relref "../provisioning" >}}), the **Administration > Plugins and data > Correlations** page in Grafana or directly in [Explore]({{< relref "../../explore/correlations-editor-in-explore" >}}). {{% admonition type="note" %}} Correlations are available in Grafana 10.0+ as an opt-in beta feature. diff --git a/docs/sources/administration/correlations/add-permissions-to-create-new-correlations/index.md b/docs/sources/administration/correlations/add-permissions-to-create-new-correlations/index.md index 6d12a779219..8dbca454cac 100644 --- a/docs/sources/administration/correlations/add-permissions-to-create-new-correlations/index.md +++ b/docs/sources/administration/correlations/add-permissions-to-create-new-correlations/index.md @@ -16,7 +16,7 @@ Adding access to create correlations for [Viewers and Editors]({{< relref "../.. ## Add permissions to create correlations -1. Go to the Administration section in Grafana. -1. Open Users page. +1. Go to the **Administration** section in Grafana. +1. Under **Users and access**, open the **Users** page. 1. Select the user to be granted access to create correlations. 1. Add _Data sources writer_ role. diff --git a/docs/sources/administration/correlations/create-a-new-correlation/index.md b/docs/sources/administration/correlations/create-a-new-correlation/index.md index 7f338723d32..225d6ca8e1c 100644 --- a/docs/sources/administration/correlations/create-a-new-correlation/index.md +++ b/docs/sources/administration/correlations/create-a-new-correlation/index.md @@ -19,8 +19,8 @@ To learn more, refer to Explore's [documentation]({{< relref "../../../explore/c ## Create a correlation in Administration page -1. Go to the Administration section in Grafana. -1. Open Correlations page. +1. Go to the **Administration** section in Grafana. +1. Under **Plugins and data**, open the **Correlations** page. 1. Click the “Add” button in the top right corner. 1. Provide a **label** for the correlation. 1. Provide an optional **description**. diff --git a/docs/sources/administration/service-accounts/index.md b/docs/sources/administration/service-accounts/index.md index 67d23b456ff..b22b4b440d2 100644 --- a/docs/sources/administration/service-accounts/index.md +++ b/docs/sources/administration/service-accounts/index.md @@ -79,8 +79,9 @@ Note that the user who created a service account will also be able to read, upda ### To create a service account 1. Sign in to Grafana and click **Administration** in the left-side menu. +1. Click **Users and access**. 1. Click **Service accounts**. -1. Click **Add service account** . +1. Click **Add service account**. 1. Enter a **Display name**. 1. The display name must be unique as it determines the ID associated with the service account. - We recommend that you use a consistent naming convention when you name service accounts. A consistent naming convention can help you scale and maintain service accounts in the future. @@ -104,6 +105,7 @@ By default, service account tokens don't have an expiration date, meaning they w ### To add a token to a service account 1. Sign in to Grafana and click **Administration** in the left-side menu. +1. Click **Users and access**. 1. Click **Service accounts**. 1. Click the service account to which you want to add a token. 1. Click **Add service account token**. @@ -131,6 +133,7 @@ Since Grafana 10.2.0, the `No Basic Role` is available for organization users or ### To assign a role to a service account 1. Sign in to Grafana and click **Administration** in the left-side menu. +1. Click **Users and access**. 1. Click **Service accounts**. 1. Click the service account to which you want to assign a role. As an alternative, find the service account in the list view. 1. Assign a role using the role picker to update. @@ -154,6 +157,7 @@ You can assign on of the following permissions to a specific user or a team: ### To update team permissions for a service account 1. Sign in to Grafana and click **Administration** in the left-side menu. +1. Click **Users and access**. 1. Click **Service accounts**. 1. Click the service account for which you want to update team permissions a role. 1. In the Permissions section at the bottom, click **Add permission**. @@ -163,6 +167,7 @@ You can assign on of the following permissions to a specific user or a team: ### To update user permissions for a service account 1. Sign in to Grafana and click **Administration** in the left-side menu. +1. Click **Users and access**. 1. Click **Service accounts**. 1. Click the service account for which you want to update team permissions a role. 1. In the Permissions section at the bottom, click **Add permission**. diff --git a/docs/sources/developers/http_api/_index.md b/docs/sources/developers/http_api/_index.md index fb7f7ad0718..e986b3f1a56 100644 --- a/docs/sources/developers/http_api/_index.md +++ b/docs/sources/developers/http_api/_index.md @@ -47,7 +47,7 @@ curl http://admin:admin@localhost:3000/api/org ### Service Account Token -To create a service account token, click on **Administration** in the left-side menu, and then **Service Accounts**. +To create a service account token, click on **Administration** in the left-side menu, click **Users and access**, then **Service Accounts**. For more information on how to use service account tokens, refer to the [Service Accounts]({{< relref "../../administration/service-accounts/" >}}) documentation. You use the token in all requests in the `Authorization` header, like this: diff --git a/docs/sources/setup-grafana/configure-security/configure-team-sync.md b/docs/sources/setup-grafana/configure-security/configure-team-sync.md index 6bab7df0bd8..f7410d14c71 100644 --- a/docs/sources/setup-grafana/configure-security/configure-team-sync.md +++ b/docs/sources/setup-grafana/configure-security/configure-team-sync.md @@ -42,7 +42,7 @@ If you have already grouped some users into a team, then you can synchronize tha {{< figure src="/static/img/docs/enterprise/team_add_external_group.png" class="docs-image--no-shadow docs-image--right" max-width= "600px" >}} -1. In Grafana, navigate to **Administration > Teams**. +1. In Grafana, navigate to **Administration > Users and access > Teams**. 1. Select a team. 1. Go to the External group sync tab, and click **Add group**. 1. Insert the value of the group you want to sync with. This becomes the Grafana `GroupID`.