From 3349eea056f792454566ab819e572cb8d6e0c016 Mon Sep 17 00:00:00 2001 From: Chloe Date: Fri, 9 Jun 2023 10:50:05 -0400 Subject: [PATCH 1/7] Updates roles and permissions topic --- .../getting-started/roles_persmissions.adoc | 440 ++++++++++++------ 1 file changed, 304 insertions(+), 136 deletions(-) diff --git a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc index 6d1a85e5..2bb2f721 100644 --- a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc +++ b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc @@ -1,231 +1,399 @@ = 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. +As a workspace *Owner*, you can invite collaborators to your workspace by adding a user ID such as an external SSO ID. After you add a user to a workspace, you assign a specific role to designate what actions that user can perform. -The roles available for a workspace, from least access to most access, are: +The following list shows the roles that are available in a workspace: -* *Contributor*: Ideal for users who actively push to your workspace. +* *Contributor*: Ideal for users who actively push to your workspace +* *Maintainer*: Ideal for users who need to manage the workspace, but who don't need access to sensitive actions like managing security or deleting a workspace +* *Owner*: Ideal for users who need full access to the workspace, including sensitive actions like managing security or deleting a workspace -* *Maintainer*: Ideal for users who need to manage the workspace without access to sensitive actions like managing security or deleting a workspace. +NOTE: By default, any collaborator that you invite has the role of *Contributor*. -* *Owner*: Ideal for users who need full access to the workspace, including sensitive and destructive actions like managing security or deleting a workspace. +== Permissions by role -NOTE: By default, the role for newly invited collaborators is *Contributor* but you can upgrade it to *Maintainer* or *Owner*. +The role that you assign to a user determines the permissions that the user has in the workspace. The *Owner* role assigns all permissions. -== Permissions for each role - -The role assigned to a user determines the permissions they have within a workspace, with the Owner role assigning all permissions. +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 |Owner |Tenant Admin + +|*Workspace:* -.4+|Workspace -|View -^|✔️ -^|✔️ -^|✔️ +View a workspace +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ -|Create +|Create a workspace | | +^.^|✔️ +^.^|✔️ + +|Update a workspace | -|Update +^.^|✔️ +^.^|✔️ +^.^|✔️ +|Delete a workspace +| | +^.^|✔️ +^.^|✔️ + +|*Application:* + +View an application +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create an application | | -|Delete +^.^|✔️ +^.^|✔️ + +|Update an application | +^.^|✔️ +^.^|✔️ +^.^|✔️ +|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:* +View an environment + +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create an environment | -^|✔️ -^|✔️ -|Update +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Update an environment | +^.^|✔️ +^.^|✔️ +^.^|✔️ -^|✔️ -^|✔️ +|Delete an environment | +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|*Pipeline run:* + +View pipeline run + +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create pipeline run +^.^|✔️ +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Update pipeline run | +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Delete pipeline run | +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|*IntegrationTestScenario:* + +View IntegrationTestScenario + +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create IntegrationTestScenario +| +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Update IntegrationTestScenario +| +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Delete IntegrationTestScenario +| +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|*Enterprise Contract:* -^|✔️ -.4+|Environment -|View -^|✔️ -^|✔️ +View Enterprise Contract +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ -^|✔️ -|Create +|Create Enterprise Contract | | -^|✔️ +| +^.^|✔️ -|Update +|Update Enterprise Contract | | -^|✔️ -|Delete +^.^|✔️ +^.^|✔️ +|Delete Enterprise Contract | | -^|✔️ -.4+|IntegrationTestScenario -|View +^.^|✔️ +^.^|✔️ + +|*Release strategy:* + +View Release strategy + +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ -^|✔️ -^|✔️ -^|✔️ -|Create +|Create Release strategy | +^.^|✔️ +^.^|✔️ +^.^|✔️ -^|✔️ -^|✔️ -|Update +|Update Release strategy | -^|✔️ +^.^|✔️ +^.^|✔️ +^.^|✔️ -^|✔️ -|Delete +|Delete Release strategy | -^|✔️ -^|✔️ +^.^|✔️ +^.^|✔️ +^.^|✔️ -.4+|EnterpriseContract -|View -^|✔️ -^|✔️ -^|✔️ +|*Release Admission Plan:* +View Release Admission Plan -|Create +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create Release Admission Plan | +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Update Release Admission Plan | -^|✔️ -|Update +^.^|✔️ +^.^|✔️ +^.^|✔️ +|Delete Release Admission Plan | +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|*User:* + +View a user +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create a user | -^|✔️ -|Delete +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Update a user | +^.^|✔️ +^.^|✔️ +^.^|✔️ +|Delete a user | -^|✔️ -.4+|ReleaseStrategy -|View -^|✔️ +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|*User group:* + +View a user group -^|✔️ -^|✔️ -|Create +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create a user group | | +^.^|✔️ +^.^|✔️ -^|✔️ -|Update +|Update a user group | +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|Delete a user group | -^|✔️ +^.^|✔️ +^.^|✔️ +^.^|✔️ + +|*Custom role:* + +View a custom role -|Delete +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create a custom role | | -^|✔️ -.4+|ReleasePlanAdmission - -|View -^|✔️ -^|✔️ -^|✔️ -|Create +^.^|✔️ +^.^|✔️ +|Update a custom role | -^|✔️ -^|✔️ -|Update | +^.^|✔️ +^.^|✔️ -^|✔️ -^|✔️ -|Delete +|Delete a custom role | -^|✔️ +| +^.^|✔️ +^.^|✔️ -^|✔️ -.4+|User -|View -^|✔️ -^|✔️ -^|✔️ -|Create -| -^|✔️ -^|✔️ +|*Tenant:* -|Update +View tenant + +| | -^|✔️ -^|✔️ -|Delete +^.>|✔️ +^.>|✔️ +|Create tenant | -^|✔️ -^|✔️ -.4+|User Group -|View +| +^.>|✔️ +^.>|✔️ -^|✔️ -^|✔️ -^|✔️ -|Create +|Update tenant +| | +^.^|✔️ +^.^|✔️ +|Delete tenant | -^|✔️ -|Update | -^|✔️ +^.^|✔️ +^.^|✔️ -^|✔️ -|Delete +|*Organization:* + +View organization + +^.>|✔️ +^.>|✔️ +^.>|✔️ +^.>|✔️ + +|Create organization +| | -^|✔️ -^|✔️ +^.^|✔️ +^.^|✔️ -|=== +|Update organization +| +^.^|✔️ +^.^|✔️ +^.^|✔️ -== Additional resources +|Delete organization +| +^.^|✔️ +^.^|✔️ +^.^|✔️ -* https://placeholder.com[Managing members of a project] +|=== \ No newline at end of file From 984889c6785f4758b331aa1322ed6b5815a986f0 Mon Sep 17 00:00:00 2001 From: Chloe Date: Mon, 12 Jun 2023 12:23:26 -0400 Subject: [PATCH 2/7] Update roles and permissions page after SME feedback --- .../getting-started/roles_persmissions.adoc | 73 ++----------------- 1 file changed, 6 insertions(+), 67 deletions(-) diff --git a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc index 2bb2f721..c77a8ba4 100644 --- a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc +++ b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc @@ -1,25 +1,24 @@ = Permissions and roles -As a workspace *Owner*, you can invite collaborators to your workspace by adding a user ID such as an external SSO ID. After you add a user to a workspace, you assign a specific role to designate what actions that user can perform. - -The following list shows the roles that are available in a workspace: +The following list shows the three roles that are available in a workspace: * *Contributor*: Ideal for users who actively push to your workspace * *Maintainer*: Ideal for users who need to manage the workspace, but who don't need access to sensitive actions like managing security or deleting a workspace * *Owner*: Ideal for users who need full access to the workspace, including sensitive actions like managing security or deleting a workspace -NOTE: By default, any collaborator that you invite has the role of *Contributor*. +== Adding a user +We currently do not support adding users in the user interface (UI). To add a collaborator, you can send us a message in the https://dn.dev/DevNationSlack[DevNation workspace] in the link:https://rhdevnation.slack.com/archives/C04LXT1EU7K[#software-supply-chain-security] channel and we will process your request. -== Permissions by role +Or, send a message in the chat feature in the {ProductName} application. -The role that you assign to a user determines the permissions that the user has in the workspace. The *Owner* role assigns all permissions. +== Permissions by role The following table shows the actions that each type of collaborator can perform: .Permissions for each type of collaborator |=== -|Action |Contributor |Maintainer |Owner |Tenant Admin +|Action |Contributor |Maintainer |Owner |*Workspace:* @@ -27,25 +26,21 @@ View a workspace ^.>|✔️ ^.>|✔️ ^.>|✔️ -^.>|✔️ |Create a workspace | | ^.^|✔️ -^.^|✔️ |Update a workspace | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Delete a workspace | | ^.^|✔️ -^.^|✔️ |*Application:* @@ -53,26 +48,21 @@ View an application ^.>|✔️ ^.>|✔️ ^.>|✔️ -^.>|✔️ |Create an application | | ^.^|✔️ -^.^|✔️ |Update an application | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Delete an application | | ^.^|✔️ -^.^|✔️ - |*Component:* @@ -80,26 +70,21 @@ View a component ^.>|✔️ ^.>|✔️ ^.>|✔️ -^.>|✔️ |Create a component | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Update a component | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Delete a component | | ^.^|✔️ -^.^|✔️ - |*Environment:* @@ -108,25 +93,21 @@ View an environment ^.>|✔️ ^.>|✔️ ^.>|✔️ -^.>|✔️ |Create an environment | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Update an environment | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Delete an environment | ^.^|✔️ ^.^|✔️ -^.^|✔️ |*Pipeline run:* @@ -135,25 +116,21 @@ View pipeline run ^.>|✔️ ^.>|✔️ ^.>|✔️ -^.>|✔️ |Create pipeline run ^.^|✔️ ^.^|✔️ ^.^|✔️ -^.^|✔️ |Update pipeline run | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Delete pipeline run | ^.^|✔️ ^.^|✔️ -^.^|✔️ |*IntegrationTestScenario:* @@ -162,25 +139,21 @@ View IntegrationTestScenario ^.>|✔️ ^.>|✔️ ^.>|✔️ -^.>|✔️ |Create IntegrationTestScenario | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Update IntegrationTestScenario | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Delete IntegrationTestScenario | ^.^|✔️ ^.^|✔️ -^.^|✔️ |*Enterprise Contract:* @@ -188,25 +161,21 @@ View Enterprise Contract ^.>|✔️ ^.>|✔️ ^.>|✔️ -^.>|✔️ |Create Enterprise Contract | | | -^.^|✔️ |Update Enterprise Contract | | ^.^|✔️ -^.^|✔️ |Delete Enterprise Contract | | ^.^|✔️ -^.^|✔️ |*Release strategy:* @@ -215,25 +184,20 @@ View Release strategy ^.>|✔️ ^.>|✔️ ^.>|✔️ -^.>|✔️ |Create Release strategy | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Update Release strategy | ^.^|✔️ ^.^|✔️ -^.^|✔️ - |Delete Release strategy | ^.^|✔️ ^.^|✔️ -^.^|✔️ |*Release Admission Plan:* View Release Admission Plan @@ -241,25 +205,21 @@ View Release Admission Plan ^.>|✔️ ^.>|✔️ ^.>|✔️ -^.>|✔️ |Create Release Admission Plan | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Update Release Admission Plan | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Delete Release Admission Plan | ^.^|✔️ ^.^|✔️ -^.^|✔️ |*User:* @@ -267,25 +227,21 @@ View a user ^.>|✔️ ^.>|✔️ ^.>|✔️ -^.>|✔️ |Create a user | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Update a user | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Delete a user | ^.^|✔️ ^.^|✔️ -^.^|✔️ |*User group:* @@ -294,25 +250,21 @@ View a user group ^.>|✔️ ^.>|✔️ ^.>|✔️ -^.>|✔️ |Create a user group | | ^.^|✔️ -^.^|✔️ |Update a user group | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Delete a user group | ^.^|✔️ ^.^|✔️ -^.^|✔️ |*Custom role:* @@ -321,26 +273,21 @@ View a custom role ^.>|✔️ ^.>|✔️ ^.>|✔️ -^.>|✔️ |Create a custom role | | ^.^|✔️ -^.^|✔️ |Update a custom role | | ^.^|✔️ -^.^|✔️ |Delete a custom role | | ^.^|✔️ -^.^|✔️ - |*Tenant:* @@ -349,25 +296,21 @@ View tenant | | ^.>|✔️ -^.>|✔️ |Create tenant | | ^.>|✔️ -^.>|✔️ |Update tenant | | ^.^|✔️ -^.^|✔️ |Delete tenant | | ^.^|✔️ -^.^|✔️ |*Organization:* @@ -376,24 +319,20 @@ View organization ^.>|✔️ ^.>|✔️ ^.>|✔️ -^.>|✔️ |Create organization | | ^.^|✔️ -^.^|✔️ |Update organization | ^.^|✔️ ^.^|✔️ -^.^|✔️ |Delete organization | ^.^|✔️ ^.^|✔️ -^.^|✔️ |=== \ No newline at end of file From fada38c718442aead7d6aa815df126ff6b14b2d4 Mon Sep 17 00:00:00 2001 From: Chloe Date: Mon, 12 Jun 2023 12:38:06 -0400 Subject: [PATCH 3/7] fixes issue with check --- docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc index c77a8ba4..ce438a77 100644 --- a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc +++ b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc @@ -7,7 +7,7 @@ The following list shows the three roles that are available in a workspace: * *Owner*: Ideal for users who need full access to the workspace, including sensitive actions like managing security or deleting a workspace == Adding a user -We currently do not support adding users in the user interface (UI). To add a collaborator, you can send us a message in the https://dn.dev/DevNationSlack[DevNation workspace] in the link:https://rhdevnation.slack.com/archives/C04LXT1EU7K[#software-supply-chain-security] channel and we will process your request. +We currently do not support adding users in the user interface (UI). To add a collaborator, you can send us a Slack message in the https://rhdevnation.slack.com/archives/C04LXT1EU7K[#software-supply-chain-security] channel and we will process your request. Or, send a message in the chat feature in the {ProductName} application. From 81223e7b2c227addd6afa28817c304e4e8734192 Mon Sep 17 00:00:00 2001 From: Chloe Date: Wed, 26 Jul 2023 10:00:41 -0400 Subject: [PATCH 4/7] Edits permissions and roles page. --- .../getting-started/roles_persmissions.adoc | 42 +- styles/RedHat/Abbreviations.yml | 9 + styles/RedHat/CaseSensitiveTerms.yml | 297 +++++++++++++ styles/RedHat/Conjunctions.yml | 14 + styles/RedHat/ConsciousLanguage.yml | 14 + styles/RedHat/Contractions.yml | 44 ++ styles/RedHat/Definitions.yml | 183 ++++++++ styles/RedHat/Ellipses.yml | 12 + styles/RedHat/HeadingPunctuation.yml | 15 + styles/RedHat/Headings.yml | 245 +++++++++++ styles/RedHat/OxfordComma.yml | 8 + styles/RedHat/PascalCamelCase.yml | 178 ++++++++ styles/RedHat/PassiveVoice.yml | 186 ++++++++ styles/RedHat/README-IBM.adoc | 9 + styles/RedHat/README-proselint.md | 13 + styles/RedHat/README-write-good.md | 28 ++ styles/RedHat/ReadabilityGrade.yml | 12 + styles/RedHat/ReleaseNotes.yml | 11 + styles/RedHat/RepeatedWords.yml | 10 + styles/RedHat/SelfReferentialText.yml | 14 + styles/RedHat/SentenceLength.yml | 9 + styles/RedHat/SimpleWords.yml | 119 +++++ styles/RedHat/Slash.yml | 20 + styles/RedHat/Spacing.yml | 10 + styles/RedHat/Spelling.yml | 408 ++++++++++++++++++ styles/RedHat/TermsErrors.yml | 329 ++++++++++++++ styles/RedHat/TermsSuggestions.yml | 41 ++ styles/RedHat/TermsWarnings.yml | 22 + styles/RedHat/Usage.yml | 152 +++++++ styles/RedHat/UserReplacedValues.yml | 8 + styles/RedHat/meta.json | 4 + vale.ini | 8 + 32 files changed, 2471 insertions(+), 3 deletions(-) create mode 100644 styles/RedHat/Abbreviations.yml create mode 100644 styles/RedHat/CaseSensitiveTerms.yml create mode 100644 styles/RedHat/Conjunctions.yml create mode 100644 styles/RedHat/ConsciousLanguage.yml create mode 100644 styles/RedHat/Contractions.yml create mode 100644 styles/RedHat/Definitions.yml create mode 100644 styles/RedHat/Ellipses.yml create mode 100644 styles/RedHat/HeadingPunctuation.yml create mode 100644 styles/RedHat/Headings.yml create mode 100644 styles/RedHat/OxfordComma.yml create mode 100644 styles/RedHat/PascalCamelCase.yml create mode 100644 styles/RedHat/PassiveVoice.yml create mode 100644 styles/RedHat/README-IBM.adoc create mode 100644 styles/RedHat/README-proselint.md create mode 100644 styles/RedHat/README-write-good.md create mode 100644 styles/RedHat/ReadabilityGrade.yml create mode 100644 styles/RedHat/ReleaseNotes.yml create mode 100644 styles/RedHat/RepeatedWords.yml create mode 100644 styles/RedHat/SelfReferentialText.yml create mode 100644 styles/RedHat/SentenceLength.yml create mode 100644 styles/RedHat/SimpleWords.yml create mode 100644 styles/RedHat/Slash.yml create mode 100644 styles/RedHat/Spacing.yml create mode 100644 styles/RedHat/Spelling.yml create mode 100644 styles/RedHat/TermsErrors.yml create mode 100644 styles/RedHat/TermsSuggestions.yml create mode 100644 styles/RedHat/TermsWarnings.yml create mode 100644 styles/RedHat/Usage.yml create mode 100644 styles/RedHat/UserReplacedValues.yml create mode 100644 styles/RedHat/meta.json create mode 100644 vale.ini diff --git a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc index ce438a77..86e1f115 100644 --- a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc +++ b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc @@ -1,16 +1,52 @@ = Permissions and roles +== Getting started + +When the administrators at {ProductName} create a workspace for you, you automatically have the role of *Admin*. + +== Types of roles + The following list shows the three roles that are available in a workspace: * *Contributor*: Ideal for users who actively push to your workspace * *Maintainer*: Ideal for users who need to manage the workspace, but who don't need access to sensitive actions like managing security or deleting a workspace -* *Owner*: Ideal for users who need full access to the workspace, including sensitive actions like managing security or deleting a workspace +* *Admin*: Ideal for users who need full access to the workspace, including sensitive actions like managing security or deleting a workspace + +== Adding or changing users -== Adding a user We currently do not support adding users in the user interface (UI). To add a collaborator, you can send us a Slack message in the https://rhdevnation.slack.com/archives/C04LXT1EU7K[#software-supply-chain-security] channel and we will process your request. Or, send a message in the chat feature in the {ProductName} application. +//// + +To begin adding, editing, or removing users from a workspace, complete the following steps: +. In the side bar, select *Workspaces*. +. Select the tab *Access*. + +=== Adding a user to a workspace + +. In *Find by username*, enter the users that you want to grant access to. +* Optionally, change *Username* to the search option of your choice. +. 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: @@ -18,7 +54,7 @@ The following table shows the actions that each type of collaborator can perform .Permissions for each type of collaborator |=== -|Action |Contributor |Maintainer |Owner +|Action |Contributor |Maintainer |Admin |*Workspace:* diff --git a/styles/RedHat/Abbreviations.yml b/styles/RedHat/Abbreviations.yml new file mode 100644 index 00000000..a2eec983 --- /dev/null +++ b/styles/RedHat/Abbreviations.yml @@ -0,0 +1,9 @@ +--- +extends: existence +level: error +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/abbreviations/ +message: "Do not use periods in all-uppercase abbreviations such as '%s'." +nonword: true +source: "IBM - Periods with abbreviations, p. 5" +tokens: + - '\b(?:[A-Z]\.){3,5}' diff --git a/styles/RedHat/CaseSensitiveTerms.yml b/styles/RedHat/CaseSensitiveTerms.yml new file mode 100644 index 00000000..c03bb16e --- /dev/null +++ b/styles/RedHat/CaseSensitiveTerms.yml @@ -0,0 +1,297 @@ +--- +extends: substitution +ignorecase: false +level: error +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/casesensitiveterms/ +message: Use '%s' rather than '%s'. +source: "https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions" +action: + name: replace +swap: + "(? +Copyright © 2014–2015, Jordan Suchow, Michael Pacer, and Lara A. Ross +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/styles/RedHat/README-write-good.md b/styles/RedHat/README-write-good.md new file mode 100644 index 00000000..ba919b6f --- /dev/null +++ b/styles/RedHat/README-write-good.md @@ -0,0 +1,28 @@ + +Based on [write-good](https://github.com/btford/write-good). + +> Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too. + +``` +The MIT License (MIT) + +Copyright (c) 2014 Brian Ford + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +``` diff --git a/styles/RedHat/ReadabilityGrade.yml b/styles/RedHat/ReadabilityGrade.yml new file mode 100644 index 00000000..607cbdd7 --- /dev/null +++ b/styles/RedHat/ReadabilityGrade.yml @@ -0,0 +1,12 @@ +--- +extends: readability +grade: 21 +level: suggestion +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/readabilitygrade/ +message: "Grade level (%s) too high." +metrics: + - Automated Readability + - Coleman-Liau + - Flesch-Kincaid + - Gunning Fog + - SMOG diff --git a/styles/RedHat/ReleaseNotes.yml b/styles/RedHat/ReleaseNotes.yml new file mode 100644 index 00000000..ae56237e --- /dev/null +++ b/styles/RedHat/ReleaseNotes.yml @@ -0,0 +1,11 @@ +--- +extends: substitution +ignorecase: false +level: suggestion +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/releasenotes/ +message: "For release notes, consider using '%s' rather than '%s'." +source: "https://redhat-documentation.github.io/supplementary-style-guide/#release-notes" +# swap maps tokens in form of bad: good +swap: + Now: With this update + Previously: Before this update diff --git a/styles/RedHat/RepeatedWords.yml b/styles/RedHat/RepeatedWords.yml new file mode 100644 index 00000000..61b6577e --- /dev/null +++ b/styles/RedHat/RepeatedWords.yml @@ -0,0 +1,10 @@ +--- +extends: repetition +message: "'%s' is repeated!" +level: warning +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/repeatedwords/ +ignorecase: false +alpha: true +tokens: + - '[^\s\.]+' + - '[^\s]+' diff --git a/styles/RedHat/SelfReferentialText.yml b/styles/RedHat/SelfReferentialText.yml new file mode 100644 index 00000000..a46b57c8 --- /dev/null +++ b/styles/RedHat/SelfReferentialText.yml @@ -0,0 +1,14 @@ +--- +extends: existence +ignorecase: true +level: suggestion +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/selfreferentialtext/ +message: "Avoid using self-referential text such as '%s'." +source: "IBM - Audience and medium, p. 22" +tokens: + - this topic + - this module + - this assembly + - this chapter + - this section + - this subsection diff --git a/styles/RedHat/SentenceLength.yml b/styles/RedHat/SentenceLength.yml new file mode 100644 index 00000000..b516eef3 --- /dev/null +++ b/styles/RedHat/SentenceLength.yml @@ -0,0 +1,9 @@ +--- +extends: occurrence +level: suggestion +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/sentencelength/ +message: "Try to keep sentences to an average of 32 words or fewer." +scope: sentence +source: "IBM - Conversational style" +max: 32 +token: \b(\w+)\b diff --git a/styles/RedHat/SimpleWords.yml b/styles/RedHat/SimpleWords.yml new file mode 100644 index 00000000..4d530494 --- /dev/null +++ b/styles/RedHat/SimpleWords.yml @@ -0,0 +1,119 @@ +--- +extends: substitution +ignorecase: true +level: suggestion +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/simplewords/ +message: "Use simple language. Consider using '%s' rather than '%s'." +source: "IBM - Conversational style; http://www.plainlanguage.gov/howto/wordsuggestions/simplewords.cfm" +swap: + "approximate(?:ly)?": about + "objective(?! C?)": aim|goal + absent: none|not here + abundance: plenty + accelerate: speed up + accentuate: stress + accompany: go with + accomplish: carry out|do + accorded: given + accordingly: so + accrue: add + accurate: right|exact + acquiesce: agree + acquire: get|buy + "(?__': Separate words by underscores in user-replaced values diff --git a/styles/RedHat/meta.json b/styles/RedHat/meta.json new file mode 100644 index 00000000..6099c80b --- /dev/null +++ b/styles/RedHat/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/redhat-documentation/vale-at-red-hat/releases.atom", + "vale_version": ">=2.20.0" +} 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 From f9acffaf76ad74c25c4d97df7abd2dc88f85b627 Mon Sep 17 00:00:00 2001 From: Chloe Date: Tue, 5 Sep 2023 11:17:10 -0400 Subject: [PATCH 5/7] Edits roles and permissions doc --- .../getting-started/roles_persmissions.adoc | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc index 86e1f115..06c59c28 100644 --- a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc +++ b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc @@ -8,17 +8,11 @@ When the administrators at {ProductName} create a workspace for you, you automat The following list shows the three roles that are available in a workspace: -* *Contributor*: Ideal for users who actively push to your workspace -* *Maintainer*: Ideal 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*: Ideal for users who need full access to the workspace, including sensitive actions like managing security or deleting a workspace +* *Contributor*: for users who actively 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, including sensitive actions like managing security or deleting a workspace -== Adding or changing users - -We currently do not support adding users in the user interface (UI). To add a collaborator, you can send us a Slack message in the https://rhdevnation.slack.com/archives/C04LXT1EU7K[#software-supply-chain-security] channel and we will process your request. - -Or, send a message in the chat feature in the {ProductName} application. - -//// +== Managing users To begin adding, editing, or removing users from a workspace, complete the following steps: . In the side bar, select *Workspaces*. @@ -26,8 +20,7 @@ To begin adding, editing, or removing users from a workspace, complete the follo === Adding a user to a workspace -. In *Find by username*, enter the users that you want to grant access to. -* Optionally, change *Username* to the search option of your choice. +. In *Find by username*, enter the Red Hat Trusted Application 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*. @@ -45,8 +38,6 @@ To begin adding, editing, or removing users from a workspace, complete the follo * 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: From bd172d059a1021c3e95460846af4683e98c47444 Mon Sep 17 00:00:00 2001 From: Chloe Date: Tue, 5 Sep 2023 11:43:35 -0400 Subject: [PATCH 6/7] Tries to fix issue with PR --- .../modules/ROOT/pages/getting-started/roles_persmissions.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc index 06c59c28..25fb511f 100644 --- a/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc +++ b/docs/modules/ROOT/pages/getting-started/roles_persmissions.adoc @@ -362,4 +362,5 @@ View organization ^.^|✔️ ^.^|✔️ -|=== \ No newline at end of file +|=== + From 6d274d4401c6aa127a7e484723857738f4ac90ef Mon Sep 17 00:00:00 2001 From: Chloe Date: Thu, 7 Sep 2023 11:44:43 -0400 Subject: [PATCH 7/7] Does next round of edits and fixes a typo --- docs/.DS_Store | Bin 6148 -> 6148 bytes docs/modules/.DS_Store | Bin 6148 -> 6148 bytes .../getting-started/roles_persmissions.adoc | 129 +----- styles/RedHat/Abbreviations.yml | 9 - styles/RedHat/CaseSensitiveTerms.yml | 297 ------------- styles/RedHat/Conjunctions.yml | 14 - styles/RedHat/ConsciousLanguage.yml | 14 - styles/RedHat/Contractions.yml | 44 -- styles/RedHat/Definitions.yml | 183 -------- styles/RedHat/Ellipses.yml | 12 - styles/RedHat/HeadingPunctuation.yml | 15 - styles/RedHat/Headings.yml | 245 ----------- styles/RedHat/OxfordComma.yml | 8 - styles/RedHat/PascalCamelCase.yml | 178 -------- styles/RedHat/PassiveVoice.yml | 186 -------- styles/RedHat/README-IBM.adoc | 9 - styles/RedHat/README-proselint.md | 13 - styles/RedHat/README-write-good.md | 28 -- styles/RedHat/ReadabilityGrade.yml | 12 - styles/RedHat/ReleaseNotes.yml | 11 - styles/RedHat/RepeatedWords.yml | 10 - styles/RedHat/SelfReferentialText.yml | 14 - styles/RedHat/SentenceLength.yml | 9 - styles/RedHat/SimpleWords.yml | 119 ----- styles/RedHat/Slash.yml | 20 - styles/RedHat/Spacing.yml | 10 - styles/RedHat/Spelling.yml | 408 ------------------ styles/RedHat/TermsErrors.yml | 329 -------------- styles/RedHat/TermsSuggestions.yml | 41 -- styles/RedHat/TermsWarnings.yml | 22 - styles/RedHat/Usage.yml | 152 ------- styles/RedHat/UserReplacedValues.yml | 8 - styles/RedHat/meta.json | 4 - 33 files changed, 8 insertions(+), 2545 deletions(-) delete mode 100644 styles/RedHat/Abbreviations.yml delete mode 100644 styles/RedHat/CaseSensitiveTerms.yml delete mode 100644 styles/RedHat/Conjunctions.yml delete mode 100644 styles/RedHat/ConsciousLanguage.yml delete mode 100644 styles/RedHat/Contractions.yml delete mode 100644 styles/RedHat/Definitions.yml delete mode 100644 styles/RedHat/Ellipses.yml delete mode 100644 styles/RedHat/HeadingPunctuation.yml delete mode 100644 styles/RedHat/Headings.yml delete mode 100644 styles/RedHat/OxfordComma.yml delete mode 100644 styles/RedHat/PascalCamelCase.yml delete mode 100644 styles/RedHat/PassiveVoice.yml delete mode 100644 styles/RedHat/README-IBM.adoc delete mode 100644 styles/RedHat/README-proselint.md delete mode 100644 styles/RedHat/README-write-good.md delete mode 100644 styles/RedHat/ReadabilityGrade.yml delete mode 100644 styles/RedHat/ReleaseNotes.yml delete mode 100644 styles/RedHat/RepeatedWords.yml delete mode 100644 styles/RedHat/SelfReferentialText.yml delete mode 100644 styles/RedHat/SentenceLength.yml delete mode 100644 styles/RedHat/SimpleWords.yml delete mode 100644 styles/RedHat/Slash.yml delete mode 100644 styles/RedHat/Spacing.yml delete mode 100644 styles/RedHat/Spelling.yml delete mode 100644 styles/RedHat/TermsErrors.yml delete mode 100644 styles/RedHat/TermsSuggestions.yml delete mode 100644 styles/RedHat/TermsWarnings.yml delete mode 100644 styles/RedHat/Usage.yml delete mode 100644 styles/RedHat/UserReplacedValues.yml delete mode 100644 styles/RedHat/meta.json diff --git a/docs/.DS_Store b/docs/.DS_Store index a12e18b75a53bef79e6082f2e97c6ae9f2576e33..76b8cd978474764a5f0ea996d0bb30c17cd3858f 100644 GIT binary patch delta 24 fcmZoMXffC@hl!P)lbxG=@xGhRTVy4u*nQb)nWz|✔️ -^.>|✔️ -^.>|✔️ - -|Create a workspace -| -| -^.^|✔️ - -|Update a workspace -| -^.^|✔️ -^.^|✔️ - -|Delete a workspace -| -| -^.^|✔️ - |*Application:* View an application @@ -255,7 +234,7 @@ View a user ^.>|✔️ ^.>|✔️ -|Create a user +|Add a user to a workspace | ^.^|✔️ ^.^|✔️ @@ -265,99 +244,7 @@ View a user ^.^|✔️ ^.^|✔️ -|Delete a user -| -^.^|✔️ -^.^|✔️ - -|*User group:* - -View a user group - -^.>|✔️ -^.>|✔️ -^.>|✔️ - -|Create a user group -| -| -^.^|✔️ - -|Update a user group -| -^.^|✔️ -^.^|✔️ - -|Delete a user group -| -^.^|✔️ -^.^|✔️ - -|*Custom role:* - -View a custom role - -^.>|✔️ -^.>|✔️ -^.>|✔️ - -|Create a custom role -| -| -^.^|✔️ - -|Update a custom role -| -| -^.^|✔️ - -|Delete a custom role -| -| -^.^|✔️ - -|*Tenant:* - -View tenant - -| -| -^.>|✔️ - -|Create tenant -| -| -^.>|✔️ - -|Update tenant -| -| -^.^|✔️ - -|Delete tenant -| -| -^.^|✔️ - -|*Organization:* - -View organization - -^.>|✔️ -^.>|✔️ -^.>|✔️ - -|Create organization -| -| -^.^|✔️ - -|Update organization -| -^.^|✔️ -^.^|✔️ - -|Delete organization +|Delete a user from a workspace | ^.^|✔️ ^.^|✔️ diff --git a/styles/RedHat/Abbreviations.yml b/styles/RedHat/Abbreviations.yml deleted file mode 100644 index a2eec983..00000000 --- a/styles/RedHat/Abbreviations.yml +++ /dev/null @@ -1,9 +0,0 @@ ---- -extends: existence -level: error -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/abbreviations/ -message: "Do not use periods in all-uppercase abbreviations such as '%s'." -nonword: true -source: "IBM - Periods with abbreviations, p. 5" -tokens: - - '\b(?:[A-Z]\.){3,5}' diff --git a/styles/RedHat/CaseSensitiveTerms.yml b/styles/RedHat/CaseSensitiveTerms.yml deleted file mode 100644 index c03bb16e..00000000 --- a/styles/RedHat/CaseSensitiveTerms.yml +++ /dev/null @@ -1,297 +0,0 @@ ---- -extends: substitution -ignorecase: false -level: error -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/casesensitiveterms/ -message: Use '%s' rather than '%s'. -source: "https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions" -action: - name: replace -swap: - "(? -Copyright © 2014–2015, Jordan Suchow, Michael Pacer, and Lara A. Ross -All rights reserved. - -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - -2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - -3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/styles/RedHat/README-write-good.md b/styles/RedHat/README-write-good.md deleted file mode 100644 index ba919b6f..00000000 --- a/styles/RedHat/README-write-good.md +++ /dev/null @@ -1,28 +0,0 @@ - -Based on [write-good](https://github.com/btford/write-good). - -> Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too. - -``` -The MIT License (MIT) - -Copyright (c) 2014 Brian Ford - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. -``` diff --git a/styles/RedHat/ReadabilityGrade.yml b/styles/RedHat/ReadabilityGrade.yml deleted file mode 100644 index 607cbdd7..00000000 --- a/styles/RedHat/ReadabilityGrade.yml +++ /dev/null @@ -1,12 +0,0 @@ ---- -extends: readability -grade: 21 -level: suggestion -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/readabilitygrade/ -message: "Grade level (%s) too high." -metrics: - - Automated Readability - - Coleman-Liau - - Flesch-Kincaid - - Gunning Fog - - SMOG diff --git a/styles/RedHat/ReleaseNotes.yml b/styles/RedHat/ReleaseNotes.yml deleted file mode 100644 index ae56237e..00000000 --- a/styles/RedHat/ReleaseNotes.yml +++ /dev/null @@ -1,11 +0,0 @@ ---- -extends: substitution -ignorecase: false -level: suggestion -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/releasenotes/ -message: "For release notes, consider using '%s' rather than '%s'." -source: "https://redhat-documentation.github.io/supplementary-style-guide/#release-notes" -# swap maps tokens in form of bad: good -swap: - Now: With this update - Previously: Before this update diff --git a/styles/RedHat/RepeatedWords.yml b/styles/RedHat/RepeatedWords.yml deleted file mode 100644 index 61b6577e..00000000 --- a/styles/RedHat/RepeatedWords.yml +++ /dev/null @@ -1,10 +0,0 @@ ---- -extends: repetition -message: "'%s' is repeated!" -level: warning -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/repeatedwords/ -ignorecase: false -alpha: true -tokens: - - '[^\s\.]+' - - '[^\s]+' diff --git a/styles/RedHat/SelfReferentialText.yml b/styles/RedHat/SelfReferentialText.yml deleted file mode 100644 index a46b57c8..00000000 --- a/styles/RedHat/SelfReferentialText.yml +++ /dev/null @@ -1,14 +0,0 @@ ---- -extends: existence -ignorecase: true -level: suggestion -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/selfreferentialtext/ -message: "Avoid using self-referential text such as '%s'." -source: "IBM - Audience and medium, p. 22" -tokens: - - this topic - - this module - - this assembly - - this chapter - - this section - - this subsection diff --git a/styles/RedHat/SentenceLength.yml b/styles/RedHat/SentenceLength.yml deleted file mode 100644 index b516eef3..00000000 --- a/styles/RedHat/SentenceLength.yml +++ /dev/null @@ -1,9 +0,0 @@ ---- -extends: occurrence -level: suggestion -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/sentencelength/ -message: "Try to keep sentences to an average of 32 words or fewer." -scope: sentence -source: "IBM - Conversational style" -max: 32 -token: \b(\w+)\b diff --git a/styles/RedHat/SimpleWords.yml b/styles/RedHat/SimpleWords.yml deleted file mode 100644 index 4d530494..00000000 --- a/styles/RedHat/SimpleWords.yml +++ /dev/null @@ -1,119 +0,0 @@ ---- -extends: substitution -ignorecase: true -level: suggestion -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/simplewords/ -message: "Use simple language. Consider using '%s' rather than '%s'." -source: "IBM - Conversational style; http://www.plainlanguage.gov/howto/wordsuggestions/simplewords.cfm" -swap: - "approximate(?:ly)?": about - "objective(?! C?)": aim|goal - absent: none|not here - abundance: plenty - accelerate: speed up - accentuate: stress - accompany: go with - accomplish: carry out|do - accorded: given - accordingly: so - accrue: add - accurate: right|exact - acquiesce: agree - acquire: get|buy - "(?__': Separate words by underscores in user-replaced values diff --git a/styles/RedHat/meta.json b/styles/RedHat/meta.json deleted file mode 100644 index 6099c80b..00000000 --- a/styles/RedHat/meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "feed": "https://github.com/redhat-documentation/vale-at-red-hat/releases.atom", - "vale_version": ">=2.20.0" -}