Skip to content

docs(changetracker): rename Splunk and VMware integration pages to descriptive filenames#1164

Merged
jth-nw merged 7 commits into
devfrom
DanPiazza-Netwrix/rename-splunk-and-vmware
Jun 24, 2026
Merged

docs(changetracker): rename Splunk and VMware integration pages to descriptive filenames#1164
jth-nw merged 7 commits into
devfrom
DanPiazza-Netwrix/rename-splunk-and-vmware

Conversation

@DanPiazza-Netwrix

Copy link
Copy Markdown
Contributor

Summary

  • Renames overview_1.mdsplunk.md and overview_2.mdvmware.md across Change Tracker versions 8.0, 8.1, and 8.2
  • Updates the corresponding cross-reference links in each version's integration/overview.md
  • Fixes URLs that were generic (/integration/overview_1, /integration/overview_2) instead of descriptive (/integration/splunk, /integration/vmware)

Test plan

  • Verify /docs/changetracker/8_2/integration/splunk and /docs/changetracker/8_2/integration/vmware resolve correctly in the build
  • Confirm old URLs (overview_1, overview_2) no longer appear in the built site
  • Check links from the integration overview pages in all three versions

Generated with AI

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

Renames generic filenames to content-specific names so URLs reflect
the actual topic (Splunk, VMware) across all three versions (8.0, 8.1, 8.2).
Updates cross-references in each version's integration overview page.

Generated with AI

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

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

174 issues fixed, 3 skipped across 9 files

Category Fixes
Contractions 3
Removed filler 3
Substitutions 9
DesiredAsAdjective (rewrite) 3
FollowTheStepsTo (rewrite) 15
OxfordComma (rewrite) 6
Dale: misplaced-modifiers 3
Dale: passive-voice 99
Dale: positional-references 9
Dale: wordiness 24
Skipped (needs manual review) Reason

| docs/changetracker/8.0/integration/splunk.md:35 — Dale: passive-voice | 'The Splunk credentials are updated' is a result-confirmation of the user's action; an active rewrite would require inventing a system subject and shift emphasis away from the outcome |
| docs/changetracker/8.1/integration/splunk.md:35 — Dale: passive-voice | 'The Splunk credentials are updated' is a result-confirmation of the user's action; an active rewrite would require inventing a system subject and shift emphasis away from the outcome |
| docs/changetracker/8.2/integration/splunk.md:35 — Dale: passive-voice | 'The Splunk credentials are updated' is a result-confirmation of the user's action; an active rewrite would require inventing a system subject and shift emphasis away from the outcome |

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

@DanPiazza-Netwrix

Copy link
Copy Markdown
Contributor Author

@claude fix all issues

@github-actions

github-actions Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Fix complete:

  • Fix "VMWare" → "VMware" link text in docs/changetracker/8.0/integration/overview.md
  • Fix "VMWare" → "VMware" link text in docs/changetracker/8.1/integration/overview.md
  • Fix "VMWare" → "VMware" link text in docs/changetracker/8.2/integration/overview.md
  • Commit and push

Summary:

Applied all 3 editorial suggestions from the review. Each version's integration/overview.md used the incorrect brand capitalization "VMWare" in the Splunk/VMware integration list. Corrected the link text to "VMware" (the vendor's official capitalization, lowercase "w") in all three files. The vmware.md filenames were already correct and left unchanged.

Pushed as commit 0ec7ac949.

github-actions Bot and others added 2 commits June 24, 2026 14:07
Correct VMware brand capitalization in integration overview link text
across Change Tracker 8.0, 8.1, and 8.2.

Co-Authored-By: Claude <noreply@anthropic.com>
Correct 'VMWare' to 'VMware' (vendor's official brand capitalization)
across the integration overview links and the VMware integration pages
in versions 8.0, 8.1, and 8.2. Also fixes the PowerShell module name to
'VMware.PowerCLI'.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Fixed all the VMWare → VMware brand-capitalization issues (VMware uses a lowercase "w").

The doc-pr review only flagged the link text in each integration/overview.md, but "VMWare" also appeared throughout the integration pages themselves. To fully resolve the issue, I corrected every occurrence:

  • Overview link text (8.0, 8.1, 8.2 integration/overview.md) — already corrected by an earlier automated fix.
  • integration/vmware.md (8.0, 8.1, 8.2) — fixed in the frontmatter title/description, the # VMware heading, the intro sentence ("vSphere is VMware's virtualization platform"), and the PowerShell module reference (VMware.PowerCLI).

All "VMWare" occurrences across docs/changetracker are now gone. Pushed as 02242d9.

@github-actions

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

0 issues fixed, 9 skipped across 9 files

Skipped (needs manual review) Reason

| docs/changetracker/8.0/integration/splunk.md:34 — Dale: passive-voice | Conventional system-result confirmation; an active rewrite requires assuming the actor and verb, risking a change in meaning. |
| docs/changetracker/8.0/integration/splunk.md:11 — Dale: wordiness | Removing 'that can monitor' to reduce redundancy would drop the capability nuance carried by 'can'. |
| docs/changetracker/8.0/integration/vmware.md:65 — Dale: idioms | 'keep up with' is borderline-common phrasing, not a clear idiom; rewriting risks altering tone without clear benefit. |
| docs/changetracker/8.1/integration/splunk.md:34 — Dale: passive-voice | Conventional system-result confirmation; an active rewrite requires assuming the actor and verb, risking a change in meaning. |
| docs/changetracker/8.1/integration/splunk.md:11 — Dale: wordiness | Removing 'that can monitor' to reduce redundancy would drop the capability nuance carried by 'can'. |
| docs/changetracker/8.1/integration/vmware.md:65 — Dale: idioms | 'keep up with' is borderline-common phrasing, not a clear idiom; rewriting risks altering tone without clear benefit. |
| docs/changetracker/8.2/integration/splunk.md:34 — Dale: passive-voice | Conventional system-result confirmation; an active rewrite requires assuming the actor and verb, risking a change in meaning. |
| docs/changetracker/8.2/integration/splunk.md:11 — Dale: wordiness | Removing 'that can monitor' to reduce redundancy would drop the capability nuance carried by 'can'. |
| docs/changetracker/8.2/integration/vmware.md:65 — Dale: idioms | 'keep up with' is borderline-common phrasing, not a clear idiom; rewriting risks altering tone without clear benefit. |

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

@github-actions

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

3 issues fixed, 4 skipped across 9 files

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

| docs/changetracker/8.0/integration/splunk.md:60 — Dale: passive-voice | 'Any further fields added appear...' uses a reduced relative clause as an adjective; main verb is active. Converting risks over-editing. |
| docs/changetracker/8.0/integration/splunk.md:9 — Dale: undefined-acronyms | SPL is spelled out as 'Search Processing Language (SPL)' on first use; no undefined acronyms in body prose. |
| docs/changetracker/8.0/integration/vmware.md:9 — Dale: undefined-acronyms | CIS is a recognized security industry standard (Center for Internet Security) familiar to the security audience; CEIP appears only inside a command parameter literal. |
| docs/changetracker/8.0/integration/vmware.md:49 — Dale: positional-references | 'scroll down to' references a UI action/element, not a content cross-reference; no 'above'/'below' content references present. |

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

@github-actions

Copy link
Copy Markdown
Contributor

Documentation PR Review

This PR renames the Splunk and VMware integration topics (overview_1.mdsplunk.md, overview_2.mdvmware.md), corrects the product name VMWareVMware, updates the integration overview links, and rewrites passive/wordy phrasing across all three versions (8.0, 8.1, 8.2). The Splunk and VMware content is identical across versions, so the same findings apply to each version's pair of files. The rewrites are a clear improvement — the items below are what remains.

Editorial Review

docs/changetracker/8.0/integration/overview.md
docs/changetracker/8.1/integration/overview.md
docs/changetracker/8.2/integration/overview.md

  • No issues found. The link text and targets now match the renamed files, and VMware is capitalized correctly.

docs/changetracker/8.0/integration/splunk.md
docs/changetracker/8.1/integration/splunk.md
docs/changetracker/8.2/integration/splunk.md

  • Clarity:::note block ("Change Tracker ignores events without a matching device"): the rewritten sentence is missing its terminal period. Suggested fix: end the line with a period — "...Change Tracker ignores events without a matching device."
  • Completeness — "Splunk's SPL query language is similar to SQL" (Policy Templates intro): SQL is used without expansion. The audience includes newer users, and docs/CLAUDE.md requires acronyms be defined on first use. Suggested fix: spell out on first use — "similar to Structured Query Language (SQL)" — or confirm SQL is treated as a universally known term for this audience.

docs/changetracker/8.0/integration/vmware.md
docs/changetracker/8.1/integration/vmware.md
docs/changetracker/8.2/integration/vmware.md

  • Completeness — Line 9: "Change Tracker includes CIS certified compliance tracking templates" introduces the acronym CIS without defining it. docs/CLAUDE.md requires spelling out acronyms on first use. Suggested fix: "Center for Internet Security (CIS) certified compliance tracking templates" on first mention.

Summary

3 editorial suggestions across 9 files (the Splunk and VMware findings repeat across the 8.0, 8.1, and 8.2 copies; the three overview files are clean). The rename, capitalization fix, and voice rewrites are otherwise well done. 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

6 issues fixed, 2 skipped across 9 files

Category Fixes
Dale: misplaced-modifiers 6
Skipped (needs manual review) Reason

| docs/changetracker/8.0/integration/splunk.md:60 — Dale: passive-voice | 'Any further fields added appear...' uses a reduced relative clause that reads adjectivally; rewriting to active risks changing nuance, so skipped per low confidence. |
| docs/changetracker/8.0/integration/vmware.md:9 — Dale: undefined-acronyms | 'CIS' is a well-known security industry standard (Center for Internet Security benchmarks) familiar to the security-analyst audience, so define-on-first-use does not apply. |

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

@DanPiazza-Netwrix

Copy link
Copy Markdown
Contributor Author

@claude fix all issues

@jth-nw jth-nw merged commit 3f95378 into dev Jun 24, 2026
10 checks passed
@github-actions

github-actions Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Fix complete:

  • Add missing terminal period in the :::note block (splunk.md × 3)
  • Spell out SQL on first use → "Structured Query Language (SQL)" (splunk.md × 3)
  • Define CIS on first use → "Center for Internet Security (CIS)" (vmware.md × 3)
  • Verify changes

Summary:

All three editorial suggestions from the latest review are now applied across versions 8.0, 8.1, and 8.2 (commit 8160cbe4d):

  • integration/splunk.md — Added the missing terminal period to the device-matching :::note ("…without a matching device."), and spelled out SQL on first use as "Structured Query Language (SQL)".
  • integration/vmware.md — Defined CIS on first use as "Center for Internet Security (CIS)".

The three integration/overview.md files were already clean (correct link text, VMware capitalization), so no changes were needed there. The branch now resolves all editorial findings.

@github-actions

github-actions Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Fix complete:

  • Add missing terminal period to :::note block in splunk.md (8.0, 8.1, 8.2)
  • Spell out SQL on first use in splunk.md (8.0, 8.1, 8.2)
  • Define CIS acronym on first use in vmware.md (8.0, 8.1, 8.2)
  • Verify changes
  • Commit and push

Summary:

Applied all 3 editorial suggestions from the doc-pr review across Change Tracker versions 8.0, 8.1, and 8.2:

  • integration/splunk.md — Added the missing terminal period to the device-matching :::note block ("...Change Tracker ignores events without a matching device.") and spelled out the acronym on first use as "Structured Query Language (SQL)".
  • integration/vmware.md — Defined the acronym on first use as "Center for Internet Security (CIS) certified compliance tracking templates".

Pushed as commit 8160cbe4d.

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