PackageJson: Prettify markdown/mdx on commit with lint-staged (#37616)

* Format md,mdx files with prettier on lint-staged

* Manually run prettier on docs/sources
This commit is contained in:
Connor Lindsey
2021-08-06 07:52:36 -06:00
committed by GitHub
parent e9c032f10f
commit b78a67cec7
301 changed files with 3216 additions and 2980 deletions
+3 -1
View File
@@ -33,8 +33,9 @@ Members of organizations have permissions based on their _role_ in the organizat
Organization Admins are user accounts that are assigned the Admin role for an organization. They can manage their users and teams in their organization.
Organization Admins can:
- [Manage users]({{< relref "org-admin/_index.md" >}})
- [Manage teams]({{< relref "manage-teams/index.md" >}})
- [Manage teams]({{< relref "manage-teams/index.md" >}})
## Teams
@@ -49,6 +50,7 @@ Team Admins can [Manage teams]({{< relref "manage-teams/index.md" >}}).
Users are named accounts in Grafana with granted permissions to access resources throughout Grafana. All users can manage their own accounts to a limited extent.
Users can:
- [View and edit user profile]({{< relref "user-admin/user-profile.md" >}})
- [Change password]({{< relref "user-admin/change-your-password.md" >}})
- [Switch organizations]({{< relref "user-admin/switch-org.md" >}})
@@ -9,6 +9,7 @@ weight = 300
A _team_ is a group of users assigned to an organization on a Grafana server. Each user can belong to more than one organization and more than one team. Teams are generally managed by Organization Admins, but they can also be managed by Editors if the [editors_can_admin]({{< relref "../../administration/configuration.md#editors_can_admin" >}}) server setting is set to `true`. For more information, refer to [Organization roles]({{< relref "../../permissions/organization_roles.md" >}}).
Teams members are assigned one of two permissions:
- Member - Required to be a member of the team.
- Admin - A member of the team that can also manage team membership, change team permissions, change team settings, and add or delete the team.
@@ -34,12 +35,13 @@ Add a team to your Grafana organization.
{{< docs/list >}}
{{< docs/shared "manage-users/view-team-list.md" >}}
1. Click **New Team**.
1. Enter team information:
- **Name -** Enter the name of the new team.
- **Email -** (Optional) Enter the team email.
1. Click **Create**.
{{< /docs/list >}}
{{< /docs/list >}}
## Add a team member
@@ -47,12 +49,13 @@ Add an existing user account to a team.
{{< docs/list >}}
{{< docs/shared "manage-users/view-team-list.md" >}}
1. Click the name of the team that you want to add users to.
1. Click **Add member**.
1. In the **Add team member** list, click the user account that you want to add to the team. You can also type in the field to filter the list.
1. Click **Add to team**.
1. Repeat the process to add more team members.
{{< /docs/list >}}
{{< /docs/list >}}
![Add team member](/static/img/docs/manage-users/add-team-member-7-3.png)
@@ -62,9 +65,10 @@ Remove a user account from the team.
{{< docs/list >}}
{{< docs/shared "manage-users/view-team-list.md" >}}
1. Click the name of the team that you want to remove users from.
1. Click the red **X** next to the name of the user that you want to remove from the team and then click **Delete**.
{{< /docs/list >}}
{{< /docs/list >}}
## Set team member permissions
@@ -72,10 +76,11 @@ Change team member permission levels.
{{< docs/list >}}
{{< docs/shared "manage-users/view-team-list.md" >}}
1. Click the name of the team in which you want to change user permissions.
1. In the team member list, find and click the user account that you want to change. You can use the search field to filter the list if necessary.
1. Click the **Permission** list, and then click the new user permission level.
{{< /docs/list >}}
{{< /docs/list >}}
![Change team member permissions](/static/img/docs/manage-users/change-team-permissions-7-3.png)
@@ -85,5 +90,6 @@ Permanently delete the team and all special permissions assigned to it.
{{< docs/list >}}
{{< docs/shared "manage-users/view-team-list.md" >}}
1. Click the red **X** next to the team that you want to delete and then click **Delete**.
{{< /docs/list >}}
{{< /docs/list >}}
@@ -19,6 +19,7 @@ See a complete list of users with accounts in your Grafana organization. If nece
1. Click **Users**.
Grafana displays all user accounts on the server, listed in alphabetical order by user name. The following information is displayed:
- **Login -** The value in the **Username** field of the account.
- **Email -** The email associated with the user account.
- **Name -** The value in the **Name** field of the account.
@@ -18,6 +18,7 @@ See a complete list of organizations set up on your Grafana server.
{{< docs/shared "manage-users/view-server-org-list.md" >}}
Grafana displays all organizations set up on the server, listed in alphabetical order by organization name. The following information is displayed:
- **Id -** The ID number of the organization.
- **Name -** The name of the organization.
@@ -29,11 +30,13 @@ Add an organization to your Grafana server.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-org-list.md" >}}
1. Click **+ New org**.
1. Enter the name of the new organization and then click **Create**.
{{< /docs/list >}}
{{< /docs/list >}}
Two things happen:
- Grafana creates a new organization with you as the sole member and Admin.
- Grafana opens the new organization [Preferences tab]({{< relref "../../administration/preferences/_index.md" >}}).
@@ -47,9 +50,10 @@ Permanently remove an organization from your Grafana server.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-org-list.md" >}}
1. Click the red **X** next to the organization that you want to remove.
1. Click **Delete**.
{{< /docs/list >}}
{{< /docs/list >}}
## Edit an organization
@@ -63,17 +67,19 @@ See which user accounts are assigned to the organization and their assigned role
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-org-list.md" >}}
1. Click the name of the organization for which you want to view members.
1. Scroll down to the Organization Users section. User accounts are displayed in alphabetical order.
{{< /docs/list >}}
{{< /docs/list >}}
### Change organization name
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-org-list-and-edit.md" >}}
1. In the **Name** field, type the new organization name.
1. Click **Update**.
{{< /docs/list >}}
{{< /docs/list >}}
### Change organization member role
@@ -81,14 +87,16 @@ Change the organization role assigned to a user account that is assigned to the
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-org-list-and-edit.md" >}}
1. In the Organization Users section, locate the user account that you want to change the role of.
1. In the **Role** field, select the new role that you want to assign.
{{< /docs/list >}}
{{< /docs/list >}}
## Remove a user from an organization
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-org-list-and-edit.md" >}}
1. In the Organization Users section, locate the user account that you want to change the role of.
1. Click the red **X** next to the user account listing and then click **Delete**.
{{< /docs/list >}}
{{< /docs/list >}}
@@ -34,9 +34,10 @@ Grafana displays all user accounts on the server, listed in alphabetical order b
See all details associated with a specific user account.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-user-list.md" >}}
1. Click the user account you wish to view. If necessary, use the search field at the top of the tab to search for the specific user account that you need.
{{< /docs/list >}}
{{< docs/shared "manage-users/view-server-user-list.md" >}}
1. Click the user account you wish to view. If necessary, use the search field at the top of the tab to search for the specific user account that you need.
{{< /docs/list >}}
Each user account contains the following sections.
@@ -74,15 +75,18 @@ See recent sessions that the user was logged on, including when they logged on a
Create a new user account at the server level.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-user-list.md" >}}
1. Click **New user**.
1. Enter the following information:
- **Name -** Required.
- **E-mail -** Optional if a **Username** is entered.
- **Username -** Optional if an **E-mail** is entered.
- **Password -** Required.
1. Click **Create user**.
{{< /docs/list >}}
{{< docs/shared "manage-users/view-server-user-list.md" >}}
1. Click **New user**.
1. Enter the following information:
- **Name -** Required.
- **E-mail -** Optional if a **Username** is entered.
- **Username -** Optional if an **E-mail** is entered.
- **Password -** Required.
1. Click **Create user**.
{{< /docs/list >}}
The user can change all this information after they log in. For instructions, refer to [Grafana user account profile]({{< relref "../user-admin/user-profile.md" >}}) and [Change your password]({{< relref "../user-admin/change-your-password.md" >}}).
@@ -95,10 +99,11 @@ Change information or settings in an individual user account.
Edit information on an existing user account, including the user name, email, username, and password.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
1. In the User information section, click **Edit** next to the field that you want to change.
1. Enter the new value and then click **Save**.
{{< /docs/list >}}
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
1. In the User information section, click **Edit** next to the field that you want to change.
1. Enter the new value and then click **Save**.
{{< /docs/list >}}
### Change the password on a user account
@@ -106,9 +111,10 @@ Users can change their own passwords, but Server Admins can change user password
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
1. In the User information section, click **Edit** next to the **Password** field.
1. Enter the new value and then click **Save**. Grafana requires a value at least four characters long in this field.
{{< /docs/list >}}
{{< /docs/list >}}
### Delete a user account
@@ -116,9 +122,10 @@ Permanently remove a user account from the server.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
1. Click **Delete User**.
1. Click **Delete user** to confirm the action.
{{< /docs/list >}}
{{< /docs/list >}}
### Enable or disable a user account
@@ -130,9 +137,10 @@ Prevent a user from logging in with this account, but do not delete the account.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
1. Click **Disable User**.
1. Click **Disable user** to confirm the action.
{{< /docs/list >}}
{{< /docs/list >}}
#### Enable a user account
@@ -140,8 +148,9 @@ Reactivate a disabled user account.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
1. Click **Enable User**.
{{< /docs/list >}}
{{< /docs/list >}}
## Add/remove Grafana Admin flag
@@ -149,10 +158,11 @@ Give or remove the Grafana Server Admin role from a user account.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
1. In the Permissions section, click **Change**.
1. Click **Yes** or **No**, depending on whether or not you want this user account to have the Grafana Server Admin role.
1. Click **Change**.
{{< /docs/list >}}
{{< /docs/list >}}
The next time this user logs in, their permissions will be updated.
@@ -162,11 +172,12 @@ Add a user account to an existing organization. User accounts can belong to mult
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
1. In the Organisations section, click **Add user to organisation**.
1. In the **Add to an organization** window, select the **Organisation** that you are adding the user to.
1. Select the **Role** that the user should have in the organization.
1. Click **Add to organisation**.
{{< /docs/list >}}
{{< /docs/list >}}
## Remove a user from an organization
@@ -174,9 +185,10 @@ Remove a user account from an organization that it is currently assigned to.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
1. In the Organisations section, click **Remove from organisation** next to the organization that you want to remove the user from.
1. Click **Confirm removal**.
{{< /docs/list >}}
{{< /docs/list >}}
## Change organization role
@@ -184,9 +196,10 @@ Change the organization role assigned to a user account.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
1. In the Organisations section, click **Change role** next to the organization that you want to change the user role for.
1. Select the new role and then click **Save**.
{{< /docs/list >}}
{{< /docs/list >}}
## View and manage user sessions
@@ -194,8 +207,9 @@ See when a user last logged in and information about how they logged in. You can
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
1. Scroll down to the Sessions section to view sessions associated with this user account.
{{< /docs/list >}}
{{< /docs/list >}}
## Force a user to log out of Grafana
@@ -207,10 +221,11 @@ Log the user account out of one specific device that is logged in to Grafana.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
1. Scroll down to the Sessions section.
1. Click **Force logout** next to the session entry that you want logged out of Grafana.
1. Click **Confirm logout**.
{{< /docs/list >}}
{{< /docs/list >}}
### Force logout of all devices
@@ -218,7 +233,8 @@ Log the user account out of all devices that are logged in to Grafana.
{{< docs/list >}}
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
1. Scroll down to the Sessions section.
1. Click **Force logout from all devices**.
1. Click **Force logout**.
{{< /docs/list >}}
{{< /docs/list >}}
@@ -4,9 +4,9 @@ description = "Change which organization you are logged in with"
weight = 300
+++
# Change the organization you are signed in to
# Change the organization you are signed in to
When you sign in to Grafana, you are always signed in with a particular organization. If you are assigned to multiple organizations, then you might need to switch which organization you are signed in to. For example, if you need to view a dashboard associated with a different org, then you might switch organizations.
1. Hover your cursor over your user icon in the lower left corner of the screen, then click **Switch**.
1. Next to the organization that you want to sign in to, click **Switch to**.
1. Next to the organization that you want to sign in to, click **Switch to**.
@@ -39,4 +39,4 @@ Grafana logs your sessions in each Grafana instance. You can review this section
- **Logged on -** The date you logged on to the current Grafana instance.
- **IP address -** The IP address that you logged on from.
- **Browser & OS -** The web browser and operating system used to log on to Grafana.
- If you are a Grafana Admin for the instance, then you can revoke a session by clicking the red signout icon in the session row.
- If you are a Grafana Admin for the instance, then you can revoke a session by clicking the red signout icon in the session row.