Skip to content

DOCS-2724 / 27 / Docs 2724 smb audit documentation is misleading - #4786

Open
DjP-iX wants to merge 2 commits into
masterfrom
DOCS-2724-smb-audit-documentation-is-misleading
Open

DOCS-2724 / 27 / Docs 2724 smb audit documentation is misleading#4786
DjP-iX wants to merge 2 commits into
masterfrom
DOCS-2724-smb-audit-documentation-is-misleading

Conversation

@DjP-iX

@DjP-iX DjP-iX commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Updates SMB auditing documentation inconsistencies identified in the ticket.

Also updates the title of the Audit Logs tutorial to use a gerund form title, matching the convention for other tutorials.

Thanks for contributing to TrueNAS documentation! By opening a Pull Request, you're acknowledging that your changes will be distributed under the Creative Commons 4.0 license.

@DjP-iX
DjP-iX requested a review from a team as a code owner September 8, 2026 17:46
@bugclerk bugclerk changed the title Docs 2724 smb audit documentation is misleading DOCS-2724 / 27 / Docs 2724 smb audit documentation is misleading Sep 8, 2026
@bugclerk

bugclerk commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown

Vale Style Guide Issues

📊 Summary: 82 issues found in changed files - 6 errors, 0 warnings, 76 suggestions

Changed files with issues:

content/SCALE/SystemSettings/Audit/Auditing.md (70 issues)

  • Line 25 - suggestion: Spell out 'USER' on first use
  • Line 27 - suggestion: Spell out 'INFO' on first use
  • Line 32 - suggestion: Spell out 'VFS' on first use
  • Lines 55, 61, 65, 70, 75, 81, 90, 110, 115, 119, 150, 168, 185, 199, 213 - suggestion: Use active voice instead of passive voice
  • Lines 82, 109, 114 - suggestion: Keep sentences under 30 words
  • Lines 96, 103 - suggestion: Spell out 'TCON' on first use
  • Lines 119, 136 - error: Use 'filesystem' instead of 'file system'
  • Lines 125, 129 - suggestion: Spell out 'DOS' on first use
  • Line 136 - suggestion: Spell out 'OWNER' on first use
  • Lines 148, 152, 153, 154, 157, 213, 217 - suggestion: Spell out 'JSON' on first use
  • Lines 152, 213 - suggestion: Spell out 'YAML' on first use
  • Line 198 - suggestion: Spell out 'CLOSE' on first use
  • Line 201 - suggestion: Spell out 'SQL' on first use
  • Line 201 - suggestion: Spell out 'JQL' on first use
  • Line 229 - error: Use a numeral plus the units.

static/includes/ConfigureSMBShareAuditingSCALE.md (12 issues)

  • Lines 6, 42, 47 - suggestion: Use active voice instead of passive voice
  • Lines 17, 39 - suggestion: Keep sentences under 30 words
  • Line 39 - error: Avoid possessive forms ('user's'). Rephrase to avoid using apostrophes for possession.
  • Line 51 - error: Use 'could' instead of 'may'

🔧 To fix: Review the issues above and update your documentation accordingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants