Skip to content

Flatten Threat Prevention Custom Certificates docs structure#1229

Open
brandonwest-netwrix wants to merge 4 commits into
devfrom
bwest-NTP-update-custom-certificate
Open

Flatten Threat Prevention Custom Certificates docs structure#1229
brandonwest-netwrix wants to merge 4 commits into
devfrom
bwest-NTP-update-custom-certificate

Conversation

@brandonwest-netwrix

Copy link
Copy Markdown
Collaborator

Move customcert.md and manual.md out of the manual/ subfolder for docs/threatprevention 7.5 and 8.0, removing the now-unused category.json files.

Removed suggestion from customercert.md that custom certificates only work when the agent is manually installed.

Move customcert.md and manual.md out of the manual/ subfolder for
docs/threatprevention 7.5 and 8.0, removing the now-unused
_category_.json files.
@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Broken Anchor Links

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

  docs/threatprevention/7.5/install/agent/manual.md:218
    [Create Custom Managed Certificates for Each Agent](/docs/threatprevention/7.5/install/agent/manual/customcert.md) topic for additional information.
    docs/threatprevention/7.5/install/agent/manual/customcert.md not found
  docs/threatprevention/8.0/install/agent/manual.md:218
    [Create Custom Managed Certificates for Each Agent](/docs/threatprevention/8.0/install/agent/manual/customcert.md) topic for additional information.
    docs/threatprevention/8.0/install/agent/manual/customcert.md not found

Auto-Fix Summary

32 issues fixed, 6 skipped across 4 files

Category Fixes
Contractions 16
Plurals 2
DesiredAsAdjective (rewrite) 2
FollowTheStepsTo (rewrite) 4
FormalHedging (rewrite) 2
Dale: passive-voice 2
Dale: wordiness 4
Skipped (needs manual review) Reason
docs/threatprevention/7.5/install/agent/manual.md:57 — Netwrix.FirstPerson The 'I' is part of the literal UI checkbox label 'I accept the terms in the License Agreement'. Rewording would misname the actual UI element the reader must click.
docs/threatprevention/8.0/install/agent/manual.md:57 — Netwrix.FirstPerson The 'I' is part of the literal UI checkbox label 'I accept the terms in the License Agreement'. Rewording would misname the actual UI element the reader must click.
docs/threatprevention/7.5/install/agent/customcert.md:32 — Dale: passive-voice 'where the Agent is deployed' is a stative passive describing machine state; converting to active would change meaning or read awkwardly.
docs/threatprevention/7.5/install/agent/manual.md:165 — Dale: passive-voice 'This page isn't displayed when Custom-managed is selected' describes UI state and behavior; active rewrites distort the conditional meaning.
docs/threatprevention/7.5/install/agent/manual.md:183 — Dale: passive-voice 'events to be monitored by this Agent' and similar UI-state passives (grayed-out, is being installed) describe system state; conversion risks changing meaning.
docs/threatprevention/8.0/install/agent/manual.md:165 — Dale: passive-voice 'This page isn't displayed when Custom-managed is selected' describes UI state and behavior; active rewrites distort the conditional meaning.

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

Several pages under threatprevention 7.5 and 8.0 still linked to the
old nested install/agent/manual/{manual,customcert}.md paths after
those files were flattened to install/agent/{manual,customcert}.md.

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
@github-actions

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

Most changes in this PR are mechanical link updates following the flattening of the install/agent/manual/ directory (manual/manual.mdmanual.md, manual/customcert.mdcustomcert.md). Those link updates are correct and consistent across both the 7.5 and 8.0 versions. The editorial notes below focus on the small number of files where content — not just link paths — changed.

docs/threatprevention/7.5/install/agent/customcert.md

  • Completeness — Line 9: The opening sentence was reduced to "Use the SIAgentCert.exe command line utility to create certificates for each Agent." The previous version told the reader when this utility applies (only when "custom-managed" is selected for the CA certificate configuration during Manual Agent Deployment) and linked back to that topic. A reader landing on this page no longer learns the precondition for using the utility. Suggested fix: restore the condition and cross-reference, e.g. "If Custom-managed is selected for the CA certificate configuration during Manual Agent Deployment, use the SIAgentCert.exe command line utility to create certificates for each Agent."

docs/threatprevention/8.0/install/agent/customcert.md

  • Completeness — Line 9: Same as the 7.5 file above — the removed conditional ("If custom-managed is selected … during Manual Agent Deployment") and its cross-link leave the reader without the context for when this procedure applies. Suggested fix: restore the condition and link, e.g. "If Custom-managed is selected for the CA certificate configuration during Manual Agent Deployment, use the SIAgentCert.exe command line utility to create certificates for each Agent."

docs/threatprevention/7.5/install/agent/manual.md

  • No issues found. The added lines (active-voice and contraction edits, "servers" for "server(s)", the "To manually deploy the Agent:" lead-in, and the updated cross-links) read cleanly and fit their context.

docs/threatprevention/8.0/install/agent/manual.md

  • No issues found.

docs/threatprevention/7.5/admin/agents/agents-windows/enrollmentsecretconfiguration.md

  • No issues found. (Link path update only.)

docs/threatprevention/8.0/admin/agents/agents-windows/enrollmentsecretconfiguration.md

  • No issues found. (Link path update only.)

docs/threatprevention/7.5/admin/agents/deploy/overview.md

  • No issues found. (Link path update only.)

docs/threatprevention/8.0/admin/agents/deploy/overview.md

  • No issues found. (Link path update only.)

docs/threatprevention/7.5/admin/agents/overview.md

  • No issues found. (Link path update only.)

docs/threatprevention/8.0/admin/agents/overview.md

  • No issues found. (Link path update only.)

docs/threatprevention/7.5/install/migrateemserver.md

  • No issues found. (Link path update only.)

docs/threatprevention/8.0/install/migrateemserver.md

  • No issues found. (Link path update only.)

docs/threatprevention/7.5/requirements/ports.md

  • No issues found. (Link path update only.)

docs/threatprevention/8.0/requirements/ports.md

  • No issues found. (Link path update only.)

docs/threatprevention/7.5/troubleshooting/enterprisemanagercommunication.md

  • No issues found. (Link path update only.)

docs/threatprevention/8.0/troubleshooting/enterprisemanagercommunication.md

  • No issues found. (Link path update only.)

Summary

2 editorial suggestions across 16 files (the same completeness issue in the 7.5 and 8.0 copies of customcert.md). The remaining 14 files contain correct, consistent link-path updates with no editorial issues. 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

96 issues fixed, 6 skipped across 16 files

Category Fixes
Contractions 24
Plurals 20
Removed filler 2
Substitutions 4
AllowsYouTo (rewrite) 8
BoilerplateCrossRef (rewrite) 2
DesiredAsAdjective (rewrite) 4
FollowTheStepsTo (rewrite) 14
FormalHedging (rewrite) 2
ImpersonalFiller (rewrite) 2
Repetition (rewrite) 2
WeakLinkText (rewrite) 2
WhetherOrNot (rewrite) 2
Dale: minimizing-difficulty 2
Dale: positional-references 4
Dale: wordiness 2
Skipped (needs manual review) Reason
docs/threatprevention/7.5/install/agent/manual.md:57 — Netwrix.FirstPerson The 'I' is part of the literal UI checkbox label 'I accept the terms in the License Agreement' — a false positive. Rewriting would misrepresent the actual UI element.
docs/threatprevention/8.0/install/agent/manual.md:57 — Netwrix.FirstPerson The 'I' is part of the literal UI checkbox label 'I accept the terms in the License Agreement' — a false positive. Rewriting would misrepresent the actual UI element.
docs/threatprevention/7.5/requirements/ports.md:148 — Dale: undefined-acronyms CEE and AMQP appear only inside table cells/section labels; expanding them in a table cell would be awkward and the correct placement is ambiguous.
docs/threatprevention/8.0/requirements/ports.md:148 — Dale: undefined-acronyms CEE and AMQP appear only inside table cells/section labels; expanding them in a table cell would be awkward and the correct placement is ambiguous.
docs/threatprevention/7.5/admin/agents/overview.md:177 — Dale: passive-voice Numerous passive constructions (e.g. 'the Agent is deployed', 'events queue up') are agentless state descriptions where the actor is unknown or unimportant; rewriting would require inventing a subject and risk changing meaning.
docs/threatprevention/7.5/admin/agents/overview.md:78 — Dale: misplaced-modifiers 'For example, Windows Server 2022 Standard.. For example, Windows Server 2019 Standard' is a duplicated-content error, not a modifier placement issue; the correct example to keep is ambiguous.

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

@github-actions

Copy link
Copy Markdown
Contributor

Code Review

Reviewed for correctness, build/routing, script, and workflow issues (documentation content/style excluded, per scope).

No blocking issues found. This PR flattens the Threat Prevention "Manual Agent Deployment" docs (7.5 and 8.0) by moving install/agent/manual/manual.md up to install/agent/manual.md and install/agent/manual/customcert.md up to install/agent/customcert.md, and deleting the now-empty manual/_category_.json.

Build/routing verification (onBrokenLinks: throw makes stale links fatal):

  • All internal links to the old nested manual/manual.md and manual/customcert.md paths in 7.5 and 8.0 have been updated to the new flattened paths. A repo-wide grep finds no remaining references to the old 7.5/8.0 paths.
  • The manual/ subdirectories are fully removed in both versions (no orphaned files).
  • Remaining old-path references belong to the untouched 7.4 version and are internally consistent (7.4 still has its own manual/ folder).
  • The threatprevention sidebar is autogenerated, so the flattening is picked up automatically with no hardcoded doc IDs to update. The deleted _category_.json referenced id: manual (self-contained to the removed folder); the surviving parent agent/_category_.json links to overview, which still exists.

Minor (non-blocking) observation:

  • After the move, both manual.md and customcert.md carry sidebar_position: 10. Docusaurus breaks the tie alphabetically, so customcert renders before manual in the sidebar — the reverse of the logical reading order (custom certs are a follow-up step to manual deployment). Consider bumping customcert.md to a later position (e.g. 15) to preserve intended ordering. This does not affect the build.

No config, script, or workflow files were touched — no injection, secret, or permission concerns in scope.

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