Skip to content

add more information for google workspace - #1411

Open
ivan-zamkovyi-nwx wants to merge 2 commits into
devfrom
feature/drm-165
Open

add more information for google workspace#1411
ivan-zamkovyi-nwx wants to merge 2 commits into
devfrom
feature/drm-165

Conversation

@ivan-zamkovyi-nwx

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/directorymanager/11.1/admincenter/identitystore/create.md

  • Clarity — Line 184: "Ensure that next APIs are enabled" — "next" is not the right word for introducing a list, and the sentence is missing an article. Suggested fix: "Ensure that the following APIs are enabled for your service account in Google Cloud Console:"
  • Clarity — Line 192: "Ensure that next scope is added" has the same "next" problem, plus a singular/plural mismatch — eight scopes follow. Suggested fix: "Ensure that the following scopes are added for your service account in the Google Admin console:"
  • Clarity — Line 192: "Google Workspace Admin panel" is not the product name. The delegation settings live in the Google Admin console (admin.google.com), under Security > Access and data control > API controls > Domain-wide delegation. A reader searching for an "Admin panel" won't find one. Suggested fix: "...added for your service account in the Google Admin console, under Security > Access and data control > API controls > Domain-wide delegation."
  • Clarity — Line 186: "Cloud Identity (cloudidentity.googleapis.com)" drops the "API" suffix carried by the two sibling entries, and doesn't match the name shown in the Google Cloud Console API library. Suggested fix: "Cloud Identity API (cloudidentity.googleapis.com)"
  • Clarity — Lines 184 and 192: "Service Account" is capitalized mid-sentence, but line 188 uses lowercase "service account" for the same thing, and the rest of the file reserves capitalization for UI labels (the Service Account box in Step 5). Suggested fix: use lowercase "service account" in prose in both places.
  • Clarity — Lines 194–201: The bare URLs render as clickable autolinks, which signals to the reader that these are pages to visit. They're OAuth scope identifiers to be copied into a form, and clicking them returns an error. Suggested fix: wrap each in backticks — `https://www.googleapis.com/auth/admin.directory.group` — and so on for all eight.
  • Structure — Lines 188–193: A four-sentence conceptual explanation of domain-wide delegation is embedded inside a bullet that also carries an instruction, so the actionable part ("Ensure that...") is buried at the end of a paragraph. Suggested fix: move the explanation to an intro paragraph directly under the H3, and reduce the bullet to the action alone: "- Ensure that the following scopes are added for your service account in the Google Admin console:"
  • Structure — Line 182: "Required Google Cloud / Workspace setup" uses a spaced slash and sentence case, while every other heading in this file is title case and spells out both product names. Suggested fix: "Google Cloud and Google Workspace Prerequisites"
  • Structure — Line 203: "Create Identity Store" drops the article used in the sibling H2 headings ("Create an Identity Store for Generic LDAP"). Suggested fix: "Create the Identity Store"
  • Structure — Line 182: The Active Directory and Microsoft Entra ID sections keep their permission and setup requirements in dedicated topics under /docs/directorymanager/11.1/requirements/permissions/ and link to them from the relevant step. Google Workspace is now the only provider with inline prerequisites, so a reader who learned the pattern from the earlier sections won't expect to find them here. Suggested fix: either move this content to a requirements topic and link to it from Step 5, or add a one-line pointer from the requirements section so both entry points work.
  • Completeness — Line 184: The reader is told which APIs to enable but not how or where. Suggested fix: add a sentence naming the location and linking out — "Enable each API in the same Google Cloud project that contains the service account. See Enable and disable APIs."
  • Completeness — Lines 192–201: The delegation entry is keyed by the service account's OAuth 2.0 client ID, and the Admin console expects all scopes pasted as a single comma-separated list — neither is mentioned, so a reader following these instructions will stall at the Add new dialog. Suggested fix: add "Enter the service account's OAuth 2.0 client ID (found on the service account's Details tab in Google Cloud Console), then paste the scopes as a single comma-separated list."
  • Completeness — Line 192: The section doesn't say what a missing scope looks like from the product side, so a reader troubleshooting a failure has no way to trace it back here. Suggested fix: add a note — ":::note If a scope is missing, Directory Manager can create the identity store but the affected group or identity operations fail with authorization errors. :::"
  • Completeness — Line 182: The prerequisites cover APIs and scopes but not the two other things the procedure later assumes already exist: the service account itself (Step 5) and the downloaded P12 key file (Step 8). Suggested fix: add a leading bullet — "Create a service account in Google Cloud Console and download its P12 key file to the Directory Manager machine." — so the prerequisites match what the steps require.

Summary

14 editorial suggestions across 1 file. Vale and Dale issues are auto-fixed separately.


What to do next:

Comment @claude on this PR followed by your instructions to get help:

  • @claude fix all issues — fix all editorial issues
  • @claude help improve the flow of this document — get writing assistance
  • @claude explain the voice issues — understand why something was flagged

You can ask Claude anything about the review or about Netwrix writing standards.

Automated fixes are only available for branches in this repository, not forks.

@github-actions

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

28 issues fixed, 5 skipped across 1 files

Category Fixes
Contractions 1
Substitutions 7
FollowTheStepsTo (rewrite) 2
Dale: idioms 1
Dale: misplaced-modifiers 1
Dale: passive-voice 13
Dale: wordiness 3
Skipped (needs manual review) Reason

| docs/directorymanager/11.1/admincenter/identitystore/create.md:51 — Dale: passive-voice | 'ensure the gMSA is configured properly and has sufficient permissions' — the actor is ambiguous (the reader, another administrator, or an existing configuration), so an active rewrite would assign responsibility the source does not state. |
| docs/directorymanager/11.1/admincenter/identitystore/create.md:103 — Dale: passive-voice | 'the application ID assigned to the Directory Manager application when you registered it' — reduced relative clause with an unstated actor (Microsoft Entra); rewriting would assert an actor not given in the source. |
| docs/directorymanager/11.1/admincenter/identitystore/create.md:107 — Dale: passive-voice | 'the client secret value generated against the certificate uploaded to Microsoft Entra Admin Center' — two stacked reduced relative clauses with unstated actors; an active rewrite risks changing which action the reader performed. |
| docs/directorymanager/11.1/admincenter/identitystore/create.md:210 — Dale: passive-voice | 'the service account name assigned to you when you created your Google Workspace account' — the assigning actor (Google) is not stated in the source. |
| docs/directorymanager/11.1/admincenter/identitystore/create.md:218 — Dale: passive-voice | 'the API key generated for your account in Google Workspace' — unstated actor; rewriting would add information not in the source. |

Ask @claude on this PR if you'd like an explanation of any fix.

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.

2 participants