From c113081866ff56f29b84f2a3da9405ccdaf3357a Mon Sep 17 00:00:00 2001 From: Thomas Heartman Date: Wed, 19 Jan 2022 15:05:28 +0100 Subject: [PATCH 1/2] docs: Add how-to videos to cpr how-tos For simplicity I've added them as separate sections, but I'd love for them to be listed higher up. --- ...-create-and-assign-custom-project-roles.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/website/docs/how-to/how-to-create-and-assign-custom-project-roles.md b/website/docs/how-to/how-to-create-and-assign-custom-project-roles.md index 865ff00d4fe..d0b3410a6c7 100644 --- a/website/docs/how-to/how-to-create-and-assign-custom-project-roles.md +++ b/website/docs/how-to/how-to-create-and-assign-custom-project-roles.md @@ -9,6 +9,9 @@ This guide takes you through [how to create](#creating-custom-project-roles "how ## Creating custom project roles + +It takes about three steps to create custom project roles. You can either follow the steps in writing below or watch [the accompanying video](#video-create). + To create custom project roles: 1. Navigate to the custom project roles page by using the admin menu (the gear symbol) and navigating to users. @@ -20,8 +23,18 @@ To create custom project roles: 4. Give the role a name, an optional description, and the set of permissions you'd like it to have. For a full overview of all the options, consult the [custom project roles reference documentation](../user_guide/rbac.md#custom-project-roles). ![The project role creation form filled in with details for a "developer" role. To the left is the equivalent cURL command you could run if you wanted to use the API instead of the form.](/img/create-cpr-step-4.png) +### How to create custom project roles (video) {#video-create} + +Here's a video recording with accompanying explanations of how to create custom project roles: + + + + + ## Assigning custom project roles +Custom project role creation is a pretty straightforward process and requires around three steps, outlined below. There's also a [video how-to guide for assigning custom project roles](#video-assign) available. + To assign a custom project role to a user: 1. Navigate to the project you want to assign the user a role in. ![The steps to navigate to a project: use the 'projects' navigation item and select your project.](/img/assign-cpr-step-1.png) @@ -32,3 +45,9 @@ To assign a custom project role to a user: ![A list of users with access to the current project. To the right of each user is a dropdown input labeled role.](/img/assign-cpr-step-3a.png) - If the user _hasn't_ been added to the project, add them via the 'add user' form. Select the role you want to give them from the role field. ![Adding a user to a project. The add user form is filled out with data for an "Alexis". The Role input is open and the custom "Developer" role is highlighted.](/img/assign-cpr-step-3b.png) + +### How to assign custom project roles (video) {#video-assign} + +Here's a video recording with accompanying explanations of how to assign custom project roles: + + From 3ce2ea0f611681276ef36034a7e99a6e24ca6b97 Mon Sep 17 00:00:00 2001 From: Thomas Heartman Date: Wed, 19 Jan 2022 15:08:25 +0100 Subject: [PATCH 2/2] docs: simplify text --- .../how-to/how-to-create-and-assign-custom-project-roles.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/how-to/how-to-create-and-assign-custom-project-roles.md b/website/docs/how-to/how-to-create-and-assign-custom-project-roles.md index d0b3410a6c7..fe7f6d2f641 100644 --- a/website/docs/how-to/how-to-create-and-assign-custom-project-roles.md +++ b/website/docs/how-to/how-to-create-and-assign-custom-project-roles.md @@ -33,7 +33,7 @@ Here's a video recording with accompanying explanations of how to create custom ## Assigning custom project roles -Custom project role creation is a pretty straightforward process and requires around three steps, outlined below. There's also a [video how-to guide for assigning custom project roles](#video-assign) available. +Custom project role creation is a pretty straightforward process and requires around three steps, outlined below. There's also a [video version](#video-assign) available. To assign a custom project role to a user: 1. Navigate to the project you want to assign the user a role in.