PD-2437 / 25.10 / Pd 2437 auditing field changes

[DjP-iX]

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.

[bugclerk]

Jira URL: https://ixsystems.atlassian.net/browse/PD-2437

[github-actions]

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 211 issues found in changed files - 19 errors, 4 warnings, 188 suggestions

Changed files with issues:

content/SCALEUIReference/Shares/SMBSharesScreens.md (110 issues)

• Lines 14, 20, 29, 35, 72, 73, 103, 104, 106, 107, 108, 114, 132, 139, 152, 153, 154, 163, 170, 174, 182, 188, 196, 200, 207, 208, 209, 220, 236, 239, 240, 265, 275 - suggestion: Use active voice instead of passive voice
• Lines 29, 72, 73, 242 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
• Lines 35, 90, 220, 222, 239, 261, 293 - suggestion: Keep sentences under 30 words
• Line 45 - error: 'delete' is repeated!
• Line 62 - suggestion: Use Oxford comma before 'and' in lists
• Line 103 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'
• Lines 103, 241, 258, 287 - error: Use 'filesystem' instead of 'file system'
• Line 182 - error: Form a negative number with an en dash, not a hyphen.
• Line 237 - error: Don't use 'backend'. See the A-Z word list for details.
• Line 299 - error: Use 'hostname' instead of 'host name'
• Line 302 - suggestion: Spell out 'UID' on first use
• Line 303 - suggestion: Spell out 'GID' on first use
• Line 306 - suggestion: Spell out 'GCM' on first use
• Line 312 - suggestion: Spell out 'SBM' on first use

content/SCALETutorials/SystemSettings/AuditingSCALE.md (62 issues)

• Line 20 - suggestion: Spell out 'USER' on first use
• Line 22 - suggestion: Spell out 'INFO' on first use
• Line 27 - suggestion: Spell out 'VFS' on first use
• Lines 51, 57, 61, 67, 93, 95, 101, 103, 107, 138, 156, 173, 187, 201 - suggestion: Use active voice instead of passive voice
• Line 68 - suggestion: Keep sentences under 30 words
• Lines 78, 85 - suggestion: Spell out 'TCON' on first use
• Lines 107, 124 - error: Use 'filesystem' instead of 'file system'
• Lines 113, 117 - suggestion: Spell out 'DOS' on first use
• Line 124 - suggestion: Spell out 'OWNER' on first use
• Lines 136, 140, 141, 142, 145, 201, 205 - suggestion: Spell out 'JSON' on first use
• Lines 140, 201 - suggestion: Spell out 'YAML' on first use
• Line 186 - suggestion: Spell out 'CLOSE' on first use
• Line 189 - suggestion: Spell out 'SQL' on first use
• Line 189 - suggestion: Spell out 'JQL' on first use
• Line 217 - error: Use a numeral plus the units.

content/SCALEUIReference/Credentials/BackupCredentials/SSHCredentialScreens.md (20 issues)

• Lines 14, 45, 57, 59, 73, 101, 112 - suggestion: Use active voice instead of passive voice
• Lines 56, 73 - warning: For a general audience, use 'address' rather than 'URL'.
• Lines 56, 73 - error: Use 'hostname' instead of 'host name'
• Line 60 - suggestion: Use 'login' instead of 'log in'
• Line 60 - error: Use 'login' instead of 'log in'

static/includes/ConfigureSMBShareAuditingSCALE.md (10 issues)

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

content/SCALEUIReference/SystemSettings/AuditScreen.md (9 issues)

• Line 33 - suggestion: Use active voice instead of passive voice
• Line 38 - suggestion: Spell out 'VFS' on first use
• Lines 53, 64 - suggestion: Spell out 'JSON' on first use
• Line 53 - suggestion: Spell out 'YAML' on first use
• Line 53 - error: Avoid possessive forms ('browser's'). Rephrase to avoid using apostrophes for possession.
• Line 64 - suggestion: Keep sentences under 30 words

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

[github-actions]

Vale Style Guide Issues

📊 Summary: 191 issues found in changed files - 16 errors, 0 warnings, 175 suggestions

Changed files with issues:

content/SCALEUIReference/Shares/SMBSharesScreens.md (110 issues)

• Lines 14, 20, 29, 35, 72, 73, 103, 104, 106, 107, 108, 114, 132, 139, 152, 153, 154, 163, 170, 174, 182, 188, 196, 200, 207, 208, 209, 220, 236, 239, 240, 265, 275 - suggestion: Use active voice instead of passive voice
• Lines 29, 72, 73, 242 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
• Lines 35, 90, 220, 222, 239, 261, 293 - suggestion: Keep sentences under 30 words
• Line 45 - error: 'delete' is repeated!
• Line 62 - suggestion: Use Oxford comma before 'and' in lists
• Line 103 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'
• Lines 103, 241, 258, 287 - error: Use 'filesystem' instead of 'file system'
• Line 182 - error: Form a negative number with an en dash, not a hyphen.
• Line 237 - error: Don't use 'backend'. See the A-Z word list for details.
• Line 299 - error: Use 'hostname' instead of 'host name'
• Line 302 - suggestion: Spell out 'UID' on first use
• Line 303 - suggestion: Spell out 'GID' on first use
• Line 306 - suggestion: Spell out 'GCM' on first use
• Line 312 - suggestion: Spell out 'SBM' on first use

content/SCALETutorials/SystemSettings/AuditingSCALE.md (62 issues)

• Line 20 - suggestion: Spell out 'USER' on first use
• Line 22 - suggestion: Spell out 'INFO' on first use
• Line 27 - suggestion: Spell out 'VFS' on first use
• Lines 51, 57, 61, 67, 93, 95, 101, 103, 107, 138, 156, 173, 187, 201 - suggestion: Use active voice instead of passive voice
• Line 68 - suggestion: Keep sentences under 30 words
• Lines 78, 85 - suggestion: Spell out 'TCON' on first use
• Lines 107, 124 - error: Use 'filesystem' instead of 'file system'
• Lines 113, 117 - suggestion: Spell out 'DOS' on first use
• Line 124 - suggestion: Spell out 'OWNER' on first use
• Lines 136, 140, 141, 142, 145, 201, 205 - suggestion: Spell out 'JSON' on first use
• Lines 140, 201 - suggestion: Spell out 'YAML' on first use
• Line 186 - suggestion: Spell out 'CLOSE' on first use
• Line 189 - suggestion: Spell out 'SQL' on first use
• Line 189 - suggestion: Spell out 'JQL' on first use
• Line 217 - error: Use a numeral plus the units.

static/includes/ConfigureSMBShareAuditingSCALE.md (10 issues)

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

content/SCALEUIReference/SystemSettings/AuditScreen.md (9 issues)

• Line 33 - suggestion: Use active voice instead of passive voice
• Line 38 - suggestion: Spell out 'VFS' on first use
• Lines 53, 64 - suggestion: Spell out 'JSON' on first use
• Line 53 - suggestion: Spell out 'YAML' on first use
• Line 53 - error: Avoid possessive forms ('browser's'). Rephrase to avoid using apostrophes for possession.
• Line 64 - suggestion: Keep sentences under 30 words

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