Skip to content

Fix broken build: bad cross-file link in AA 2601 requirements - #1488

Merged
mckibbenc merged 4 commits into
devfrom
docs/fix-aa2601-broken-link
Sep 5, 2026
Merged

Fix broken build: bad cross-file link in AA 2601 requirements#1488
mckibbenc merged 4 commits into
devfrom
docs/fix-aa2601-broken-link

Conversation

@mckibbenc

Copy link
Copy Markdown
Contributor

Summary

Test plan

  • CI build passes on this PR

Generated with AI

Co-Authored-By: Claude Code ai@netwrix.com

The relative link to install-commands.md#choosing-a-deployment-size
failed MDX/broken-link resolution during the Docusaurus build
(introduced by #1487, broke the dev build). Switch to the absolute
/docs/... path convention already used elsewhere in these files.

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
@mckibbenc
mckibbenc requested a review from a team as a code owner September 5, 2026 00:03
@github-actions

github-actions Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

2 issues fixed, 4 skipped across 1 files

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

| docs/accessanalyzer/2601/install/system/requirements.md:57 — Dale: passive-voice | "kernel features required for Kubernetes container operation" is a reduced adjectival participle, not a true passive clause; rewriting it actively produces awkward phrasing without improving clarity. |
| docs/accessanalyzer/2601/install/system/requirements.md:61 — Dale: passive-voice | Table cell fragment ("required for container isolation") — an adjectival fragment with no subject to make active. |
| docs/accessanalyzer/2601/install/system/requirements.md:64 — Dale: passive-voice | Table cell fragment ("Required for Kubernetes networking") — an adjectival fragment with no subject to make active. |
| docs/accessanalyzer/2601/install/system/requirements.md:39 — Dale: xy-slop | "passes preflight with a warning rather than failing" is a genuine either/or contrast describing installer behavior, not the negative-positive "x is not y, x is z" pattern; rewriting risks losing the behavioral distinction. |

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

install-commands.md is draft:true, so it has no route in the
production build. Linking to it from a non-draft page (this one)
fails Docusaurus's broken-link check even though the target file
exists on disk. Reference the --size flag by name instead.

Generated with AI

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

github-actions Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/accessanalyzer/2601/install/system/requirements.md

  • Completeness — Line 13: Removing the link to the Installer Command Reference was the right call (that page is draft: true, so the link would break the build), but it leaves --size introduced with no syntax and nowhere published to look it up. A reader who has picked "Large" from the table below still doesn't know how to pass that choice to the installer. Suggested fix: add a short inline example so the option stands on its own — "Choose a deployment size by passing --size to the installer — for example, --size large. The installer enforces each size's CPU and memory figures as hard preflight minimums..."
  • Clarity — Line 39: "the amount your chosen --size needs as data accumulates" attributes the disk requirement to the command-line option rather than to the deployment it creates. An option doesn't consume disk; the deployment does. Suggested fix: "The recommended amount in the Deployment Sizing table is the amount a deployment of your chosen size needs as data accumulates..."

Summary

2 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 Sep 5, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

1 issues fixed, 5 skipped across 1 files

Category Fixes
Dale: undefined-acronyms 1
Skipped (needs manual review) Reason

| docs/accessanalyzer/2601/install/system/requirements.md:51 — Dale: wordiness | The two sentences repeat 'compatible' for Debian stable releases, but the second sentence carries the Ubuntu/Debian rationale; every concise rewrite either drops that reasoning or changes which distributions are claimed as compatible |
| docs/accessanalyzer/2601/install/system/requirements.md:39 — Dale: xy-slop | 'passes preflight with a warning rather than failing' is a factual contrast between two installer behaviors, not the rhetorical negative-positive 'x is not y, x is z' pattern |
| docs/accessanalyzer/2601/install/system/requirements.md:64 — Dale: passive-voice | 'Required for Kubernetes networking' is a table-cell fragment describing a feature; rewriting to active voice would need an invented subject and would break the parallel structure of the other cells |
| docs/accessanalyzer/2601/install/system/requirements.md:53 — Dale: passive-voice | 'Not supported:' is a bolded label introducing a list, matching the 'Compatible distributions' label above it; changing it would break the parallel labeling |
| docs/accessanalyzer/2601/install/system/requirements.md:47 — Dale: undefined-acronyms | LTS appears as part of the official release name 'Ubuntu 24.04 LTS', not as a standalone acronym in body prose |

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

@mckibbenc
mckibbenc merged commit 6f94c1d into dev Sep 5, 2026
11 checks passed
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