Skip to content

Pd 2271 smb stateful failover#4456

Merged
micjohnson777 merged 14 commits intomasterfrom
PD-2271-smb-stateful-failover
Mar 9, 2026
Merged

Pd 2271 smb stateful failover#4456
micjohnson777 merged 14 commits intomasterfrom
PD-2271-smb-stateful-failover

Conversation

@DjP-iX
Copy link
Contributor

@DjP-iX DjP-iX commented Mar 3, 2026

  • SMB service screen (SMBServicesScreen.md): Added Stateful Failover field to the Advanced Settings table with HA/Enterprise requirements and incompatibility callouts; updated screenshot
  • SMB shares screens (SMBSharesScreens.md): Added Stateful Failover incompatibility notes to the Multi-Protocol Share purpose description and Legacy Share Settings section
  • SMB tutorial (AddManageSMBShares.md): Added Enabling SMB Stateful Failover section with prerequisites, 4-step procedure, and a warning that Stateful Failover must be disabled before upgrading
  • UpdateHA.md: Added prerequisite hint to disable Stateful Failover before updating, with steps and a cross-reference to the tutorial
  • VersionNotes.md: Replaced 26 Nightly Changes placeholder with SMB Stateful Failover notable change entry
  • Restored missing includes: 26FeatureList.md and 26UpgradeMethods.md were lost during version renaming; recreated at the correct paths referenced by VersionNotes.md and _index.md

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 March 3, 2026 16:36
@github-actions
Copy link

github-actions bot commented Mar 3, 2026 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 266 issues found in changed files - 25 errors, 7 warnings, 234 suggestions

Changed files with issues:

content/SCALE/Shares/SMB/SMBSharesScreens.md (135 issues)

  • Lines 20, 26, 35, 41, 78, 79, 98, 111, 112, 114, 115, 116, 122, 140, 147, 148, 181, 182, 183, 192, 199, 203, 211, 217, 225, 229, 236, 237, 238, 242, 251, 268, 277, 282, 308, 311, 312, 338, 348 - suggestion: Use active voice instead of passive voice
  • Lines 35, 78, 79, 148, 174, 181, 314 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 41, 96, 98, 268, 270, 311, 334, 366 - suggestion: Keep sentences under 30 words
  • Line 51 - error: 'delete' is repeated!
  • Line 102 - suggestion: Try to simplify this sentence.
  • Line 111 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'
  • Lines 111, 313, 331, 360 - error: Use 'filesystem' instead of 'file system'
  • Lines 149, 150, 372 - error: Use 'hostname' instead of 'host name'
  • Lines 211, 317 - error: Form a negative number with an en dash, not a hyphen.
  • Line 277 - suggestion: Spell out 'VFS' on first use
  • Line 309 - error: Don't use 'backend'. See the A-Z word list for details.
  • Line 375 - suggestion: Spell out 'UID' on first use
  • Line 376 - suggestion: Spell out 'GID' on first use
  • Line 379 - suggestion: Spell out 'GCM' on first use
  • Line 385 - suggestion: Spell out 'SBM' on first use

content/SCALE/Shares/SMB/AddManageSMBShares.md (81 issues)

  • Lines 25, 281 - warning: Use first person (such as ' I') sparingly.
  • Line 25 - warning: Don't use end punctuation in headings.
  • Lines 29, 46, 67, 81, 102, 107, 150, 155, 159, 163, 169, 173, 177, 195, 221, 241, 318, 475, 524 - suggestion: Use active voice instead of passive voice
  • Lines 41, 46, 74, 117, 118, 320, 393, 406, 501, 506, 515, 521 - suggestion: Keep sentences under 30 words
  • Line 63 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 128 - error: Use 'filesystem' instead of 'file system'
  • Lines 166, 509 - suggestion: Spell out 'SHARE' on first use
  • Lines 221, 286 - error: Use 'after' instead of 'once'
  • Lines 257, 263, 470 - error: Use 'hostname' instead of 'host name'
  • Line 281 - error: Avoid contractions. Use 'cannot' instead of 'can't'.
  • Lines 306, 307, 324, 325 - suggestion: Spell out 'NTFS' on first use
  • Line 309 - suggestion: Spell out 'FSRVP' on first use
  • Line 312 - suggestion: Spell out 'VUID' on first use
  • Line 367 - error: Use 'filesystem' instead of 'File System'
  • Line 465 - suggestion: Spell out 'YES' on first use

content/SCALE/SystemSettings/Update/UpdateHA.md (18 issues)

  • Lines 23, 38, 39, 85 - suggestion: Use active voice instead of passive voice
  • Lines 43, 92 - error: Use 'login' instead of 'log in'
  • Line 43 - suggestion: Spell out 'VIP' on first use
  • Line 70 - suggestion: Use 'signin' instead of 'Sign in'
  • Line 70 - suggestion: Use 'signin' instead of 'sign in'
  • Line 82 - suggestion: Keep sentences under 30 words
  • Line 83 - suggestion: Use Oxford comma before 'and' in lists
  • Line 92 - suggestion: Use 'login' instead of 'log in'

content/SCALE/GettingStarted/VersionNotes.md (13 issues)

  • Line 51 - suggestion: Try to simplify this sentence.
  • Lines 55, 217 - suggestion: Use active voice instead of passive voice
  • Line 59 - error: Remove the spaces around ' — '.
  • Line 135 - suggestion: Keep sentences under 30 words
  • Line 135 - warning: Use first person (such as 'My') sparingly.
  • Line 140 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 146 - suggestion: 'TrueNAS Apps' should use sentence-style capitalization.

content/SCALE/TopToolbar/TopToolbarScreens.md (13 issues)

  • Line 32 - suggestion: Use 'signup' instead of 'sign up'
  • Line 33 - suggestion: Keep sentences under 30 words
  • Line 34 - suggestion: Try to simplify this sentence.
  • Lines 38, 77, 81 - suggestion: Use active voice instead of passive voice
  • Lines 38, 77, 83 - warning: Use first person (such as 'My') sparingly.

content/SCALE/SystemSettings/Services/SMBServicesScreen.md (6 issues)

  • Line 24 - suggestion: 'Basic Settings' should use sentence-style capitalization.
  • Lines 38, 52 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 51 - suggestion: Use active voice instead of passive voice
  • Line 51 - error: Don't add '(s)' to a singular noun. Use plural instead.

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

@github-actions
Copy link

github-actions bot commented Mar 4, 2026 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 266 issues found in changed files - 25 errors, 7 warnings, 234 suggestions

Changed files with issues:

content/SCALE/Shares/SMB/SMBSharesScreens.md (135 issues)

  • Lines 20, 26, 35, 41, 78, 79, 98, 111, 112, 114, 115, 116, 122, 140, 147, 148, 181, 182, 183, 192, 199, 203, 211, 217, 225, 229, 236, 237, 238, 242, 251, 268, 277, 282, 308, 311, 312, 338, 348 - suggestion: Use active voice instead of passive voice
  • Lines 35, 78, 79, 148, 174, 181, 314 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 41, 96, 98, 268, 270, 311, 334, 366 - suggestion: Keep sentences under 30 words
  • Line 51 - error: 'delete' is repeated!
  • Line 102 - suggestion: Try to simplify this sentence.
  • Line 111 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'
  • Lines 111, 313, 331, 360 - error: Use 'filesystem' instead of 'file system'
  • Lines 149, 150, 372 - error: Use 'hostname' instead of 'host name'
  • Lines 211, 317 - error: Form a negative number with an en dash, not a hyphen.
  • Line 277 - suggestion: Spell out 'VFS' on first use
  • Line 309 - error: Don't use 'backend'. See the A-Z word list for details.
  • Line 375 - suggestion: Spell out 'UID' on first use
  • Line 376 - suggestion: Spell out 'GID' on first use
  • Line 379 - suggestion: Spell out 'GCM' on first use
  • Line 385 - suggestion: Spell out 'SBM' on first use

content/SCALE/Shares/SMB/AddManageSMBShares.md (81 issues)

  • Lines 25, 281 - warning: Use first person (such as ' I') sparingly.
  • Line 25 - warning: Don't use end punctuation in headings.
  • Lines 29, 46, 67, 81, 102, 107, 150, 155, 159, 163, 169, 173, 177, 195, 221, 241, 318, 475, 524 - suggestion: Use active voice instead of passive voice
  • Lines 41, 46, 74, 117, 118, 320, 393, 406, 501, 506, 515, 521 - suggestion: Keep sentences under 30 words
  • Line 63 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 128 - error: Use 'filesystem' instead of 'file system'
  • Lines 166, 509 - suggestion: Spell out 'SHARE' on first use
  • Lines 221, 286 - error: Use 'after' instead of 'once'
  • Lines 257, 263, 470 - error: Use 'hostname' instead of 'host name'
  • Line 281 - error: Avoid contractions. Use 'cannot' instead of 'can't'.
  • Lines 306, 307, 324, 325 - suggestion: Spell out 'NTFS' on first use
  • Line 309 - suggestion: Spell out 'FSRVP' on first use
  • Line 312 - suggestion: Spell out 'VUID' on first use
  • Line 367 - error: Use 'filesystem' instead of 'File System'
  • Line 465 - suggestion: Spell out 'YES' on first use

content/SCALE/SystemSettings/Update/UpdateHA.md (18 issues)

  • Lines 23, 38, 39, 85 - suggestion: Use active voice instead of passive voice
  • Lines 43, 92 - error: Use 'login' instead of 'log in'
  • Line 43 - suggestion: Spell out 'VIP' on first use
  • Line 70 - suggestion: Use 'signin' instead of 'Sign in'
  • Line 70 - suggestion: Use 'signin' instead of 'sign in'
  • Line 82 - suggestion: Keep sentences under 30 words
  • Line 83 - suggestion: Use Oxford comma before 'and' in lists
  • Line 92 - suggestion: Use 'login' instead of 'log in'

content/SCALE/GettingStarted/VersionNotes.md (13 issues)

  • Line 51 - suggestion: Try to simplify this sentence.
  • Lines 55, 217 - suggestion: Use active voice instead of passive voice
  • Line 59 - error: Remove the spaces around ' — '.
  • Line 135 - suggestion: Keep sentences under 30 words
  • Line 135 - warning: Use first person (such as 'My') sparingly.
  • Line 140 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 146 - suggestion: 'TrueNAS Apps' should use sentence-style capitalization.

content/SCALE/TopToolbar/TopToolbarScreens.md (13 issues)

  • Line 32 - suggestion: Use 'signup' instead of 'sign up'
  • Line 33 - suggestion: Keep sentences under 30 words
  • Line 34 - suggestion: Try to simplify this sentence.
  • Lines 38, 77, 81 - suggestion: Use active voice instead of passive voice
  • Lines 38, 77, 83 - warning: Use first person (such as 'My') sparingly.

content/SCALE/SystemSettings/Services/SMBServicesScreen.md (6 issues)

  • Line 24 - suggestion: 'Basic Settings' should use sentence-style capitalization.
  • Lines 38, 52 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 51 - suggestion: Use active voice instead of passive voice
  • Line 51 - error: Don't add '(s)' to a singular noun. Use plural instead.

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

@github-actions
Copy link

github-actions bot commented Mar 9, 2026 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 253 issues found in changed files - 25 errors, 4 warnings, 224 suggestions

Changed files with issues:

content/SCALE/Shares/SMB/SMBSharesScreens.md (135 issues)

  • Lines 20, 26, 35, 41, 78, 79, 98, 111, 112, 114, 115, 116, 122, 140, 147, 148, 181, 182, 183, 192, 199, 203, 211, 217, 225, 229, 236, 237, 238, 242, 251, 268, 277, 282, 308, 311, 312, 338, 348 - suggestion: Use active voice instead of passive voice
  • Lines 35, 78, 79, 148, 174, 181, 314 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 41, 96, 98, 268, 270, 311, 334, 366 - suggestion: Keep sentences under 30 words
  • Line 51 - error: 'delete' is repeated!
  • Line 102 - suggestion: Try to simplify this sentence.
  • Line 111 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'
  • Lines 111, 313, 331, 360 - error: Use 'filesystem' instead of 'file system'
  • Lines 149, 150, 372 - error: Use 'hostname' instead of 'host name'
  • Lines 211, 317 - error: Form a negative number with an en dash, not a hyphen.
  • Line 277 - suggestion: Spell out 'VFS' on first use
  • Line 309 - error: Don't use 'backend'. See the A-Z word list for details.
  • Line 375 - suggestion: Spell out 'UID' on first use
  • Line 376 - suggestion: Spell out 'GID' on first use
  • Line 379 - suggestion: Spell out 'GCM' on first use
  • Line 385 - suggestion: Spell out 'SBM' on first use

content/SCALE/Shares/SMB/AddManageSMBShares.md (81 issues)

  • Lines 25, 281 - warning: Use first person (such as ' I') sparingly.
  • Line 25 - warning: Don't use end punctuation in headings.
  • Lines 29, 46, 67, 81, 102, 107, 150, 155, 159, 163, 169, 173, 177, 195, 221, 241, 318, 475, 524 - suggestion: Use active voice instead of passive voice
  • Lines 41, 46, 74, 117, 118, 320, 393, 406, 501, 506, 515, 521 - suggestion: Keep sentences under 30 words
  • Line 63 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 128 - error: Use 'filesystem' instead of 'file system'
  • Lines 166, 509 - suggestion: Spell out 'SHARE' on first use
  • Lines 221, 286 - error: Use 'after' instead of 'once'
  • Lines 257, 263, 470 - error: Use 'hostname' instead of 'host name'
  • Line 281 - error: Avoid contractions. Use 'cannot' instead of 'can't'.
  • Lines 306, 307, 324, 325 - suggestion: Spell out 'NTFS' on first use
  • Line 309 - suggestion: Spell out 'FSRVP' on first use
  • Line 312 - suggestion: Spell out 'VUID' on first use
  • Line 367 - error: Use 'filesystem' instead of 'File System'
  • Line 465 - suggestion: Spell out 'YES' on first use

content/SCALE/SystemSettings/Update/UpdateHA.md (18 issues)

  • Lines 23, 38, 39, 85 - suggestion: Use active voice instead of passive voice
  • Lines 43, 92 - error: Use 'login' instead of 'log in'
  • Line 43 - suggestion: Spell out 'VIP' on first use
  • Line 70 - suggestion: Use 'signin' instead of 'Sign in'
  • Line 70 - suggestion: Use 'signin' instead of 'sign in'
  • Line 82 - suggestion: Keep sentences under 30 words
  • Line 83 - suggestion: Use Oxford comma before 'and' in lists
  • Line 92 - suggestion: Use 'login' instead of 'log in'

content/SCALE/GettingStarted/VersionNotes.md (13 issues)

  • Line 51 - suggestion: Try to simplify this sentence.
  • Lines 55, 217 - suggestion: Use active voice instead of passive voice
  • Line 59 - error: Remove the spaces around ' — '.
  • Line 135 - suggestion: Keep sentences under 30 words
  • Line 135 - warning: Use first person (such as 'My') sparingly.
  • Line 140 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 146 - suggestion: 'TrueNAS Apps' should use sentence-style capitalization.

content/SCALE/SystemSettings/Services/SMBServicesScreen.md (6 issues)

  • Line 24 - suggestion: 'Basic Settings' should use sentence-style capitalization.
  • Lines 38, 52 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 51 - suggestion: Use active voice instead of passive voice
  • Line 51 - error: Don't add '(s)' to a singular noun. Use plural instead.

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

@micjohnson777
Update 26UpgradeMethods.md
abe5767 
change emphasis from bold to <file></file> tags
@github-actions
Copy link

github-actions bot commented Mar 9, 2026

Vale Style Guide Issues

📊 Summary: 253 issues found in changed files - 25 errors, 4 warnings, 224 suggestions

Changed files with issues:

content/SCALE/Shares/SMB/SMBSharesScreens.md (135 issues)

  • Lines 20, 26, 35, 41, 78, 79, 98, 111, 112, 114, 115, 116, 122, 140, 147, 148, 181, 182, 183, 192, 199, 203, 211, 217, 225, 229, 236, 237, 238, 242, 251, 268, 277, 282, 308, 311, 312, 338, 348 - suggestion: Use active voice instead of passive voice
  • Lines 35, 78, 79, 148, 174, 181, 314 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 41, 96, 98, 268, 270, 311, 334, 366 - suggestion: Keep sentences under 30 words
  • Line 51 - error: 'delete' is repeated!
  • Line 102 - suggestion: Try to simplify this sentence.
  • Line 111 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'
  • Lines 111, 313, 331, 360 - error: Use 'filesystem' instead of 'file system'
  • Lines 149, 150, 372 - error: Use 'hostname' instead of 'host name'
  • Lines 211, 317 - error: Form a negative number with an en dash, not a hyphen.
  • Line 277 - suggestion: Spell out 'VFS' on first use
  • Line 309 - error: Don't use 'backend'. See the A-Z word list for details.
  • Line 375 - suggestion: Spell out 'UID' on first use
  • Line 376 - suggestion: Spell out 'GID' on first use
  • Line 379 - suggestion: Spell out 'GCM' on first use
  • Line 385 - suggestion: Spell out 'SBM' on first use

content/SCALE/Shares/SMB/AddManageSMBShares.md (81 issues)

  • Lines 25, 281 - warning: Use first person (such as ' I') sparingly.
  • Line 25 - warning: Don't use end punctuation in headings.
  • Lines 29, 46, 67, 81, 102, 107, 150, 155, 159, 163, 169, 173, 177, 195, 221, 241, 318, 475, 524 - suggestion: Use active voice instead of passive voice
  • Lines 41, 46, 74, 117, 118, 320, 393, 406, 501, 506, 515, 521 - suggestion: Keep sentences under 30 words
  • Line 63 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 128 - error: Use 'filesystem' instead of 'file system'
  • Lines 166, 509 - suggestion: Spell out 'SHARE' on first use
  • Lines 221, 286 - error: Use 'after' instead of 'once'
  • Lines 257, 263, 470 - error: Use 'hostname' instead of 'host name'
  • Line 281 - error: Avoid contractions. Use 'cannot' instead of 'can't'.
  • Lines 306, 307, 324, 325 - suggestion: Spell out 'NTFS' on first use
  • Line 309 - suggestion: Spell out 'FSRVP' on first use
  • Line 312 - suggestion: Spell out 'VUID' on first use
  • Line 367 - error: Use 'filesystem' instead of 'File System'
  • Line 465 - suggestion: Spell out 'YES' on first use

content/SCALE/SystemSettings/Update/UpdateHA.md (18 issues)

  • Lines 23, 38, 39, 85 - suggestion: Use active voice instead of passive voice
  • Lines 43, 92 - error: Use 'login' instead of 'log in'
  • Line 43 - suggestion: Spell out 'VIP' on first use
  • Line 70 - suggestion: Use 'signin' instead of 'Sign in'
  • Line 70 - suggestion: Use 'signin' instead of 'sign in'
  • Line 82 - suggestion: Keep sentences under 30 words
  • Line 83 - suggestion: Use Oxford comma before 'and' in lists
  • Line 92 - suggestion: Use 'login' instead of 'log in'

content/SCALE/GettingStarted/VersionNotes.md (13 issues)

  • Line 51 - suggestion: Try to simplify this sentence.
  • Lines 55, 217 - suggestion: Use active voice instead of passive voice
  • Line 59 - error: Remove the spaces around ' — '.
  • Line 135 - suggestion: Keep sentences under 30 words
  • Line 135 - warning: Use first person (such as 'My') sparingly.
  • Line 140 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 146 - suggestion: 'TrueNAS Apps' should use sentence-style capitalization.

content/SCALE/SystemSettings/Services/SMBServicesScreen.md (6 issues)

  • Line 24 - suggestion: 'Basic Settings' should use sentence-style capitalization.
  • Lines 38, 52 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 51 - suggestion: Use active voice instead of passive voice
  • Line 51 - error: Don't add '(s)' to a singular noun. Use plural instead.

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

@micjohnson777 micjohnson777 merged commit 44b948f into master Mar 9, 2026
5 checks passed
@micjohnson777 micjohnson777 deleted the PD-2271-smb-stateful-failover branch March 9, 2026 12:51
@micjohnson777 micjohnson777 added the Technical Writer Review (MJ) A technical writer is reviewing the PR. label Mar 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@micjohnson777 micjohnson777 micjohnson777 approved these changes

Assignees

No one assigned

Labels

Technical Writer Review (MJ) A technical writer is reviewing the PR.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@DjP-iX @micjohnson777