diff --git a/docs/.DS_Store b/docs/.DS_Store index a12e18b7..76b8cd97 100644 Binary files a/docs/.DS_Store and b/docs/.DS_Store differ diff --git a/docs/modules/.DS_Store b/docs/modules/.DS_Store index 116fd9a9..75732321 100644 Binary files a/docs/modules/.DS_Store and b/docs/modules/.DS_Store differ diff --git a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc index 6d1a85e5..2645861a 100644 --- a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc +++ b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc @@ -1,231 +1,253 @@ = Permissions and roles -As a workspace owner, you can https://placeholder.com[invite] one or more collaborators to your workspace by adding their user ID, such as an external SSO ID. After https://placeholder.com[adding a user to a workspace], you assign them a specific role that determines the actions they can take in a workspace. +== Getting started -The roles available for a workspace, from least access to most access, are: +When the administrators at {ProductName} create a workspace for you, you automatically have the role of *Admin*. -* *Contributor*: Ideal for users who actively push to your workspace. +== Types of roles -* *Maintainer*: Ideal for users who need to manage the workspace without access to sensitive actions like managing security or deleting a workspace. +Invite other users to collaborate in your workspace by entering their {ProductName} username. You can assign one of the following roles to a collaborator: -* *Owner*: Ideal for users who need full access to the workspace, including sensitive and destructive actions like managing security or deleting a workspace. +* *Contributor*: For users who regularly push to your workspace +* *Maintainer*: For users who need to manage the workspace but who don't need access to sensitive actions like managing security or deleting a workspace +* *Admin*: For users who need full access to the workspace and who need to perform sensitive actions like managing security or deleting a workspace -NOTE: By default, the role for newly invited collaborators is *Contributor* but you can upgrade it to *Maintainer* or *Owner*. +== Managing users -== Permissions for each role +To begin adding, editing, or removing users from a workspace, complete the following steps: -The role assigned to a user determines the permissions they have within a workspace, with the Owner role assigning all permissions. +. In the side bar, select *Workspaces*. +. Select the tab *Access*. +=== Adding a user to a workspace + +. In *Find by username*, enter the {ProductName} username that you want to grant access to. +. Select *Grant Access*. +. In *Assign role*, select either *Contributor*, *Maintainer*, or *Admin*. +* To view the permissions for each role, select *Show list*. +. Select *Save*. + +=== Removing a user from a workspace +. Select the three dots next to the user that you want to remove. +. Select *Remove access*. +. To confirm, select *Remove*. + +=== Editing the access of a user +. Select the three dots next to the user that you want to edit. +. Select *Edit access*. +. In *Assign roles*, change the drop-down to the new role that you want. +* To view the permissions for each role, select *Show list*. +. Select *Save changes*. + +== Permissions by role + +The following table shows the actions that each type of collaborator can perform: + +.Permissions for each type of collaborator |=== -|Permissions for |Action |Contributor |Maintainer |Owner +|Action |Contributor |Maintainer |Admin -.4+|Workspace -|View -^|✔️ -^|✔️ -^|✔️ +|*Application:* -|Create -| -| -| -|Update +View an application +^.>|✔️ +^.>|✔️ +^.>|✔️ +|Create an application | | +^.^|✔️ + +|Update an application | -|Delete -| +^.^|✔️ +^.^|✔️ +|Delete an application | | -.4+|Applications -|View -^|✔️ +^.^|✔️ -^|✔️ -^|✔️ -|Create +|*Component:* + +View a component +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create a component | -^|✔️ +^.^|✔️ +^.^|✔️ -^|✔️ -|Update +|Update a component | -^|✔️ -^|✔️ +^.^|✔️ +^.^|✔️ -|Delete +|Delete a component | | -^|✔️ -.4+|Component +^.^|✔️ -|View -^|✔️ -^|✔️ -^|✔️ -|Create +|*Environment:* -| -^|✔️ -^|✔️ -|Update -| +View an environment + +^.>|✔️ +^.>|✔️ +^.>|✔️ -^|✔️ -^|✔️ +|Create an environment | +^.^|✔️ +^.^|✔️ + +|Update an environment | +^.^|✔️ +^.^|✔️ + +|Delete an environment | +^.^|✔️ +^.^|✔️ -^|✔️ -.4+|Environment -|View -^|✔️ -^|✔️ +|*Pipeline run:* -^|✔️ -|Create -| -| -^|✔️ +View pipeline run -|Update -| -| -^|✔️ -|Delete +^.>|✔️ +^.>|✔️ +^.>|✔️ -| -| -^|✔️ -.4+|IntegrationTestScenario -|View +|Create pipeline run +^.^|✔️ +^.^|✔️ +^.^|✔️ -^|✔️ -^|✔️ -^|✔️ -|Create +|Update pipeline run | +^.^|✔️ +^.^|✔️ -^|✔️ -^|✔️ -|Update +|Delete pipeline run | -^|✔️ +^.^|✔️ +^.^|✔️ -^|✔️ -|Delete -| -^|✔️ -^|✔️ +|*IntegrationTestScenario:* -.4+|EnterpriseContract -|View -^|✔️ -^|✔️ -^|✔️ +View IntegrationTestScenario -|Create -| -| -^|✔️ -|Update +^.>|✔️ +^.>|✔️ +^.>|✔️ +|Create IntegrationTestScenario | +^.^|✔️ +^.^|✔️ + +|Update IntegrationTestScenario | -^|✔️ -|Delete -| +^.^|✔️ +^.^|✔️ +|Delete IntegrationTestScenario | -^|✔️ -.4+|ReleaseStrategy -|View -^|✔️ +^.^|✔️ +^.^|✔️ + +|*Enterprise Contract:* + +View Enterprise Contract +^.>|✔️ +^.>|✔️ +^.>|✔️ -^|✔️ -^|✔️ -|Create +|Create Enterprise Contract +| | | -^|✔️ -|Update +|Update Enterprise Contract | | -^|✔️ +^.^|✔️ -|Delete +|Delete Enterprise Contract | | -^|✔️ -.4+|ReleasePlanAdmission +^.^|✔️ -|View -^|✔️ -^|✔️ -^|✔️ -|Create +|*Release strategy:* +View Release strategy + +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create Release strategy | -^|✔️ -^|✔️ -|Update -| +^.^|✔️ +^.^|✔️ -^|✔️ -^|✔️ -|Delete +|Update Release strategy +| +^.^|✔️ +^.^|✔️ +|Delete Release strategy | -^|✔️ +^.^|✔️ +^.^|✔️ -^|✔️ -.4+|User -|View -^|✔️ -^|✔️ +|*Release Admission Plan:* +View Release Admission Plan -^|✔️ -|Create -| -^|✔️ -^|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ -|Update +|Create Release Admission Plan | -^|✔️ -^|✔️ -|Delete +^.^|✔️ +^.^|✔️ +|Update Release Admission Plan | -^|✔️ -^|✔️ -.4+|User Group -|View +^.^|✔️ +^.^|✔️ -^|✔️ -^|✔️ -^|✔️ -|Create +|Delete Release Admission Plan | +^.^|✔️ +^.^|✔️ + +|*User:* + +View a user +^.>|✔️ +^.>|✔️ +^.>|✔️ +|Add a user to a workspace | -^|✔️ -|Update +^.^|✔️ +^.^|✔️ + +|Update a user | -^|✔️ +^.^|✔️ +^.^|✔️ -^|✔️ -|Delete +|Delete a user from a workspace | -^|✔️ -^|✔️ +^.^|✔️ +^.^|✔️ |=== -== Additional resources - -* https://placeholder.com[Managing members of a project] diff --git a/vale.ini b/vale.ini new file mode 100644 index 00000000..0d97147d --- /dev/null +++ b/vale.ini @@ -0,0 +1,8 @@ +StylesPath = styles + +MinAlertLevel = suggestion + +Packages = RedHat + +[*] +BasedOnStyles = RedHat \ No newline at end of file