Skip to content

update documentation for power automate#814

Open
ivan-zamkovyi-nwx wants to merge 6 commits into
devfrom
feature/420908-power-automate
Open

update documentation for power automate#814
ivan-zamkovyi-nwx wants to merge 6 commits into
devfrom
feature/420908-power-automate

Conversation

@ivan-zamkovyi-nwx

Copy link
Copy Markdown
Contributor

No description provided.

@github-actions

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

8 issues fixed, 3 skipped across 1 files

Category Fixes
Contractions 2
Substitutions 1
Dale: passive-voice 4
Dale: wordiness 1
Skipped (needs manual review) Reason

| docs/directorymanager/11.1/admincenter/workflow/integrate.md:28 — Dale: passive-voice | actor is ambiguous — 'is approved' could be a human approver or system; fixing risks changing meaning |
| docs/directorymanager/11.1/admincenter/workflow/integrate.md:37 — Dale: passive-voice | 'is deployed' describes a required infrastructure state in a pre-step; rewriting to active voice would require specifying an actor that may not be the reader |
| docs/directorymanager/11.1/admincenter/workflow/integrate.md:65 — Dale: passive-voice | participial 'assigned to' in a field description list; fix would produce awkward phrasing without clear improvement |

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

@renata-tyburczy-nwx renata-tyburczy-nwx left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ivan, pls review documentation again and update if necessary

@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/directorymanager/11.1/admincenter/workflow/integrate.md

  • Structure — Lines 96–101: Step numbering is broken. After step 6 ("Click Create Template"), the next step jumps to "8." Suggested fix: renumber so the sequence runs 6, 7, 8… without gaps. Confirm whether one step was deleted (then keep the gap closed) or accidentally skipped.
  • Structure — Line 34: The new "Before you begin" section sits as an ### peer of "Connect an Identity Store to Power Automate" rather than as a prerequisite block for the whole "Trigger a Flow from Directory Manager" procedure. Suggested fix: either promote it to appear directly under the ## Trigger a Flow from Directory Manager heading (before the sub-procedures), or nest it inside "Connect an Identity Store to Power Automate" as its prerequisites. As currently placed, a reader scanning the table of contents may miss it.
  • Structure — Line 108: The connections_area.webp image is now orphaned between substeps 2 and 3, outside any numbered step. It also no longer matches the surrounding text, which has been changed from "Expand the Connections area" to "Expand the Manual area". Suggested fix: attach the image to the specific step it illustrates (indented under that step), and confirm the image still depicts the correct UI region after the workflow change.
  • Clarity — Line 67: "Reverse Proxy" is introduced without prior definition or explanation in the document. Suggested fix: add a brief explanation of what the reverse proxy is, who deploys it, and why it sits between Power Automate and the Data service — for example, "Power Automate connects to a reverse proxy you deploy in front of the Directory Manager Data service."
  • Clarity — Line 67: "Requests from Power Automate will communicate with the Reverse Proxy which will redirect request to Data service endpoint" has a grammatical slip ("redirect request") and uses future tense. Suggested fix: "Power Automate sends requests to the reverse proxy, which forwards them to the Data service endpoint."
  • Clarity — Line 69: "The URL is as: https://<proxy-host>:<proxy-port>" reads awkwardly. Suggested fix: "Use the format https://<proxy-host>:<proxy-port>. For example: https://powerautomate-proxy:5555."
  • Clarity — Line 66: "the client secret value to the Directory Manager application" uses the wrong preposition. Suggested fix: "the client secret value for the Directory Manager application".
  • Clarity — Line 110: "Expand the Manual area and set Who can trigger the flow." does not state what value to set. Suggested fix: specify the value or range of allowed values — e.g., "set Who can trigger the flow to Anyone."
  • Clarity — Line 111: "set up a new connection field" is vague — "connection field" is not a standard Power Automate term. Suggested fix: clarify whether the reader is creating a new connection (and to what service) — e.g., "create a new connection by signing in with your Microsoft account when prompted."
  • Clarity — Line 112: "Navigate back to the Edit window. Expand the Manual area..." appears to ask the reader to expand the same Manual area they expanded in substep 3. Suggested fix: confirm whether this is a re-expansion after navigating away, or a different control. If the same area, restate as "Return to the Manual area" so the reader does not think they missed a step.
  • Completeness — Lines 67–69: The new "Proxy Callback URL" field is introduced, but the document does not explain why a reverse proxy is now part of the deployment, how it relates to the previously documented Data Service URL (which has been removed), or whether the reader must deploy one to use this integration. Suggested fix: add a short paragraph above the field list — or in the "Before you begin" section — describing the role of the reverse proxy and any deployment prerequisites.
  • Completeness — Line 36: "Check the SSL certificate for the Directory Manager server and ensure it is valid" does not tell the reader how to check or what counts as valid (trusted CA, not expired, matches hostname, etc.). Suggested fix: name the criteria — "Verify the SSL certificate is issued by a trusted certificate authority, has not expired, and matches the server hostname."
  • Completeness — Line 117: "Close the Power Automate Settings dialog box." replaces the previous "Click Authenticate and then Save." Suggested fix: confirm and state explicitly whether closing the dialog persists the URL, or whether a separate save action is required before closing.

Summary

13 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

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

3 issues fixed, 2 skipped across 1 files

Category Fixes
Dale: passive-voice 3
Skipped (needs manual review) Reason

| docs/directorymanager/11.1/admincenter/workflow/integrate.md:37 — Dale: passive-voice | 'Ensure the Directory Manager server is deployed on a machine that is exposed over the Internet' uses stative/adjectival 'deployed' and 'exposed'; rewriting risks changing verification intent of 'Ensure' or shifting meaning |
| docs/directorymanager/11.1/admincenter/workflow/integrate.md:39 — Dale: passive-voice | 'a server deployed on a machine behind NAT' uses 'deployed' as adjectival participle describing state; ambiguous whether removal preserves meaning |

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.

3 participants