Skip to content

docs: apply fixes from PR review#1168

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

docs: apply fixes from PR review#1168
jth-nw merged 1 commit into
devfrom
DanPiazza-Netwrix/rename-splunk-and-vmware

Conversation

@jth-nw

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

Copy link
Copy Markdown
Collaborator
  • Add missing terminal period to the device-matching :::note in splunk.md
  • Spell out Structured Query Language (SQL) on first use in splunk.md
  • Define Center for Internet Security (CIS) on first use in vmware.md

Applied across Change Tracker versions 8.0, 8.1, and 8.2.

- Add missing terminal period to the device-matching :::note in splunk.md
- Spell out Structured Query Language (SQL) on first use in splunk.md
- Define Center for Internet Security (CIS) on first use in vmware.md

Applied across Change Tracker versions 8.0, 8.1, and 8.2.

Co-Authored-By: Claude <noreply@anthropic.com>
@jth-nw jth-nw requested a review from a team as a code owner June 24, 2026 16:31
@jth-nw jth-nw merged commit 7a4b240 into dev Jun 24, 2026
7 of 8 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/changetracker/8.0/integration/splunk.md

  • No issues found.

docs/changetracker/8.0/integration/vmware.md

  • No issues found.

docs/changetracker/8.1/integration/splunk.md

  • No issues found.

docs/changetracker/8.1/integration/vmware.md

  • No issues found.

docs/changetracker/8.2/integration/splunk.md

  • No issues found.

docs/changetracker/8.2/integration/vmware.md

  • No issues found.

These changes are clean acronym expansions that bring the content into line with the Netwrix rule to spell out acronyms on first use:

  • SplunkSQLStructured Query Language (SQL). Verified this is the first use of SQL in the document (SPL was already expanded earlier), so the placement is correct. Also adds a missing period to the sentence in the :::note block — a clean punctuation fix.
  • VMwareCISCenter for Internet Security (CIS) on first use. Correct.

All three versions (8.0, 8.1, 8.2) received identical, consistent edits.

Summary

0 editorial suggestions across 6 files. The acronym expansions and punctuation fix are correct and consistent across all versions. 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

0 issues fixed, 6 skipped across 6 files

Skipped (needs manual review) Reason

| docs/changetracker/8.0/integration/splunk.md:14 — Dale: passive-voice | Reduced relative clause 'executed via the Splunk API' modifies the query; an active rewrite would awkwardly duplicate 'Change Tracker' as the subject and is already credited in the same sentence. |
| docs/changetracker/8.1/integration/splunk.md:14 — Dale: passive-voice | Reduced relative clause 'executed via the Splunk API' modifies the query; an active rewrite would awkwardly duplicate 'Change Tracker' as the subject and is already credited in the same sentence. |
| docs/changetracker/8.2/integration/splunk.md:14 — Dale: passive-voice | Reduced relative clause 'executed via the Splunk API' modifies the query; an active rewrite would awkwardly duplicate 'Change Tracker' as the subject and is already credited in the same sentence. |
| docs/changetracker/8.0/integration/vmware.md:66 — Dale: passive-voice | Descriptive passive 'ESXi nodes are frequently created, removed, or migrated' has no clearly stated actor; an active rewrite would require inventing one (e.g., 'administrators'), changing the meaning. |
| docs/changetracker/8.1/integration/vmware.md:66 — Dale: passive-voice | Descriptive passive 'ESXi nodes are frequently created, removed, or migrated' has no clearly stated actor; an active rewrite would require inventing one (e.g., 'administrators'), changing the meaning. |
| docs/changetracker/8.2/integration/vmware.md:66 — Dale: passive-voice | Descriptive passive 'ESXi nodes are frequently created, removed, or migrated' has no clearly stated actor; an active rewrite would require inventing one (e.g., 'administrators'), changing the meaning. |

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

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.

1 participant