From 83e320ca19655cfec1f4ef642d7a8fcea04857e3 Mon Sep 17 00:00:00 2001 From: nicoletacoman Date: Mon, 28 Apr 2025 17:14:40 +0200 Subject: [PATCH 1/2] Changes per live UI --- .../people/roles-permissions.md | 103 +++++++++--------- 1 file changed, 51 insertions(+), 52 deletions(-) diff --git a/content/en/docs/control-center/people/roles-permissions.md b/content/en/docs/control-center/people/roles-permissions.md index ea3d2400ef0..4d38f401fc5 100644 --- a/content/en/docs/control-center/people/roles-permissions.md +++ b/content/en/docs/control-center/people/roles-permissions.md @@ -8,94 +8,93 @@ no_list: true ## Introduction -On the **Roles & Permissions** page in Control Center, you can view and manage centralized company-level project roles and permissions. +On the **Roles & Permissions** page in the Control Center, you can view and manage centralized project roles and permissions for your company. ## Centralized Project Roles -All companies use centralized project roles. This means: +Centralized project roles allow Mendix Admins to control access across all Mendix projects within a company. -* Mendix Admins will be the only ones who can create or modify project roles. +Scrum Masters and team members can only view and choose from the project roles established by Mendix Admins, with no ability to change role permissions. If a custom permission set is needed, Scrum Masters and team members must reach out to a Mendix Admin for assistance. -* Scrum Masters and team members will only be able to view the project roles established by Mendix Admins and select the appropriate one. They will not have the ability to modify the permissions of project roles. If a custom permission set is needed, they must reach out to a Mendix Admin for assistance in creating it. +## Project Roles Overview -* Some roles will appear with the tag **Inherited from project** on the **Roles & Permissions** page in Control Center. A Mendix Admin can review these custom project roles, keep the useful ones, and merge any duplicates. +The **Roles & Permissions** page provides an overview of all centralized project roles, with the following information for each role: + +* A brief summary of the permissions included in the role. +* The number of projects where the role is used. Clicking the number opens a pop-up window which list these projects. +* The number of members who are assigned the role. {{% alert color="info" %}} - When members of your company [invite someone to an project](/developerportal/general/team/#inviting), they cannot select any role with the tag **Inherited from project** shown here, as these roles will not be shown to them. + Some roles on this page are tagged as **Inherited from project**. A Mendix Admin can review these custom project roles, keep the useful ones, and merge any duplicates. + When members of your company [invite someone to an project](/developerportal/general/team/#inviting), they cannot select any role with the tag **Inherited from project**, as these roles will not be visible to them. {{% /alert %}} -### Project Roles Overview +From the overview page, you can show role details, and create, edit, or delete a role. -On the **Roles & Permissions** page, you have an overview of all centralized project roles. You will see a brief summary for each role of the permissions that the role has as well as in how many projects and by how many team members they are used. +## Creating a Role -Clicking the number of projects that use the role opens up a pop-up window with a list of projects where the role is used. +Follow these steps to create a role: -From the overview page you can **Create**, **Edit**, or **Delete** a role. +1. In the upper-right corner of the page, click **Create Project Role**. A wizard opens to guide you through the necessary steps. -### Creating a Role +2. Add the following details on the **Project Role Details** tab: -To create a role, do the following: + 1. A role name. Every role name in your company must be unique. + 2. Optionally, a description of the role for further reference. -1. At the upper-right corner of the page, click **Create Project Role**. A wizard opens to guide you through the steps to set up the new role. + {{< figure src="/attachments/control-center/people/roles-permissions/edit-project-role-step-1.png" alt="Project Role Step 1" >}} -2. In the wizard, configure the settings on the **Project Role Details** tab. +3. Click **Next** and select the desired permissions for the role on the **Project Permissions** tab. They determine what the team member is allowed to do in terms of project management. - {{< figure src="/attachments/control-center/people/roles-permissions/edit-project-role-step-1.png" alt="Project Role Step 1" >}} + {{< figure src="/attachments/control-center/people/roles-permissions/edit-project-role-step-2.png" alt="Project Role Step 2" >}} - 1. Enter a role name. Every role name in your company must be unique. - 2. Optionally, add a description for the role for further reference. +4. Click **Next** and select the access rights for **Non-production Environments**. These permissions dictate access to environments such as test or acceptance, and are applied to the assigned team members on the [Permissions](/developerportal/deploy/environments/#permissions) page in the Cloud Portal. -3. Click **Next** and configure the settings on **Project Permissions** tab. +{{< figure src="/attachments/control-center/people/roles-permissions/edit-project-role-step-3.png" alt="Project Role Step 3" >}} - {{< figure src="/attachments/control-center/people/roles-permissions/edit-project-role-step-2.png" alt="Project Role Step 2" >}} +You can choose between **No Access** and **Access**. - These permissions determine what the team member is allowed to do within the context of project management. +If you choose **Access**, you can refine your settings in the following sections: -4. Click **Next** and configure the settings on the **Non-production Environments** tab. +* **Permission Management** - You can select **Fixed** or **Custom**. + * If you select **Fixed**, continue to set the permissions for this role in **Set Permissions**. + * If you select **Custom**, you allow anyone with **Manage Permissions** rights, such as the Technical Contact, to set permissions per environment. +* **Set Permissions** - Choose the specific privileges you want to include in this role for non-production environments. The permissions you set here will be fixed for this role. They cannot be altered later on the **Permissions** page. - {{< figure src="/attachments/control-center/people/roles-permissions/edit-project-role-step-3.png" alt="Project Role Step 3" >}} +5. Click **Next** and select the access rights for **Production Environments**. - Set the environment permissions for non-productive environments, such as the test or acceptance environments, as described below. These permissions are applied to the assigned team members on the [Permissions](/developerportal/deploy/environments/#permissions) page in the Cloud Portal. +{{% alert color="warning" %}}You need to complete multi-factor authentication before you can edit and save production environment permissions.{{% /alert %}} - 1. Set the correct access rights. - 2. For **Permission Management**, you can select **Fixed** or **Custom**. - * If you select **Fixed**, continue to set the permissions for this role at the bottom. The permissions you set here will be fixed for this role. They cannot be altered later on the **Permissions** page. - * If you select **Custom**, you allow anyone with Manage Permissions rights, for example, the Technical Contact, to set the permissions per environment. +{{< figure src="/attachments/control-center/people/roles-permissions/edit-project-role-step-4.png" alt="Project Role Step 4" >}} -5. Click **Next** and configure the settings on the **Production Environments** tab. +The permissions you set here are fixed for this role. They cannot be changed on the [Permissions](/developerportal/deploy/environments/#permissions) page in the Cloud Portal. - {{< figure src="/attachments/control-center/people/roles-permissions/edit-project-role-step-4.png" alt="Project Role Step 4" >}} +You can choose between **No Access** and **Access**. - Set the environment permissions for production environments as described below. The permissions you set here will be fixed for this role. They cannot be altered later on the [Permissions](/developerportal/deploy/environments/#permissions) page in the Cloud Portal. +If you choose **Access**, you can refine your settings in the following sections: - 1. Set the correct access rights. - 2. For **Permission Management**, you can select **Fixed** or **Custom**. - - * If you select **Fixed**, continue to set the permissions for this role at the bottom. The permissions you set here will be fixed for this role. They cannot be altered later on the **Permissions** page. - - * If you select **Custom**, you allow anyone with Manage Permissions rights, for example, the Technical Contact, to set the permissions per environment. +* **Permission Management** - You can select **Fixed** or **Custom**. + * If you select **Fixed**, continue to set the permissions for this role in **Set Permissions**. + * If you select **Custom**, you allow anyone with **Manage Permissions** rights, such as the Technical Contact, to set permissions per environment. +* **Set Permissions** - Choose the specific privileges you want to include in this role for non-production environments. The permissions you set here will be fixed for this role. They cannot be altered later on the **Permissions** page. - {{% alert color="warning" %}}Editing and saving the production environment permissions can only be done after a **multi-factor authentication** has taken place.{{% /alert %}} +## Showing Role Details -### Showing Details +To view the details of a role, click **Show Details**. This opens the **Project Role Details** pop-up window, which contains the role name, ID, and permissions. -To show the details of a role, click **Show Details**. The **Project Role Details** pop-up window opens with detailed information about the role. +The role ID can be used in the [Mendix Projects API](/apidocs-mxsdk/apidocs/projects-api/). {{< figure src="/attachments/control-center/people/roles-permissions/project-role-details.png" alt="Project Role Details" >}} -{{% alert color="info" %}} -In the **Project Role Details** pop-up window, you can find the role ID that can be used in the [Mendix Projects API](/apidocs-mxsdk/apidocs/projects-api/). -{{% /alert %}} - -### Editing a Role +## Editing a Role -To edit a role, do the following: +Follow these steps to make changes to a role: 1. Click **Edit Role** for the role you want to edit. -2. Make the changes. +2. Make the necessary changes. 3. Click **Save Changes**. -Changes made to the permissions of a role are immediately applied to the team members that are assigned to the role. +Changes made to the permissions of a role are immediately applied to the team members that are assigned that role. To prevent concurrent changes overwriting each other, only one role can be edited at any one time. @@ -103,16 +102,16 @@ To prevent concurrent changes overwriting each other, only one role can be edite You cannot edit the Scrum Master role. This ensures that there is always someone in the project's team that can manage the project. {{% /alert %}} -### Deleting a Role +## Deleting a Role -To delete a role, do the following: +Follow these steps to delete a role: 1. Click **Edit Role** for the role you want to delete. -2. Review the role. -3. Click **Delete Project Role**. A dialog box opens to ask for confirmation. +2. Review the role by clicking through each tab. +3. Click **Delete Project Role**. A dialog box is displayed, asking for confirmation. 4. Click **Delete Project Role** to permanently delete the role. -If the role is used by a project, a replacement role must be selected. This role will be applied to all team members who are currently assigned to the role to be deleted. If the replacement role has different permissions, then these will be applied immediately. +If the role is used by a project, a replacement role must be selected. The replacement is applied to all team members who are currently assigned the role you are deleting. If the replacement role has different permissions, then these will be applied immediately. {{% alert color="info" %}} You cannot delete the Scrum Master role. This ensures that there is always someone in the project's team that can manage the project. From d5841cfd2e95836fe2a1f0109bf1c83202797733 Mon Sep 17 00:00:00 2001 From: nicoletacoman Date: Tue, 29 Apr 2025 10:14:55 +0200 Subject: [PATCH 2/2] Second round of proofreading --- .../people/roles-permissions.md | 31 ++++++++++--------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/content/en/docs/control-center/people/roles-permissions.md b/content/en/docs/control-center/people/roles-permissions.md index 4d38f401fc5..3b0e10a4992 100644 --- a/content/en/docs/control-center/people/roles-permissions.md +++ b/content/en/docs/control-center/people/roles-permissions.md @@ -8,25 +8,25 @@ no_list: true ## Introduction -On the **Roles & Permissions** page in the Control Center, you can view and manage centralized project roles and permissions for your company. +On the **Roles & Permissions** page in the Control Center, you can view and manage centralized project roles and and their permissions for your company. ## Centralized Project Roles -Centralized project roles allow Mendix Admins to control access across all Mendix projects within a company. +Centralized project roles allow Mendix Admins to control access across all Mendix projects within their company. -Scrum Masters and team members can only view and choose from the project roles established by Mendix Admins, with no ability to change role permissions. If a custom permission set is needed, Scrum Masters and team members must reach out to a Mendix Admin for assistance. +Within the centralized role framework, Scrum Masters and team members can only view and choose from the project roles established by Mendix Admins, with no ability to change role permissions. If a custom permission set is needed, Scrum Masters and team members must reach out to a Mendix Admin for assistance. ## Project Roles Overview The **Roles & Permissions** page provides an overview of all centralized project roles, with the following information for each role: * A brief summary of the permissions included in the role. -* The number of projects where the role is used. Clicking the number opens a pop-up window which list these projects. +* The number of projects where the role is used. Clicking the number opens a pop-up window which lists these projects. * The number of members who are assigned the role. {{% alert color="info" %}} Some roles on this page are tagged as **Inherited from project**. A Mendix Admin can review these custom project roles, keep the useful ones, and merge any duplicates. - When members of your company [invite someone to an project](/developerportal/general/team/#inviting), they cannot select any role with the tag **Inherited from project**, as these roles will not be visible to them. + When members of your company [invite someone to a project](/developerportal/general/team/#inviting), they cannot select any role with the tag **Inherited from project**, as these roles will not be visible to them. {{% /alert %}} From the overview page, you can show role details, and create, edit, or delete a role. @@ -44,11 +44,13 @@ Follow these steps to create a role: {{< figure src="/attachments/control-center/people/roles-permissions/edit-project-role-step-1.png" alt="Project Role Step 1" >}} -3. Click **Next** and select the desired permissions for the role on the **Project Permissions** tab. They determine what the team member is allowed to do in terms of project management. +3. Click **Next**. +4. Select the desired permissions for the role on the **Project Permissions** tab. These permissions determine what the team member is allowed to do in terms of project management. {{< figure src="/attachments/control-center/people/roles-permissions/edit-project-role-step-2.png" alt="Project Role Step 2" >}} -4. Click **Next** and select the access rights for **Non-production Environments**. These permissions dictate access to environments such as test or acceptance, and are applied to the assigned team members on the [Permissions](/developerportal/deploy/environments/#permissions) page in the Cloud Portal. +5. Click **Next**. +6. Select the access rights for **Non-production Environments**. These permissions dictate access to environments such as test or acceptance, and are applied to the assigned team members on the [Permissions](/developerportal/deploy/environments/#permissions) page in the Cloud Portal. {{< figure src="/attachments/control-center/people/roles-permissions/edit-project-role-step-3.png" alt="Project Role Step 3" >}} @@ -57,26 +59,25 @@ You can choose between **No Access** and **Access**. If you choose **Access**, you can refine your settings in the following sections: * **Permission Management** - You can select **Fixed** or **Custom**. - * If you select **Fixed**, continue to set the permissions for this role in **Set Permissions**. + * If you select **Fixed**, continue to set the permissions for this role in the **Set Permissions** section. * If you select **Custom**, you allow anyone with **Manage Permissions** rights, such as the Technical Contact, to set permissions per environment. -* **Set Permissions** - Choose the specific privileges you want to include in this role for non-production environments. The permissions you set here will be fixed for this role. They cannot be altered later on the **Permissions** page. +* **Set Permissions** - Choose the specific privileges you want to include in this role for non-production environments. The permissions you set here are fixed for this role. They cannot be changed later on the **Permissions** page. -5. Click **Next** and select the access rights for **Production Environments**. +7. Click **Next**. +8. Select the access rights for **Production Environments**. {{% alert color="warning" %}}You need to complete multi-factor authentication before you can edit and save production environment permissions.{{% /alert %}} {{< figure src="/attachments/control-center/people/roles-permissions/edit-project-role-step-4.png" alt="Project Role Step 4" >}} -The permissions you set here are fixed for this role. They cannot be changed on the [Permissions](/developerportal/deploy/environments/#permissions) page in the Cloud Portal. - You can choose between **No Access** and **Access**. If you choose **Access**, you can refine your settings in the following sections: * **Permission Management** - You can select **Fixed** or **Custom**. - * If you select **Fixed**, continue to set the permissions for this role in **Set Permissions**. + * If you select **Fixed**, continue to set the permissions for this role in the **Set Permissions** section. * If you select **Custom**, you allow anyone with **Manage Permissions** rights, such as the Technical Contact, to set permissions per environment. -* **Set Permissions** - Choose the specific privileges you want to include in this role for non-production environments. The permissions you set here will be fixed for this role. They cannot be altered later on the **Permissions** page. +* **Set Permissions** - Choose the specific privileges you want to include in this role for non-production environments. The permissions you set here are fixed for this role. They cannot be changed later on the **Permissions** page. ## Showing Role Details @@ -111,7 +112,7 @@ Follow these steps to delete a role: 3. Click **Delete Project Role**. A dialog box is displayed, asking for confirmation. 4. Click **Delete Project Role** to permanently delete the role. -If the role is used by a project, a replacement role must be selected. The replacement is applied to all team members who are currently assigned the role you are deleting. If the replacement role has different permissions, then these will be applied immediately. +If the role is used by a project, a replacement role must be selected. The replacement is applied to all team members who are currently assigned the role you are deleting. If the replacement role has different permissions, then these are applied immediately. {{% alert color="info" %}} You cannot delete the Scrum Master role. This ensures that there is always someone in the project's team that can manage the project.