Skip to content

update documentation for power automate#814

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

update documentation for power automate#814
ivan-zamkovyi-nwx wants to merge 10 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

Documentation PR Review

Editorial Review

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

  • No issues found. (Change is a link-path update to powerautomate/integrate.md.)

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

  • No issues found. (Change is a link-path update to powerautomate/integrate.md.)

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

  • Completeness — Line 91 (Verification): The section only states what happens when the tests pass ("Power Automate Proxy is ready for use") but leaves the reader with no direction if the tests fail. Suggested fix: add a sentence pointing to the Troubleshooting section, e.g. "If any test fails, see Troubleshooting."
  • Completeness — Line 113 (Manual cleanup): The publish directory path references GroupID 11.0, but this topic lives in the Directory Manager 11.1 documentation set. Verify whether the path should read 11.1 (or confirm that the GroupID product folder is intentionally versioned differently), so readers on 11.1 remove the correct directory.
  • Clarity — Line 7: The H1 "Power Automate Reverse Proxy — Installation Guide" doesn't match the frontmatter title ("Install Reverse Proxy for Power Automate") and uses a noun-phrase "Guide" heading for a task topic. Suggested fix: align the H1 with the sidebar title and Netwrix task-heading convention, e.g. "Install the Power Automate Reverse Proxy."
  • Clarity — Line 14: "your NDM DataService" is introduced without a one-line explanation of what the DataService is or its role, even though the whole procedure depends on it being reachable. Suggested fix: add a brief clause on first mention, e.g. "your NDM DataService (the component Power Automate calls back into)."

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

  • Clarity — Line 68: "the client secret value to the Directory Manager application" reads as incomplete and breaks parallelism with the surrounding definitions (Tenant ID and Client ID both use "assigned to"). Suggested fix: "the client secret value assigned to the Directory Manager application when you registered it in Microsoft Entra Admin Center."
  • Clarity — Line 47: "This will establish a communication channel" uses future tense; Netwrix standards call for present tense. Suggested fix: "This establishes a communication channel between the Directory Manager Data service and the Power Automate platform."
  • Structure — Line 11: The sentence "you can link an identity store... to achieve the following:" introduces a bulleted list but only one bullet ("Trigger a flow from Directory Manager") follows. Suggested fix: either fold the single outcome into a sentence, or confirm whether a second capability (for example, triggering a Directory Manager workflow from a flow) was meant to be listed.

Summary

7 editorial suggestions across 5 files (2 files clean — link-path updates only). 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 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.

@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Code Review

Reviewed for correctness (bugs, build/routing breakage, scripts, workflows, security). This PR is scoped to docs content plus one structural move: workflow/integrate.md -> workflow/powerautomate/integrate.md, a new _category_.json, and a new installproxy.md. Documentation content and style were not reviewed (separate workflow handles that).

Build-breaking: stale link to the moved file

docs/directorymanager/11.1/admincenter/workflow/implement.md:191 still points to the old same-folder path:

[Trigger a Flow from Directory Manager ](integrate.md#trigger-a-flow-from-directory-manager) topic.

integrate.md was deleted from workflow/ and moved to workflow/powerautomate/, so this relative link no longer resolves. The PR correctly updated the other two references in this same file (lines 214-215) and the one in advancedsettings.md, but this one was missed. Since onBrokenLinks/onBrokenMarkdownLinks are set to throw, the production build will fail on this.

Fix: repoint to the new location (the anchor target ## Trigger a Flow from Directory Manager exists in the moved file):

[Trigger a Flow from Directory Manager ](powerautomate/integrate.md#trigger-a-flow-from-directory-manager) topic.

Checked and OK

  • _category_.json - valid JSON; link.id: "integrate" uses the short, folder-relative doc id that matches the repo convention (e.g. authenticate/asserviceprovider/okta/_category_.json), and integrate.md exists in that folder. The missing trailing newline is harmless.
  • Deleted image pa_permissions.webp - no remaining references in 11.1; the new integrate.md dropped its usage, so no broken image links.
  • Updated links in advancedsettings.md and implement.md:214-215 correctly point to powerautomate/integrate.md with valid anchors.
  • 11.0 references to workflow/integrate.md are a separate version with its own intact file - not affected.
  • No config (products.js, docusaurus.config.js, sidebars), scripts, or GitHub Actions workflows changed; no secrets, injection, or unsafe-eval surface in this diff.

One issue to fix before merge (the implement.md:191 link); everything else looks correct.

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