public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: nav updates for user, role, team management (#64965)

Browse Source 
* text nav updates

* navigation related updates

* used Connections instead of Administration workflow for add data source steps

* wording edit

* updated data source permissions section

* Apply suggestions from code review and wording edit

* empty commit to trigger linting

* change to trigger linting
This commit is contained in:
Isabel
2023-03-21 10:45:50 -07:00
committed by GitHub
parent cc7e5ce62e
commit 0efa8c5ce1
6 changed files with 72 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/administration/user-management/manage-dashboard-permissions/index.md
+12 -15
View File
@@ -24,15 +24,12 @@ When you grant user permissions for folders, that setting applies to all dashboa
**To grant dashboard folder permissions**:
1. Sign in to Grafana as an organization administrator.
2. In the sidebar, hover your mouse over the **Dashboards** (squares) icon and click **Browse**.
3. Hover your mouse cursor over a folder and click **Go to folder**.
4. Click the **Permissions** tab, and then click **Add Permission**.
5. In the **Add Permission For** dropdown menu, select **User**, **Team**, or one of the role options.
6. Select the user or team.
If you select a role option, you do not select a user or team.
7. Select the permission and click **Save**.
1. In the left-side menu, click **Dashboards**.
1. Hover your mouse cursor over a folder and click **Go to folder**.
1. Click the **Permissions** tab, and then click **Add a permission**.
1. In the **Add Permission For** dropdown menu, select **User**, **Team**, or **Role**.
1. Select the user, team, or role.
1. Select the permission and click **Save**.
## Grant dashboard permissions
@@ -52,12 +49,12 @@ Grant dashboard permissions when you want to restrict or enhance dashboard acces
**To grant dashboard permissions**:
1. Sign in to Grafana as an organization administrator.
1. In the sidebar, hover your mouse over the **Dashboards** (squares) icon and click **Browse**.
1. In the left-side menu, click **Dashboards**.
1. Open a dashboard.
1. In the top right corner of the dashboard, click **Dashboard settings** (the cog icon).
1. Click **Permissions** and then click **Add Permission**.
1. In the **Add Permission For** dropdown menu, select **User** or **Team**.
1. Select the user or team.
1. Click **Permissions** in left-side menu, and then **Add a permission**.
1. In the **Add Permission For** dropdown menu, select **User**, **Team**, or **Role**.
1. Select the user, team, or role.
1. Select the permission and click **Save**.
## Enable viewers to edit (but not save) dashboards and use Explore
@@ -94,10 +91,10 @@ Edit dashboard permissions when you are want to enhance or restrict a user's acc
**To edit dashboard permissions**:
1. Sign in to Grafana as an organization administrator.
1. In the sidebar, hover your mouse over the **Dashboards** (squares) icon and click **Browse**.
1. In the left-side menu, click **Dashboards**.
1. Open a dashboard.
1. In the top-right corner of the dashboard, click **Dashboard settings** (the cog icon).
1. Click **Permissions**.
1. Click **Permissions** in left-side menu.
1. In the dropdown, update the permissions, and click **Save**.
## Restrict access to dashboards
docs/sources/administration/user-management/manage-org-users/index.md
+5 -5
View File
@@ -30,7 +30,7 @@ You can see a list of users with accounts in your Grafana organization. If neces
**To view a list of organization users**:
1. Sign in to Grafana as an organization administrator.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Users**.
1. Navigate to **Administration > Users**.
> **Note:** If you have [server administrator]({{< relref "../../roles-and-permissions/#grafana-server-administrators" >}}) permissions, you can also [view a global list of users]({{< relref "../server-user-management#view-a-list-of-users" >}}) in the Server Admin section of Grafana.
@@ -45,7 +45,7 @@ Update user permissions when you want to enhance or restrict a user's access to
**To change the organization role of a user**:
1. Sign in to Grafana as an organization administrator.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Users**.
1. Navigate to **Administration > Users**.
1. Find the user account for which you want to change the role.
If necessary, use the search field to filter the list.
@@ -78,7 +78,7 @@ When you invite users to join an organization, you assign the **Admin**, **Edito
> **Note**: It might be that you are currently in the proper organization and don't need to switch organizations.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Users**.
1. Navigate to **Administration > Users**.
1. Click **Invite**.
1. Enter the following information:
@@ -106,7 +106,7 @@ Periodically review invitations you have sent so that you can see a list of user
**To manage a pending invitation**:
1. Sign in to Grafana as an organization administrator.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Users**.
1. Navigate to **Administration > Users**.
1. Click **Pending Invites**.
The **Pending Invites** button appears only when there are unaccepted invitations.
@@ -128,7 +128,7 @@ This action does not remove the user account from the Grafana server.
**To remove a user from an organization**:
1. Sign in to Grafana as an organization administrator.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Users**.
1. Navigate to **Administration > Users**.
1. Find the user account that you want to remove from the organization.
Use the search field to filter the list, if necessary.
docs/sources/administration/user-management/user-preferences/index.md
+11 -12
View File
@@ -27,8 +27,7 @@ You can change your Grafana password at any time.
**To change your password**:
1. Sign in to Grafana.
1. Hover your mouse over the user icon in the lower-left corner of the page.
1. Click **Change Password**. Grafana opens the **Change Password** tab.
1. Click the user icon in the top right corner of the page and select **Change Password**.
1. Enter your old password and a new password.
1. Confirm your new password.
1. Click **Change Password**.
@@ -40,8 +39,8 @@ Your profile includes your name, user name, and email address, which you can upd
**To edit your profile**:
1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page and click **Preferences**.
1. In the **Edit Profile** section, update your profile and click **Save**.
1. Click the user icon in the top right corner of the page and select **Profile**.
1. In the **Profile** section, update your details and click **Save**.
## Edit your preferences
@@ -56,9 +55,9 @@ You can choose the way you would like data to appear in Grafana, including the U
**To edit your preferences**:
1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page, and click **Preferences**.
1. Update any of the values in the **Preferences** section.
1. Click **Save** at the bottom of the Preferences section.
1. Click the user icon in the top right corner of the page and select **Profile**.
1. Update any of the values in the Preferences section.
1. Click **Save** at the bottom of the section.
## Switch organizations
@@ -67,7 +66,7 @@ When you sign in to Grafana, the system signs you in to a default organization.
**To switch organizations**:
1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page and click **Switch organization**.
1. Click the user icon in the top right corner of the page and select **Switch organization**.
1. Next to the organization that you want to sign in to, click **Switch to**.
## View your assigned organizations
@@ -77,8 +76,8 @@ Every user is a member of at least one organization. You can have different role
**To view your assigned organizations**:
1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page and click **Preferences**.
1. Scroll down to the **Organizations** section and review the following information:
1. Click the user icon in the top right corner of the page and select **Profile**.
1. Scroll down to the Organizations section and review the following information:
- **Name**: The name of the organizations of which you are a member.
- **Role**: The role to which you are assigned in the organization. For more information about roles and permissions, refer to [Organization users and permissions]({{< relref "../../roles-and-permissions/#organization-users-and-permissions" >}}).
- **Current**: Grafana indicates the organization that you are currently signed into as _Current_. If you are a member of multiple organizations, you can click **Select** to switch to that organization.
@@ -90,7 +89,7 @@ Grafana logs your sessions in each Grafana instance. You can review this section
**To view your Grafana sessions**:
1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page, and click **Preferences**.
1. Click the user icon in the top right corner of the page and select **Profile**.
1. Scroll down to the **Sessions** section.
## Sign out a user session
@@ -100,6 +99,6 @@ You can sign out other sessions using your account in order to prevent other peo
**To sign out one of your Grafana sessions**:
1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page, and click **Preferences**.
1. Click the user icon in the top right corner of the page and select **Profile**.
1. Scroll down to the **Sessions** section.
1. Click the red "sign out" icon next to the session you would like to sign out.