From 2dfe0a4060c84aaff8edc0ce3a07573d114f3f67 Mon Sep 17 00:00:00 2001 From: Christopher Moyer <35463610+chri2547@users.noreply.github.com> Date: Wed, 9 Nov 2022 10:09:46 -0600 Subject: [PATCH] Docs: adjusts topics to align with task templates (#58478) * updates topic to align with multiple task template * updates goal intro * aligns formatting with single task topic template * Update docs/sources/administration/team-management/index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * adds permissions requirements to two tasks Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> --- .../administration/team-management/index.md | 60 ++++++++----------- .../setup-grafana/sign-in-to-grafana.md | 18 +++++- 2 files changed, 40 insertions(+), 38 deletions(-) diff --git a/docs/sources/administration/team-management/index.md b/docs/sources/administration/team-management/index.md index 9f4759ef5c8..38c157e622e 100644 --- a/docs/sources/administration/team-management/index.md +++ b/docs/sources/administration/team-management/index.md @@ -19,18 +19,27 @@ For more information about teams, refer to [Teams and permissions]({{< relref ". For information about how to optimize your teams, refer to [How to best organize your teams and resources in Grafana](https://grafana.com/blog/2022/03/14/how-to-best-organize-your-teams-and-resources-in-grafana/). +This topic describes how to: + +- Create a team +- Add a team member +- Grant team member permissions +- Remove a team member +- Delete a team +- View a list of teams + +## Before you begin + +- Ensure that you have either organization administrator permissions or team administrator permissions +- Make a plan for which users belong to which teams and the permissions team members receive + ## Create a team A team is a group of users within an organization that have common dashboard and data source permission needs. Use teams to help make user-permission management more efficient. A user can belong to multiple teams. -**Before you begin:** - -- Ensure that you have either organization administrator permissions or team administrator permissions -- Make a plan for which users belong to which teams and the permissions team members receive - -**To create a team**: +To create a team: 1. Sign in to Grafana as an organization administrator or team administrator. 1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Teams**. @@ -42,14 +51,9 @@ A user can belong to multiple teams. ## Add a team member -Add a team member to an existing team whenever you want to provide access to team dashboards and folders to another user. +Add a team member to an existing team whenever you want to provide access to team dashboards and folders to another user. This task requires that you have organization administrator permissions. -**Before you begin:** - -- Ensure that you have organization administrator permissions -- [Create a team](#create-a-team). - -**To add a team member**: +To add a team member: 1. Sign in to Grafana as an organization administrator. 1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Teams**. @@ -64,11 +68,7 @@ Add a team member to an existing team whenever you want to provide access to tea Complete this task when you want to add or modify team member permissions. -**Before you begin:** - -- Ensure that you have either organization administrator permissions or team administrator permissions - -**To grant team member permissions**: +To grant team member permissions: 1. Sign in to Grafana as an organization administrator or a team administrator. 1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Teams**. @@ -82,11 +82,7 @@ Complete this task when you want to add or modify team member permissions. You can remove a team member when you no longer want to apply team permissions to the user -**Before you begin:** - -- Ensure that you have either organization administrator permissions or team administrator permissions - -**To remove a team member**: +To remove a team member: 1. Sign in to Grafana as an organization administrator or team administrator. 1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Teams**. @@ -96,13 +92,9 @@ You can remove a team member when you no longer want to apply team permissions t ## Delete a team -Delete a team when you no longer need it. This action permanently deletes the team and removes all team permissions from dashboards and folders. +Delete a team when you no longer need it. This action permanently deletes the team and removes all team permissions from dashboards and folders. This task requires that you have organization administrator permissions. -**Before you begin:** - -- Ensure that you have organization administrator permissions - -**To delete a team**: +To delete a team: 1. Sign in to Grafana as an organization administrator. 1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Teams**. @@ -113,24 +105,20 @@ Delete a team when you no longer need it. This action permanently deletes the te See the complete list of teams in your Grafana organization. -**Before you begin:** - -- Ensure that you have either organization administrator permissions or team administrator permissions - -**To view a list of teams**: +To view a list of teams: 1. Sign in to Grafana as an organization administrator or a team administrator. 1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Teams**. The role you use to sign in to Grafana determines how you see team lists. -**Organization administrator view** +## Organization administrator view The following example shows a list as it appears to an organization administrator. ![Team list](/static/img/docs/manage-users/org-admin-team-list-7-3.png) -**Team administrator view** +## Team administrator view The following example shows a list as it appears to a team administrator. diff --git a/docs/sources/setup-grafana/sign-in-to-grafana.md b/docs/sources/setup-grafana/sign-in-to-grafana.md index 1dc87b19a6a..ec58a61af31 100644 --- a/docs/sources/setup-grafana/sign-in-to-grafana.md +++ b/docs/sources/setup-grafana/sign-in-to-grafana.md @@ -8,11 +8,25 @@ weight: 400 # Sign in to Grafana +This topic describes how to sign in to Grafana. + +## Before you begin + +- [Install Grafana]({{< relref "./installation" >}}) + +## Steps + To sign in to Grafana for the first time: -1. Open your web browser and go to http://localhost:3000/. The default HTTP port that Grafana listens to is `3000` unless you have configured a different port. +1. Open your web browser and go to http://localhost:3000/. + + Unless you have configured a different port, Grafana listens to port `3000` by default. + 1. On the signin page, enter `admin` for username and password. -1. Click **Sign in**. If successful, you will see a prompt to change the password. +1. Click **Sign in**. + + If successful, you will see a prompt to change the password. + 1. Click **OK** on the prompt and change your password. > **Note:** We strongly recommend that you change the default administrator password.