Skip to content

nested spnmapping.md#1044

Open
brandonwest-netwrix wants to merge 16 commits into
devfrom
brandon-nwx-correct-page-naming
Open

nested spnmapping.md#1044
brandonwest-netwrix wants to merge 16 commits into
devfrom
brandon-nwx-correct-page-naming

Conversation

@brandonwest-netwrix

@brandonwest-netwrix brandonwest-netwrix commented Jun 1, 2026

Copy link
Copy Markdown
Collaborator

Nested spnmapping.md under appletsettings.md for both versions 11.6 and 12.0.
Normalized page names.

Additional fixes from editorial review:

  • Added missing intro sentence in manualcertificate.md (11.6, 12.0)
  • Fixed broken Applet Settings link in proxymodeappletpermissions.md (12.0)
  • Fixed incomplete Applet Settings link in proxymodeservicepermissions.md (11.6, 12.0)
  • Capitalized sentence opener in recommended.md (11.6, 12.0)
  • Fixed typo "job froup" → "job group" in recommended.md (12.0)

brandonwest-netwrix and others added 2 commits May 29, 2026 10:37
…tsettings subdirectory for 11.6 and 12.0

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
…pdate deps and fsaa docs

- Set rspackBundler and rspackPersistentCache to false in docusaurus.config.js to resolve
  webpack ProvidePlugin crash caused by docusaurus-plugin-openapi-docs incompatibility with rspack
- Update package.json and package-lock.json dependencies
- Update accessanalyzer 11.6 and 12.0 fsaa documentation content

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
@brandonwest-netwrix brandonwest-netwrix requested a review from a team as a code owner June 1, 2026 17:49
…3.10.1

Take dev versions for preset-classic, theme-mermaid, and mdx-js/react (^3.10.1/^3.1.1)
and regenerate package-lock.json.

Generated with AI

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

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

101 issues fixed, 7 skipped across 18 files

Category Fixes
Contractions 36
Plurals 8
Removed filler 2
Substitutions 2
DesiredAsAdjective (rewrite) 4
FollowTheStepsTo (rewrite) 8
FormalHedging (rewrite) 7
Idioms (rewrite) 4
ImpersonalFiller (rewrite) 2
OxfordComma (rewrite) 4
Dale: idioms 2
Dale: passive-voice 12
Dale: positional-references 2
Dale: wordiness 8
Skipped (needs manual review) Reason
docs/accessanalyzer/11.6/solutions/filesystem/collection/1-seek_system_scans.md:49 — Netwrix.FirstPersonPlural False positive: 'US' here is the country abbreviation in 'US SSN' (United States Social Security Number), a product/criteria term, not the pronoun 'us'
docs/accessanalyzer/12.0/solutions/filesystem/collection/1-seek_system_scans.md:49 — Netwrix.FirstPersonPlural False positive: 'US' here is the country abbreviation in 'US SSN' (United States Social Security Number), a product/criteria term, not the pronoun 'us'
docs/accessanalyzer/11.6/admin/datacollector/fsaa/certificatemanagement/manualcertificate.md:46 — Dale: passive-voice Repeated pattern 'The following message is returned when the command completes successfully:' appears many times as parallel structure introducing console output; rewriting all occurrences would alter the documented expectation pattern
docs/accessanalyzer/11.6/admin/datacollector/fsaa/appletsettings/appletsettings.md:92 — Dale: passive-voice Conditional phrases 'If a communication timeout is reached' / 'is unchecked' / 'is checked' describe UI state — rewriting to active voice ('When you reach...' or 'When you clear...') changes who/what triggers the state and risks technical inaccuracy
docs/accessanalyzer/11.6/solutions/filesystem/collection/1-fsaa_system_scans.md:111 — Dale: passive-voice Repeated parallel structure 'No warning will be shown' / 'A warning will be shown' appears in many nested list items as a documented behavior pattern; rewriting risks inconsistency across the parallel options
docs/accessanalyzer/11.6/solutions/filesystem/recommended.md:37 — Dale: passive-voice 'The host list assignment should be assigned under...' uses 'should be assigned' as documentation guidance; rewriting changes prescriptive tone (recommendation vs. instruction)
docs/accessanalyzer/11.6/solutions/filesystem/collection/1-fsaa_system_scans.md:43 — Dale: passive-voice 'The 1-FSAA System Scans job has been preconfigured to run with the default settings' describes a product configuration state; rewriting to active voice would require identifying an agent that may not match the source intent

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

v2.x of docusaurus-plugin-openapi-docs was incompatible with rspack,
causing a webpack ProvidePlugin crash. Upgrading to v5.0.2 (matching dev)
fixes the incompatibility, allowing rspack to be re-enabled. Without rspack
the webpack build OOMs on CI runners with limited memory.

Generated with AI

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

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

37 issues fixed, 9 skipped across 22 files

Category Fixes
Contractions 2
Plurals 2
CanBeUsedTo (rewrite) 2
FirstPerson (rewrite) 4
FormalHedging (rewrite) 6
Idioms (rewrite) 4
OnceUsage (rewrite) 2
QuestionHeadings (rewrite) 4
Dale: passive-voice 5
Dale: positional-references 2
Dale: wordiness 4
Skipped (needs manual review) Reason
docs/accessanalyzer/11.6/solutions/filesystem/collection/1-seek_system_scans.md:49 — Netwrix.FirstPersonPlural False positive — 'US' here is the country code in 'US SSN' (United States Social Security Number), a Sensitive Data Discovery criterion name, not first-person plural
docs/accessanalyzer/12.0/solutions/filesystem/collection/1-seek_system_scans.md:49 — Netwrix.FirstPersonPlural False positive — 'US' here is the country code in 'US SSN' (United States Social Security Number), a Sensitive Data Discovery criterion name, not first-person plural
docs/accessanalyzer/11.6/admin/datacollector/fsaa/certificatemanagement/manualcertificate.md:45 — Dale: passive-voice 'The following message is returned when the command completes successfully' is a standard CLI documentation convention; rewriting to active would be unnatural and could change reader expectations across the entire step-by-step procedure (appears repeatedly).
docs/accessanalyzer/12.0/admin/datacollector/fsaa/certificatemanagement/manualcertificate.md:44 — Dale: passive-voice Same repeated CLI convention as above; rewriting would alter standard procedure phrasing and may obscure that the message is the command's output, not the user's action.
docs/accessanalyzer/11.6/solutions/filesystem/recommended.md:132 — Dale: wordiness 'Whatever schedule frequency may be configured, it is also recommended to streamline the collection jobs to those desired' — rewriting to active form requires either first person ('we recommend', forbidden) or imperative, which would change a recommendation into a directive and alter authorial intent.
docs/accessanalyzer/11.6/solutions/filesystem/recommended.md:145 — Dale: wordiness 'It isn't recommended to delete any jobs' — same as above; converting to imperative ('Don't delete any jobs') strengthens the guidance from recommendation to instruction, changing meaning.
docs/accessanalyzer/11.6/requirements/filesystem/scanoptions/proxymodescans/asaservice/proxymodeservicepermissions.md:35 — Dale: passive-voice 'It is recommended to use the same domain account' — same issue: converting to imperative changes recommendation strength; no first-person alternative permitted.
docs/accessanalyzer/11.6/admin/datacollector/fsaa/appletsettings/appletsettings.md:89 — Dale: passive-voice 'after the timeout value has been exceeded' — passive but standard technical phrasing for describing event timing; active alternatives ('after the timeout elapses') change technical nuance.
docs/accessanalyzer/11.6/solutions/filesystem/collection/1-fsaa_system_scans.md:110 — Dale: wordiness 'which include but aren't limited to' is mildly wordy but standard legal/technical hedge phrasing; alternatives risk implying the list is exhaustive when the author explicitly intends otherwise.

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

@brandonwest-netwrix

Copy link
Copy Markdown
Collaborator Author

@netwrix/accessanalyzer-docs please review - this is a page re-org only

- Add intro sentence before :::note in manualcertificate.md (11.6, 12.0)
- Fix broken Applet Settings link in proxymodeappletpermissions.md (12.0)
- Fix incomplete Applet Settings link in proxymodeservicepermissions.md (11.6, 12.0)
- Capitalize sentence opener in filesystem recommended.md (11.6, 12.0)
- Fix typo "job froup" → "job group" in recommended.md (12.0)

Generated with AI

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

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

6 issues fixed, 10 skipped across 22 files

Category Fixes
Dale: passive-voice 2
Dale: positional-references 2
Dale: wordiness 2
Skipped (needs manual review) Reason
docs/accessanalyzer/11.6/solutions/filesystem/collection/1-seek_system_scans.md:49 — Netwrix.FirstPersonPlural False positive — 'US' here is the country abbreviation in 'US SSN' (United States Social Security Number), not the first person plural pronoun. Rewriting would change the meaning.
docs/accessanalyzer/12.0/solutions/filesystem/collection/1-seek_system_scans.md:49 — Netwrix.FirstPersonPlural False positive — 'US' here is the country abbreviation in 'US SSN' (United States Social Security Number), not the first person plural pronoun. Rewriting would change the meaning.
docs/accessanalyzer/11.6/admin/datacollector/fsaa/appletsettings/appletsettings.md:105 — Dale: passive-voice 'When checked, this option will timeout the applet' — fixing would require introducing a subject; ambiguity about whether 'checked' refers to user or option made the rewrite risky.
docs/accessanalyzer/11.6/admin/datacollector/fsaa/certificatemanagement/manualcertificate.md:24 — Dale: passive-voice 'All files that are generated by the Certificate Manager or copied to the Enterprise Auditor console are placed in...' — multiple agents (tool vs. user) make active rewrite ambiguous.
docs/accessanalyzer/11.6/requirements/filesystem/scanoptions/proxymodescans/asaservice/proxymodeservicepermissions.md:35 — Dale: passive-voice 'It is recommended to use the same domain account...' — changing to imperative would alter the recommendation tone into a directive.
docs/accessanalyzer/11.6/requirements/filesystem/scanoptions/proxymodescans/withapplet/proxymodeappletpermissions.md:32 — Dale: wordiness 'require .NET Framework 4.7.2 or later to be installed on the server where the applet is to be deployed in order for Sensitive Data Discovery collections to successfully occur' — wholesale rewrite would risk meaning change.
docs/accessanalyzer/11.6/solutions/filesystem/collection/1-fsaa_system_scans.md:116 — Dale: passive-voice Repeated 'A warning will be shown' patterns — high risk of meaning drift across many similar lines.
docs/accessanalyzer/11.6/solutions/filesystem/collection/1-seek_system_scans.md:191 — Dale: undefined-acronyms 'SDD' used in body without local definition; the page is titled around sensitive data and SDD appears in section headings — ambiguous whether body use needs separate definition.
docs/accessanalyzer/11.6/solutions/filesystem/recommended.md:289 — Dale: undefined-acronyms 'AIC Active Directory Exceptions reports' — uncertain what AIC stands for in this product context.
docs/accessanalyzer/12.0/admin/datacollector/fsaa/appletsettings/spnmapping.md:78 — Dale: passive-voice 'Access Analyzer will use the SPN...' uses future tense rather than passive; style preference but not a clear Dale violation.

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

@brandonwest-netwrix

Copy link
Copy Markdown
Collaborator Author

@netwrix/accessanalyzer-docs ready for review and merge

@github-actions

github-actions Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

20 issues fixed, 18 skipped across 22 files

Category Fixes
FollowTheStepsTo (rewrite) 2
Dale: passive-voice 18
Skipped (needs manual review) Reason
docs/accessanalyzer/11.6/solutions/filesystem/collection/1-seek_system_scans.md:49 — Netwrix.FirstPersonPlural False positive. 'US' in 'US SSN' refers to United States Social Security Number — it is part of a product-defined System Criteria name (alongside Credit Cards, Passwords, Tax Forms), not the first person plural pronoun. Rewriting would alter a literal UI/product label.
docs/accessanalyzer/12.0/solutions/filesystem/collection/1-seek_system_scans.md:49 — Netwrix.FirstPersonPlural False positive. 'US' in 'US SSN' refers to United States Social Security Number — it is part of a product-defined System Criteria name (alongside Credit Cards, Passwords, Tax Forms), not the first person plural pronoun. Rewriting would alter a literal UI/product label.
docs/accessanalyzer/11.6/admin/datacollector/fsaa/appletsettings/appletsettings.md:105 — Dale: passive-voice 'When checked, this option will timeout the applet...' - rewriting risked changing the meaning of the conditional logic
docs/accessanalyzer/11.6/admin/datacollector/fsaa/appletsettings/appletsettings.md:91 — Dale: passive-voice 'after the timeout value has been exceeded' - common technical phrasing; active alternatives like 'after exceeding' could obscure which actor exceeds the value
docs/accessanalyzer/11.6/admin/datacollector/fsaa/appletsettings/appletsettings.md:117 — Dale: passive-voice 'all certificates to be valid and in their respective stores beforehand' - infinitive construction is idiomatic in this context
docs/accessanalyzer/11.6/admin/datacollector/fsaa/certificatemanagement/manualcertificate.md:22 — Dale: passive-voice 'files that are generated by the Certificate Manager or copied to the Enterprise Auditor console are placed in' - rewriting would require choosing one of two subjects (Certificate Manager vs. user) and could change meaning
docs/accessanalyzer/11.6/admin/datacollector/fsaa/certificatemanagement/manualcertificate.md:25 — Dale: passive-voice 'files are placed into the root' - subject of who places the files is ambiguous
docs/accessanalyzer/11.6/admin/datacollector/fsaa/certificatemanagement/manualcertificate.md:45 — Dale: passive-voice 'The following message is returned when the command completes successfully' - common output description; repeats throughout and rewriting all instances risks inconsistency
docs/accessanalyzer/11.6/admin/datacollector/fsaa/overview.md:35 — Dale: passive-voice 'The Sensitive Data Discovery Add-On must be installed on the Enterprise Auditor Console server' - active rewrite would require choosing the actor (you, an admin) which could shift the meaning of a prerequisite statement
docs/accessanalyzer/11.6/admin/datacollector/fsaa/updateservicesettings.md:22 — Dale: passive-voice 'When selected, this option will timeout the applet if there is an attempt to pause the scan' - rewriting risked changing the meaning of the conditional logic
docs/accessanalyzer/11.6/requirements/filesystem/scanoptions/proxymodescans/asaservice/proxymodeservicepermissions.md:11 — Dale: passive-voice 'File System Proxy Service installation package must be installed on the Windows proxy servers' - part of a definitional list item; active rewrite could shift it from definition to instruction
docs/accessanalyzer/11.6/requirements/filesystem/scanoptions/proxymodescans/asaservice/proxymodeservicepermissions.md:35 — Dale: passive-voice 'It is recommended to use the same domain account' - rewriting to active would require first-person 'we recommend' which violates style guide
docs/accessanalyzer/11.6/requirements/filesystem/scanoptions/proxymodescans/withapplet/proxymodeappletpermissions.md:9 — Dale: passive-voice 'When File System scans are run in proxy mode with applet, it means the File System applet is deployed' - heavy nested passives; safe active rewrite would significantly restructure the sentence
docs/accessanalyzer/11.6/requirements/filesystem/scanoptions/proxymodescans/withapplet/proxymodeappletpermissions.md:17 — Dale: passive-voice 'This is required by either the user account running the Access Analyzer application, when manually executing jobs within the console, or the Schedule Service Account' - complex disjunction; restructuring risks changing which permission scenarios are listed
docs/accessanalyzer/11.6/solutions/filesystem/collection/1-fsaa_system_scans.md:42 — Dale: passive-voice 'The 1-FSAA System Scans job has been preconfigured to run' - 'preconfigured' is a state descriptor and rewriting could obscure that it's a pre-existing condition
docs/accessanalyzer/11.6/solutions/filesystem/recommended.md:98 — Dale: passive-voice 'The Connection Profile should be assigned under the FileSystem > 0.Collection job's Properties window' - 'should' carries normative weight; converting to imperative changes the strength of the recommendation
docs/accessanalyzer/11.6/solutions/filesystem/recommended.md:145 — Dale: passive-voice 'It isn't recommended to delete any jobs' - active alternative requires first-person 'we don't recommend' which violates the style guide
docs/accessanalyzer/12.0/admin/datacollector/fsaa/appletsettings/appletsettings.md:104 — Dale: passive-voice 'When checked, this option will timeout the applet...' - rewriting risked changing the meaning of the conditional logic

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

brandonwest-netwrix and others added 2 commits June 4, 2026 11:23
Restores package.json and package-lock.json to dev state, removing
unintended Docusaurus plugin downgrades and serve upgrade that were
unrelated to the page naming changes in this PR.

Generated with AI

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

github-actions Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/accessanalyzer/11.6/admin/datacollector/fsaa/appletsettings/appletsettings.md

  • No issues found.

docs/accessanalyzer/11.6/admin/datacollector/fsaa/appletsettings/spnmapping.md

  • No issues found.

docs/accessanalyzer/11.6/admin/datacollector/fsaa/certificatemanagement/manualcertificate.md

  • Structure — Line 14: The new H2 "## Create and store the required certificates" is the only H2 in this document. A single mid-document H2 creates an unbalanced heading structure. Consider either restoring an introductory transition sentence (rephrased for active voice — e.g., "Use the following steps to create and store the required certificates.") or adding additional H2s to group later content (Steps 6–11 logically form a "Configure each proxy host" sub-section).
  • Clarity — Line 189: "Delete all the PFX, CER, and Key files that were generated or copied in the earlier steps from the output locations." The phrase "from the output locations" reads as if it modifies "the earlier steps" rather than the files. Suggested fix: "Delete all the PFX, CER, and Key files that were generated or copied to the output locations in the earlier steps."

docs/accessanalyzer/11.6/admin/datacollector/fsaa/overview.md

  • No issues found.

docs/accessanalyzer/11.6/admin/datacollector/fsaa/updateservicesettings.md

  • Completeness — Lines 18, 22: "Applet communication timeout: [number] minutes" and "Scan cancellation timeout: [number] minutes". If these labels mirror the UI (the original "minute(s)" suggested the UI uses a placeholder for singular/plural), the docs may no longer match what the user sees on screen. Verify the actual UI label and align the docs to it. If the UI does show "minute(s)", restore that text.

docs/accessanalyzer/11.6/requirements/filesystem/scanoptions/proxymodescans/asaservice/proxymodeservicepermissions.md

  • Clarity — Line 67 (heading): "## Verify Proxy Mode with Service scanning" uses "Proxy Mode with Service" while the rest of the document and product naming uses "Proxy Mode as a Service" (see the H1 of this file). The heading mismatch may confuse readers searching for terminology consistency. Suggested fix: "## Verify Proxy Mode as a Service scanning" — or, for parallel construction with the body sentence — "## Verify the scan is running in Proxy Mode as a Service".

docs/accessanalyzer/11.6/requirements/filesystem/scanoptions/proxymodescans/withapplet/proxymodeappletpermissions.md

  • No issues found.

docs/accessanalyzer/11.6/solutions/filesystem/collection/1-fsaa_system_scans.md

  • No issues found.

docs/accessanalyzer/11.6/solutions/filesystem/collection/1-fsac_system_scans.md

  • No issues found.

docs/accessanalyzer/11.6/solutions/filesystem/collection/1-seek_system_scans.md

  • No issues found.

docs/accessanalyzer/11.6/solutions/filesystem/recommended.md

  • Clarity — Lines 10–12: "However, as a best practice, assign the host list and the Connection Profile at the data collection level. After you assign these to the job, you can run it manually or schedule it." The pronoun "it" in "run it" / "schedule it" sits two clauses away from its antecedent "the job". Suggested fix: "However, as a best practice, assign the host list and the Connection Profile at the data collection level. After you assign these to a job, you can run the job manually or schedule it."

docs/accessanalyzer/12.0/admin/datacollector/fsaa/appletsettings/appletsettings.md

  • No issues found.

docs/accessanalyzer/12.0/admin/datacollector/fsaa/appletsettings/spnmapping.md

  • No issues found.

docs/accessanalyzer/12.0/admin/datacollector/fsaa/certificatemanagement/manualcertificate.md

  • Structure — Line 14: Same as the 11.6 version — the new H2 "## Create and store the required certificates" is the only H2 in this document, creating an unbalanced heading structure. Consider either restoring a rephrased transition sentence or adding additional H2s to group the procedure.
  • Clarity — Line 187: "Delete all the PFX, CER, and Key files that were generated or copied in the earlier steps from the output locations." Same word-order issue as the 11.6 version. Suggested fix: "Delete all the PFX, CER, and Key files that were generated or copied to the output locations in the earlier steps."

docs/accessanalyzer/12.0/admin/datacollector/fsaa/overview.md

  • No issues found.

docs/accessanalyzer/12.0/admin/datacollector/fsaa/updateservicesettings.md

  • Completeness — Lines 18, 22: Same concern as the 11.6 version — "[number] minutes" may not match a UI label that uses "minute(s)". Verify against the actual product UI.

docs/accessanalyzer/12.0/requirements/filesystem/scanoptions/proxy-mode-scans/as-a-service/proxymodeservicepermissions.md

  • Clarity — Heading line 67 (## Verify Proxy Mode with Service scanning): Mirrors the 11.6 inconsistency — "Proxy Mode with Service" vs the document's "Proxy Mode as a Service". Same suggested fix.
  • Consistency — The two version-specific files use "job group" / "solution" inconsistently. The 12.0 recommended.md introduces lowercase "job group" / "solution" in dependency bullets while the same document still uses capitalized "Job Group" elsewhere (e.g., "0.Collection Job Group"). Decide on one casing and apply it consistently within each version. (Flagging here because the diff touches both versions; the recommended.md instance is the source of the inconsistency — see that file's review.)

docs/accessanalyzer/12.0/requirements/filesystem/scanoptions/proxy-mode-scans/with-applet/proxymodeappletpermissions.md

  • No issues found.

docs/accessanalyzer/12.0/solutions/filesystem/collection/1-fsaa_system_scans.md

  • No issues found.

docs/accessanalyzer/12.0/solutions/filesystem/collection/1-fsac_system_scans.md

  • No issues found.

docs/accessanalyzer/12.0/solutions/filesystem/collection/1-seek_system_scans.md

  • No issues found.

docs/accessanalyzer/12.0/solutions/filesystem/recommended.md

  • Consistency — Lines 23, 25: New "job group" / "solution" lowercase in the dependency bullets conflicts with capitalized "Job Group" used elsewhere in the same file (e.g., "0.Collection Job Group"). Either standardize on lowercase throughout the file or restore capitalization here. Note: the typo "job froup" was correctly fixed to "job group" — only the casing decision needs to be made.
  • Clarity — Lines 9–11: Same pronoun-reference concern as the 11.6 recommended.md. Suggested fix: replace the second "the job, you can run it manually or schedule it" with "a job, you can run the job manually or schedule it."

Summary

8 editorial suggestions across 6 files. Most files in this PR are mechanical link-path updates and grammar improvements that read cleanly. The recurring items worth attention: (1) a Step 12 phrasing in both manualcertificate.md files, (2) the [number] minutes change in updateservicesettings.md if it mirrors a UI label, and (3) the new H2 in manualcertificate.md standing alone in the document. 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 Jun 4, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

10 issues fixed, 8 skipped across 22 files

Category Fixes
OnceUsage (rewrite) 2
Dale: passive-voice 8
Skipped (needs manual review) Reason
docs/accessanalyzer/11.6/solutions/filesystem/collection/1-seek_system_scans.md:49 — Netwrix.FirstPersonPlural 'US' here is the country acronym (United States) in the literal product UI label 'US SSN' — a preconfigured System Criteria option in AccessAnalyzer. Not first person plural; changing the label could break alignment with the product UI.
docs/accessanalyzer/12.0/solutions/filesystem/collection/1-seek_system_scans.md:49 — Netwrix.FirstPersonPlural 'US' here is the country acronym (United States) in the literal product UI label 'US SSN' — a preconfigured System Criteria option in AccessAnalyzer. Not first person plural; changing the label could break alignment with the product UI.
docs/accessanalyzer/11.6/admin/datacollector/fsaa/appletsettings/appletsettings.md:91 — Dale: passive-voice 'after the timeout value has been exceeded' — converting to active would require introducing an ambiguous subject; the agent of the timeout exceed is unclear
docs/accessanalyzer/11.6/admin/datacollector/fsaa/appletsettings/appletsettings.md:132 — Dale: idioms 'sits behind a proxy' is metaphorical but standard, widely-understood technical phrasing
docs/accessanalyzer/11.6/admin/datacollector/fsaa/certificatemanagement/manualcertificate.md:45 — Dale: passive-voice 'The following message is returned' is a repeated structural construction across many steps; rewriting risks inconsistency and changes the focus from message to command
docs/accessanalyzer/11.6/solutions/filesystem/collection/1-fsaa_system_scans.md:114 — Dale: passive-voice Repeated 'will be shown' / 'will not be shown' construction in a long parallel list; rewriting all instances risks breaking parallel structure
docs/accessanalyzer/11.6/requirements/filesystem/scanoptions/proxymodescans/withapplet/proxymodeappletpermissions.md:9 — Dale: wordiness 'it means the File System applet is deployed' — fix requires introducing a subject (Access Analyzer / Enterprise Auditor) and ambiguity over which is correct for each version
docs/accessanalyzer/12.0/admin/datacollector/fsaa/appletsettings/spnmapping.md:11 — Dale: idioms 'sits behind a proxy' is metaphorical but standard, widely-understood technical phrasing

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

@github-actions

github-actions Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Code Review

Issues found

1. .gitignore now ignores package.json and package-lock.json — likely unintended

/.gitignore lines 18–19 add:

package.json
package-lock.json

Both files are already tracked (git ls-files package.json package-lock.json returns both). Adding tracked files to .gitignore does not untrack them, but it will silently mask future modifications: anyone running git add . or git status will not see updates to dependencies or scripts. This is dangerous for a Node project where the build depends on these files, and there is no comment explaining the intent.

Recommendation: remove these two lines from .gitignore. The other entries in that block (build, claude_logs, packages) are directories of generated output; package.json / package-lock.json don't fit that pattern.

2. URL change for FSAA Applet Settings page — no redirect

The rename of appletsettings.mdappletsettings/appletsettings.md (both 11.6 and 12.0) changes the live URL:

  • Old: /docs/accessanalyzer/{11_6,12_0}/admin/datacollector/fsaa/appletsettings
  • New: /docs/accessanalyzer/{11_6,12_0}/admin/datacollector/fsaa/appletsettings/appletsettings

Same applies to spnmapping.mdappletsettings/spnmapping.md. All internal .md link targets have been updated correctly, and the @docusaurus/plugin-client-redirects config in docusaurus.config.js only handles product-root redirects, not per-page ones. External bookmarks, search-engine results, and any inbound links from outside this repo (KB articles, support tickets, marketing) will 404.

Recommendation: if these were stable, indexed URLs, add explicit entries to the plugin-client-redirects config mapping the old URLs to the new ones. If they were unindexed/new, this can be ignored.

Looks fine

  • The nested _category_.json with "link": { "type": "doc", "id": "appletsettings" } follows the established pattern in this repo (e.g., certificatemanagement/_category_.json), so the build and sidebar generation will work.
  • Sidebars are auto-generated (type: 'autogenerated'), so no manual sidebar edits are needed.
  • All internal .md links to the renamed files have been updated; no stale fsaa/appletsettings.md or fsaa/spnmapping.md references remain.
  • spnmapping.md sidebar_position changed from 31 → 20 — fine within the new subfolder.
  • New _category_.json files are missing a trailing newline. Cosmetic only.
  • No security issues, no workflow/CI changes, no products.js / docusaurus.config.js logic changes.

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