Skip to content

Typos - Manage roles, permissions, and authentication section#10350

Open
benNew89 wants to merge 18 commits into
mainfrom
ben/typos-permissions-authentication-section
Open

Typos - Manage roles, permissions, and authentication section#10350
benNew89 wants to merge 18 commits into
mainfrom
ben/typos-permissions-authentication-section

Conversation

@benNew89
Copy link
Copy Markdown
Contributor

SPG review: Manage roles, permissions, and authentication section

This PR addresses spelling, punctuation, and grammar issues found across the pages in the "Manage roles, permissions, and authentication" section of the CircleCI docs, plus two related how-to guide pages.


users-organizations-and-integrations-guide.adoc

  • "can not" → "cannot": In the User accounts section, "These methods can not be used together" was corrected to "These methods cannot be used together", which is the standard single-word form for this negation in formal writing.

  • Stray period before "and" in GitLab SaaS Disconnect section: "You can delete projects that are connected to GitLab. and delete the CircleCI webhooks..." contained a period followed by a lowercase "and", creating a sentence fragment. The period was removed so the sentence reads correctly as a single clause.

  • "CirlceCI" typo: In the note within migration step 4, "CirlceCI" was corrected to "CircleCI".

  • "THen" capitalisation error: In the Create a user key section, "THen add that machine user's key to CircleCI" was corrected to "Then".

  • "For example ," stray space: In the Controlling access via a machine user section, "For example , a machine user..." contained a space before the comma. The space was removed.


manage-email-addresses.adoc

  • "one time code" → "one-time code": In step 5 of Change your email address, "one time code" was hyphenated to "one-time code" as it is a compound modifier preceding a noun.

  • Missing Oxford comma: In the same step, "Enter your new email address, your password and your one-time code" was missing a comma before "and". Corrected to "Enter your new email address, your password, and your one-time code."

  • Capitalisation of "Select" mid-sentence in partial: In the steps-to-user-settings.adoc partial, "Select" appeared capitalised mid-sentence after a comma. Corrected to lowercase "select".


roles-and-permissions-overview.adoc

  • "orgnization" typo in :page-description:: The page description attribute read "An overview of the various project and orgnization roles in CircleCI..." — "orgnization" was corrected to "organization". Although not visible to readers on the page itself, this appears in search engine results and browser metadata.

manage-roles-and-permissions.adoc

  • Missing space between sentences: In the intro paragraph, the sentence ending with the "Groups" link ran directly into the next sentence with no space: "...with xref:manage-groups.adoc[Groups].For an overview..." — a space was added after the period.

  • Missing period at end of final step: In the "Remove people from your project" section, step 5 ("Select the ellipsis (...) button next to their name and select btn:[Remove project role]") was missing a terminal period. A full stop was added.


manage-groups.adoc

  • Missing terminal periods on all numbered steps: None of the numbered steps across any of the six sections (Create a group, Add people to a group, Add a group to a project, Assign a new project role to a group, Delete a group, Remove a user from a group) ended with a period. Periods were added to all steps for consistency with the rest of the section.

  • "on one session" → "in one go": In "Add people to a group", step 5, "You can select multiple users on one session" used awkward phrasing. Corrected to "You can select multiple users in one go."

  • Inconsistent verb in step 2 of "Add a group to a project": The step read "Click on the ellipsis...and then click Project Settings", while the equivalent step in "Assign a new project role to a group" used "select". The first instance was updated to "select" for consistency.


prevent-unregistered-users-from-spending-credits.adoc

  • "CircleCI track" → "CircleCI tracks": In the second paragraph, "Unregistered users are how CircleCI track users who have triggered builds..." contained a subject-verb agreement error. "CircleCI" is a singular noun and requires "tracks".

  • Redundant "option" after button name: Step 3 read "Select Prevent unregistered user spend option to switch it to 'On'." The word "option" is redundant as the instruction is clear without it, and the UI element is actually a toggle rather than an option. The step was rewritten as "Click on the Prevent unregistered user spend toggle to switch it 'On'."

  • Missing comma in step 2: "If you do not see this option you might be on the Free Plan..." was missing a comma after "option". Corrected to "If you do not see this option, you might be on the Free Plan..."

  • "how to guide" → "how-to guide" in :page-description:: The page description read "A how to guide to configuring your org..." — "how-to" requires a hyphen as a compound modifier preceding "guide".

  • Missing period at end of :page-description:: The page description was missing a terminal full stop.


sso-overview.adoc

  • "centralising" → "centralizing": In the Benefits of using SSO section, "centralising common tasks" used British English spelling. Corrected to American English "centralizing" for consistency with the rest of the docs.

  • Missing commas around "like GitHub and Bitbucket": The same sentence, "SSO requires all users to log into CircleCI either with an email and password or using social logins like GitHub and Bitbucket prior to the SSO login", was updated to add commas around the parenthetical examples: "...social logins, like GitHub and Bitbucket, prior to the SSO login."

  • "Setup SAML SSO" → "Set up SAML SSO" in Next steps: "Setup" is a noun; the verb form "set up" (two words) is required here.


set-up-sso.adoc

  • H2 heading "Setup SAML SSO" → "Set up SAML SSO": As above, "setup" is the noun form. The heading and its anchor were updated to use the verb form "Set up".

  • Missing period at end of note in step 5: The note "Once your DNS is successfully updated, your SSO connection will be marked as Connected, not enforced" was missing a terminal period.

  • Missing space before link in final paragraph: "...by following the steps outlined on the[Manage Roles and Permissions]..." was missing a space before the opening bracket of the link. Corrected to "...on the [Manage Roles and Permissions]..."

  • Missing period after "Connected, enforced" in step 6: "Your SSO connection will now be marked as Connected, enforced" was missing a terminal period.

  • Missing # in [stop-enforcing-sso] anchor: The anchor was written as [stop-enforcing-sso] rather than [#stop-enforcing-sso]. Without the #, AsciiDoc does not recognise the block as an anchor definition, causing any cross-references pointing to this section to produce broken links, sending users to the top of the page instead.

  • Missing # in [delete-connection] anchor: Same issue as above — corrected to [#delete-connection].

  • Double space before xref in step 6, third bullet: "See the xref:sign-in-to-an-sso-enabled-organization.adoc..." contained two spaces before the xref. The extra space was removed.

  • "Setup SSO" button label in step 4: The button label referenced in step 4 of Access Setup Parameters was corrected from "Setup SSO" to "Set up SSO" to accurately reflect the label shown in the UI.


sign-in-to-an-sso-enabled-organization.adoc

  • Missing # in [join-an-organization] anchor: Corrected to [#join-an-organization]. Without the #, cross-references to this anchor would produce broken links, sending users to the top of the page rather than the intended section.

  • Missing # in [log-in-to-an-organization] anchor: Same issue — corrected to [#log-in-to-an-organization].


mfa.adoc

  • Missing space before "section" in step 3 of MFA recovery codes: "in the Multi-factor authenticationsection" was missing a space between the bold text and the word "section". Corrected to "in the Multi-factor authentication section".

  • Redundant "then" in "Once...then" constructions (×2): In the Using MFA section, "Once you have MFA enabled, then you must provide..." and "once you have configured MFA...then you must use..." both used the redundant "then" after "once". The word "then" was removed in both instances, as "once" already establishes the temporal relationship.


openid-connect-tokens.adoc

  • Broken list formatting for AWS identity provider setup: In the "Set up identity provider in AWS" section, the "OpenIDProvider URL" and "Audience" items were written as ** nested list items directly under a paragraph rather than as a proper standalone list. This caused incorrect rendering in the web UI. The items were converted to a * unordered list preceded by a blank line.

  • "OpenIDProvider URL" → "OpenID Provider URL": The label was missing a space between "OpenID" and "Provider". Corrected to "OpenID Provider URL".


pull-an-image-from-aws-ecr-with-oidc.adoc

  • Inconsistent placeholder naming: Step 2 referred to the placeholder as YOUR_ECR_REPO_ARN in the prose ("you will need to substitute YOUR_ECR_REPO_ARN") but the code block used <YOUR-ECR-REPO-ARN>. The prose was updated to match the code block placeholder format for consistency.

authorize-google-cloud-sdk.adoc

  • Unmatched parenthesis in Introduction: "Google Cloud Platform (GCP) services like Google Compute Engine) and Google Kubernetes Engine (GKE)" contained a closing parenthesis after "Google Compute Engine" with no matching opening parenthesis. The stray ) was removed, giving "like Google Compute Engine and Google Kubernetes Engine (GKE)."

  • Redundant phrasing in step 4: The original text read "Before executing this command, make sure to write the key to a file before running this command, otherwise the key file will be interpreted as a .p12 file." This repeated the "before...this command" framing twice. The sentence was rewritten as "Before executing this command, make sure to write the key to a file, otherwise the key file will be interpreted as a .p12 file."


Items noted for further consideration

The following items were identified during review but require content decisions rather than straightforward SPG fixes:

Page Issue
users-organizations-and-integrations-guide.adoc Two bullet points in the Bitbucket Cloud checkout section reference "GitHub" — may be intentional if deploy keys are always GitHub-specific in this context
users-organizations-and-integrations-guide.adoc Two near-duplicate H2 headings for "Built-in environment variables and pipeline values" appear in the page — similar content with slightly different wording; may warrant consolidation
set-up-sso.adoc Subheading "Access Setup Parameters in CircleCI" uses title case, inconsistent with the other subheadings on the page which use sentence case
sso-overview.adoc The section anchor [#prerequisites-and-limitations] and the note at the top of the page both reference "Prerequisites and Limitations", but the actual section heading reads only "Limitations" — the heading, anchor, and note reference should be aligned
manage-groups.adoc "click"/"click on" is used throughout rather than "select" — whether to standardise depends on the docs style guide preference
manage-groups.adoc "You can select multiple users on one session" — the phrase "on one session" is awkward; consider "in one go" or removing entirely

@benNew89 benNew89 requested review from a team as code owners May 18, 2026 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant