Skip to content

docs: fix #1059 — ndm signing key download links#1060

Open
jth-nw wants to merge 4 commits into
devfrom
fix/issue-1059-ndm-signing-key-download-links
Open

docs: fix #1059 — ndm signing key download links#1060
jth-nw wants to merge 4 commits into
devfrom
fix/issue-1059-ndm-signing-key-download-links

Conversation

@jth-nw

@jth-nw jth-nw commented Jun 3, 2026

Copy link
Copy Markdown
Collaborator

Closes #1059

What changed

fix/issue-1059-ndm-signing-key-download-links

Replace directorymanager path with groupid path in download URLs per
the correct links from security advisory ADV-2025-004.

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

13 issues fixed, 2 skipped across 1 files

Category Fixes
FollowTheStepsTo (rewrite) 1
TypeVsEnter (rewrite) 3
Dale: misplaced-modifiers 1
Dale: passive-voice 7
Dale: wordiness 1
Skipped (needs manual review) Reason

| docs/directorymanager/11.1/admincenter/service/securityservice/signkeyutility.md:87 — Dale: passive-voice | 'Use the same parameters given in the Generate a SigningKey section' — 'given' is a participial adjective; rewriting risks changing meaning |
| docs/directorymanager/11.1/admincenter/service/securityservice/signkeyutility.md:91 — Dale: passive-voice | 'newly generated signing key' — participial adjective modifying noun, acceptable usage |

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

@github-actions

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

2 issues fixed, 2 skipped across 1 files

Category Fixes
Dale: idioms 1
Dale: wordiness 1
Skipped (needs manual review) Reason

| docs/directorymanager/11.1/admincenter/service/securityservice/signkeyutility.md:9 — Dale: passive-voice | 'the vulnerability described in' is a standard reduced relative clause; rewriting to active voice would be awkward and change tone. |
| docs/directorymanager/11.1/admincenter/service/securityservice/signkeyutility.md:87 — Dale: passive-voice | 'the same parameters given in the ... section' is standard cross-reference phrasing; no clean, meaning-preserving active rewrite. |

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

@github-actions

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/directorymanager/11.1/admincenter/service/securityservice/signkeyutility.md

  • Structure — Lines 57–63: The "Step 1 – / Step 2 –" prose was correctly converted to a numbered list, but the fenced code block on lines 59–61 sits at column 0 (unindented) between list items 2. and 3.. In CommonMark/MDX, an unindented fenced block terminates the ordered list, so step 3. starts a new list and the code block renders as a detached top-level block instead of belonging to step 2. Suggested fix: indent the fenced code block by three spaces so it nests under step 2 and steps 1–3 render as one continuous list.

  • Completeness — Lines 13, 17: The reworded sentences reference other sections in plain text ("See the Generate a Signing Key section", "See the Update Schedules section"), and the bullets on lines 24–25 ("Export a Signing Key", "Import a Signing Key") name sections a reader is told to "See." Because these are not links, a reader cannot jump to them and must scroll to find the right heading. Suggested fix: convert the section references to in-page anchor links (e.g., [Generate a Signing Key](#generate-a-signing-key)) so the cross-references are actionable.

  • Clarity — Lines 34, 38: The download-link fix (updating the path from directorymanager to groupid) is the substantive change and reads correctly. One note: the link text duplicates the full URL verbatim. This is acceptable for direct download links, so no change is required — flagging only so it is a conscious choice rather than an oversight.

Summary

2 actionable editorial suggestions (1 Structure, 1 Completeness) plus 1 informational note across 1 file. The passive→active voice rewrites throughout the diff are correct and are handled by the Vale/Dale auto-fix workflow 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.

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.

Fix: NDM Installation doc has a broken link

1 participant