mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-28 00:06:53 +01:00
d5fbd0b743
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
49 lines
3.5 KiB
Markdown
49 lines
3.5 KiB
Markdown
---
|
|
title: How to create and assign custom project roles
|
|
---
|
|
|
|
import VideoContent from '@site/src/components/VideoContent.jsx'
|
|
|
|
:::info availability
|
|
|
|
Custom project roles were introduced in **Unleash 4.6** and are only available in Unleash Enterprise.
|
|
|
|
:::
|
|
|
|
|
|
This guide takes you through [how to create](#creating-custom-project-roles "how to create custom project roles") and [assign](#assigning-custom-project-roles "how to assign custom project roles") [custom project roles](../reference/rbac.md#custom-project-roles). Custom project roles allow you to fine-tune access rights and permissions within your projects.
|
|
|
|
<VideoContent videoUrls={["https://www.youtube.com/embed/2BlckVMHxgE" , "https://www.youtube.com/embed/IqaD8iGxkwk"]}>
|
|
|
|
The guides on this page are also available in video format! Does a minute or two of watching someone walk through the steps sound better to you than following steps with static screenshots? If so, check out these video walkthroughs instead 🍿
|
|
|
|
</VideoContent>
|
|
|
|
## Creating custom project roles
|
|
|
|
It takes about three steps 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.
|
|
|
|
2. Navigate to the "Project roles" tab.
|
|
|
|
3. Use the "New project role" button to open the role creation form.
|
|
|
|
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](../reference/rbac.md#custom-project-roles).
|
|
|
|
|
|
## Assigning custom project roles
|
|
|
|
Custom project role creation is a pretty straightforward process and requires around three steps, outlined below.
|
|
|
|
To assign a custom project role to a user:
|
|
1. Navigate to the project you want to assign the user a role in.
|
|
|
|
2. Navigate to the project's _access_ tab.
|
|
|
|
3. This step depends on whether the user has already been added to the project or not:
|
|
- If the user has already been added to the project, click on the edit icon coresponding with its line and from the overlay that will show up select the new role you want to assign it from the dropdown and save the changes.
|
|
|
|
- If the user _hasn't_ been added to the project, add them using the button 'Assing user/group'. From the overlay that will show up select the user, assign it a role and save the changes. Now you should be able to see the new user in the table.
|
|
|