Skip to content

update documentation for power automate - #814

Merged
ivan-zamkovyi-nwx merged 16 commits into
devfrom
feature/420908-power-automate
Jul 21, 2026
Merged

update documentation for power automate#814
ivan-zamkovyi-nwx merged 16 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

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.

@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

⚠️ Broken Anchor Links

1 broken anchor link(s) found — these will cause the build to fail.

  docs/directorymanager/11.1/admincenter/workflow/implement.md:191
    [Trigger a Flow from Directory Manager ](integrate.md#trigger-a-flow-from-directory-manager) topic.
    docs/directorymanager/11.1/admincenter/workflow/integrate.md not found

Auto-Fix Summary

39 issues fixed, 4 skipped across 5 files

Category Fixes
Contractions 11
Plurals 13
Substitutions 9
AllowsYouTo (rewrite) 1
DesiredAsAdjective (rewrite) 1
Dale: passive-voice 3
Dale: wordiness 1
Skipped (needs manual review) Reason

| docs/directorymanager/11.1/admincenter/workflow/advancedsettings.md:81 — Dale: passive-voice | 'will be auto deleted' has no clear singular actor in context and the surrounding '30 days old and older' phrasing makes an active rewrite risk altering meaning. |
| docs/directorymanager/11.1/admincenter/workflow/implement.md:114 — Dale: passive-voice | 'The Add Approvers dialog box is displayed' is a conventional UI-result passive with no clear actor; rewriting risks changing meaning. |
| docs/directorymanager/11.1/admincenter/workflow/implement.md:95 — Dale: passive-voice | 'the approver is redirected and auto-authenticated' — conventional automatic-behavior passive; active rewrite is ambiguous and not clearly an improvement. |
| docs/directorymanager/11.1/admincenter/workflow/powerautomate/installproxy.md:135 — Dale: xy-slop | 'contains only the leaf certificate, not the full chain' is a clarifying, meaningful contrast rather than the 'x is not y, x is z' rhetorical pattern. |

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

@dave-miles65 dave-miles65 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Approved.

dave-miles65
dave-miles65 previously approved these changes Jul 21, 2026

@dave-miles65 dave-miles65 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Approved

@github-actions

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

10 issues fixed, 4 skipped across 5 files

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

| docs/directorymanager/11.1/admincenter/workflow/implement.md:15 — Dale: passive-voice | 'an approval request is triggered' — the active subject is ambiguous (the attribute change vs. the workflow vs. Directory Manager); rewriting risks changing meaning |
| docs/directorymanager/11.1/admincenter/workflow/implement.md:36 — Dale: passive-voice | 'a workflow request is sent ... Changes are applied after the request is approved' — conceptual example prose; converting the chained passives would require multiple structural changes that risk altering meaning |
| docs/directorymanager/11.1/admincenter/workflow/implement.md:60 — Dale: passive-voice | 'workflows that are defined by default/by users' in a definition table cell; rewrite would change the definitional phrasing |
| docs/directorymanager/11.1/admincenter/workflow/integrate.md:1 — Dale: n/a | File listed in changed-files.txt does not exist on disk (only powerautomate/integrate.md exists) |

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

@thegrahamking thegrahamking left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Some guidance may lead customers to open NDM DataService (and so NDM as a whole, because it all runs on the same host and port, except the proxy) to the internet. We don't want that.

Some guidance still references to a proxy zip package, which has been removed. Binaries are shipped within the proxy installer.

Comment thread docs/directorymanager/11.1/admincenter/workflow/powerautomate/installproxy.md Outdated
Comment thread docs/directorymanager/11.1/admincenter/workflow/powerautomate/installproxy.md Outdated
Comment thread docs/directorymanager/11.1/admincenter/workflow/powerautomate/installproxy.md Outdated
Comment thread docs/directorymanager/11.1/admincenter/workflow/powerautomate/installproxy.md Outdated
Comment thread docs/directorymanager/11.1/admincenter/workflow/powerautomate/installproxy.md Outdated
Comment thread docs/directorymanager/11.1/admincenter/workflow/powerautomate/installproxy.md Outdated
Comment thread docs/directorymanager/11.1/admincenter/workflow/powerautomate/integrate.md Outdated
@github-actions

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

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

  • No issues found. (Added lines are active-voice/contraction rewrites and an updated cross-reference to the new powerautomate/integrate.md path — both correct.)

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

  • No issues found. (Added lines are terminology/active-voice rewrites — "checkbox", "dropdown", removal of "(s)" plurals — and updated links to powerautomate/integrate.md, all consistent with the surrounding content.)

docs/directorymanager/11.1/admincenter/workflow/powerautomate/installproxy.md

  • Structure — Line 7: The H1 "Power Automate Reverse Proxy — Installation Guide" doesn't match the frontmatter title ("Install Reverse Proxy for Power Automate") and isn't phrased as an imperative task heading like the rest of the workflow section. A reader landing here sees two different names for the same page. Suggested fix: align the H1 with the sidebar title, e.g. "# Install the Power Automate Reverse Proxy".
  • Completeness — Line 111: The publish-directory path references GroupID 11.0, but this page lives under the Directory Manager 11.1 documentation. If the install path differs for 11.1, a reader following the manual-cleanup steps will look in the wrong folder. Suggested fix: verify the version segment and correct it to the 11.1 path (or confirm the product still installs under GroupID 11.0).
  • Clarity — Line 30: "A TCP port that is reachable from the internet and not used by another service, including NDM e.g. 4443" is hard to parse — the example value runs into the clause with no punctuation. Suggested fix: "A TCP port that is reachable from the internet and not used by another service, including NDM (for example, 4443)".

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

  • Structure — Line 34: The subsection heading "Before you begin" is sentence case, while its sibling H3 headings ("Connect an Identity Store to Power Automate", "Link an Identity Store Workflow to a Flow") use title case. A reader scanning the section sees inconsistent heading style. Suggested fix: "Before You Begin".
  • Completeness — Line 102: "Expand the Manual area and set Who can trigger the flow." does not tell the reader which value to select, so the step can't be completed as written. Suggested fix: specify the option to choose, e.g. "…and set Who can trigger the flow to Anyone" (or the correct value for this integration).
  • Clarity — Line 68: "Client Secret - the client secret value to the Directory Manager application when you registered it" — "value to the application" is grammatically off and breaks the parallel wording of the sibling bullets, which all read "assigned to the Directory Manager application". Suggested fix: "the client secret value assigned to the Directory Manager application when you registered it in Microsoft Entra Admin Center".
  • Clarity — Line 11: In "Trigger a flow from Directory Manager", the bold spans only "Trigger a flow from" and stops mid-phrase, leaving "Directory Manager" unbolded. The emphasis reads as a broken label rather than a defined term. Suggested fix: bold the full label — "Trigger a flow from Directory Manager" — and follow it with the description.

Summary

7 editorial suggestions across 4 reviewable files (2 files clean). 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

13 issues fixed, 5 skipped across 5 files

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

| docs/directorymanager/11.1/admincenter/workflow/integrate.md:0 — Dale: n/a | File listed in changed-files.txt does not exist on disk (only powerautomate/integrate.md exists); nothing to check |
| docs/directorymanager/11.1/admincenter/workflow/implement.md:15 — Dale: passive-voice | 'an approval request is triggered' left as-is; the acting agent is ambiguous and an active rewrite risks changing meaning |
| docs/directorymanager/11.1/admincenter/workflow/implement.md:88 — Dale: passive-voice | 'when the group is manually deleted' left as-is; 'manually' distinguishes the case and naming an actor could misstate the trigger condition |
| docs/directorymanager/11.1/admincenter/workflow/powerautomate/installproxy.md:37 — Dale: passive-voice | 'The certificate must be issued for the public DNS hostname' left as-is; the issuing agent is a CA and rephrasing risks altering the requirement |
| docs/directorymanager/11.1/admincenter/workflow/powerautomate/integrate.md:41 — Dale: passive-voice | 'is deployed on the same machine' left as-is; 'deployed' (installed) carries a nuance that active alternatives like 'runs on' would change |

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

@github-actions

Copy link
Copy Markdown
Contributor

Code Review

Scope: correctness/build only (config, routing, links, anchors, scripts, workflows). Documentation content and style are handled by a separate workflow.

This PR contains no changes to products.js, docusaurus.config.js, sidebars, KB scripts, or GitHub Actions workflows. It is a docs restructuring: workflow/integrate.md is moved into a new workflow/powerautomate/ category, installproxy.md is added, and one image is removed. Since onBrokenLinks, broken markdown links, and broken anchors all throw at build time, I verified the routing and link integrity of the restructure.

No issues found. Details of what was checked:

  • Moved file references updated. All links to the relocated integrate.md within 11.1/admincenter/workflow/ are updated to powerautomate/integrate.md (absolute links in advancedsettings.md, relative + absolute links in implement.md). No stale references to the old path remain in that folder.
  • Anchors resolve. #trigger-a-flow-from-directory-manager and #link-an-identity-store-workflow-to-a-flow (linked from implement.md) match headings in the new integrate.md; the in-page and cross-page anchors in the new files (#connect-an-identity-store-to-power-automate, #manual-cleanup-after-a-failed-install) all match existing headings. The installproxy.md relative link from integrate.md resolves.
  • _category_.json is valid and its link.type: doc / id: "integrate" follows the repo convention (local filename without extension, resolved relative to the category folder — confirmed against existing examples like dtmscript/_category_.json and datatracking/_category_.json). integrate.md exists in the same folder. Category position: 40 preserves the prior sidebar ordering of the old integrate.md. Missing trailing newline is cosmetic only.
  • Deleted image is safe. pa_permissions.webp (11.1) is no longer referenced anywhere; the new integrate.md dropped those image references. The only remaining pa_permissions references are in 11.0/signin/ (a different version/section) pointing at a separate 11.0 image that is untouched.

@ivan-zamkovyi-nwx
ivan-zamkovyi-nwx dismissed renata-tyburczy-nwx’s stale review July 21, 2026 14:29

Renata left an informational comment, so it can be dismissed

@dave-miles65 dave-miles65 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Approved

@ivan-zamkovyi-nwx
ivan-zamkovyi-nwx merged commit c7a17f8 into dev Jul 21, 2026
11 checks passed
@ivan-zamkovyi-nwx
ivan-zamkovyi-nwx deleted the feature/420908-power-automate branch July 21, 2026 14:36
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.

5 participants