DOCS-2724 / 26 / Docs 2724 smb audit documentation is misleading (by DjP-iX)

[bugclerk]

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.

Original PR: #4786
Jira URL: https://ixsystemsinc.atlassian.net/browse/DOCS-2724

[github-actions]

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

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

Changed files with issues:

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

• Line 24 - suggestion: Spell out 'USER' on first use
• Line 26 - suggestion: Spell out 'INFO' on first use
• Line 31 - suggestion: Spell out 'VFS' on first use
• Lines 54, 60, 64, 69, 74, 80, 89, 109, 114, 118, 149, 167, 184, 198, 212 - suggestion: Use active voice instead of passive voice
• Lines 81, 108, 113 - suggestion: Keep sentences under 30 words
• Lines 95, 102 - suggestion: Spell out 'TCON' on first use
• Lines 118, 135 - error: Use 'filesystem' instead of 'file system'
• Lines 124, 128 - suggestion: Spell out 'DOS' on first use
• Line 135 - suggestion: Spell out 'OWNER' on first use
• Lines 147, 151, 152, 153, 156, 212, 216 - suggestion: Spell out 'JSON' on first use
• Lines 151, 212 - suggestion: Spell out 'YAML' on first use
• Line 197 - suggestion: Spell out 'CLOSE' on first use
• Line 200 - suggestion: Spell out 'SQL' on first use
• Line 200 - suggestion: Spell out 'JQL' on first use
• Line 228 - 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.

[github-actions]

Vale Style Guide Issues

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

Changed files with issues:

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

• Line 24 - suggestion: Spell out 'USER' on first use
• Line 26 - suggestion: Spell out 'INFO' on first use
• Line 31 - suggestion: Spell out 'VFS' on first use
• Lines 54, 60, 64, 69, 74, 80, 89, 109, 114, 118, 149, 167, 184, 198, 212 - suggestion: Use active voice instead of passive voice
• Lines 81, 108, 113 - suggestion: Keep sentences under 30 words
• Lines 95, 102 - suggestion: Spell out 'TCON' on first use
• Lines 118, 135 - error: Use 'filesystem' instead of 'file system'
• Lines 124, 128 - suggestion: Spell out 'DOS' on first use
• Line 135 - suggestion: Spell out 'OWNER' on first use
• Lines 147, 151, 152, 153, 156, 212, 216 - suggestion: Spell out 'JSON' on first use
• Lines 151, 212 - suggestion: Spell out 'YAML' on first use
• Line 197 - suggestion: Spell out 'CLOSE' on first use
• Line 200 - suggestion: Spell out 'SQL' on first use
• Line 200 - suggestion: Spell out 'JQL' on first use
• Line 228 - 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.

[bugclerk]

This PR has been merged and conversations have been locked.
If you would like to discuss more about this issue please use our forums or raise a Jira ticket.