Skip to content

DOCS-2633 / 27 / Consolidate container migration content - #4884

Merged
micjohnson777 merged 5 commits into
27from
DOCS-2633-Migrating-Container-updates
Nov 4, 2026
Merged

DOCS-2633 / 27 / Consolidate container migration content#4884
micjohnson777 merged 5 commits into
27from
DOCS-2633-Migrating-Container-updates

Conversation

@DjP-iX

@DjP-iX DjP-iX commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

Consolidates container migration content on 27, building on #4845 and replacing the duplicated migration section in #4883.

Containers page (content/Containers/ManagingContainers.md)

  • Merge the two near-identical migration notes into one.
  • Fix the broken #migrating-instance-vms-to-virtual-machines anchor, which now points to #migrating-legacy-vms-to-virtual-machines.
  • Add an opening statement that backend technology changes mean containers on the Containers screen require migration.
  • State each Enterprise case explicitly: HA systems do not migrate automatically; non-HA systems migrate automatically with the Apps license feature enabled and do not without it.
  • Add a "Migrating Containers from TrueNAS 25.10" section with the old and new dataset paths and lists of what TrueNAS does and does not migrate.

Version Notes (content/GettingStarted/VersionNotes.md)

  • Use the same opening statement and Enterprise wording, and link to the new section.

The section content comes from #4883 and #4845.
The VM-disk-before-upgrade hint and the post-upgrade alert claim in #4883 are intentionally left out.
The alert claim conflicts with #4845 ("no notification") and needs engineering confirmation.
The migrates/does-not-migrate lists have not been verified against the product.

@DjP-iX
DOCS-2633 Consolidate container migration content for 27
a40bb2e 
Merge the duplicate migration notes on the Containers page into one, fix the broken Legacy VMs anchor, state the Enterprise HA and Apps license migration cases explicitly, and add a section describing what TrueNAS migrates and does not migrate.
@DjP-iX
DjP-iX requested a review from a team as a code owner October 28, 2026 16:08
@bugclerk

bugclerk commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

Jira URL: https://ixsystemsinc.atlassian.net/browse/DOCS-2633

@github-actions

github-actions Bot commented Oct 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 221 issues found in changed files - 33 errors, 1 warnings, 187 suggestions

Changed files with issues:

content/GettingStarted/VersionNotes.md (116 issues)

  • Lines 38, 52, 58, 68, 87, 90, 96, 102, 111, 114, 132, 138, 147, 150, 153, 164, 183, 206, 209, 218, 221, 275, 312, 316, 321, 341, 349, 350, 447 - suggestion: Use active voice instead of passive voice
  • Line 48 - suggestion: Try to simplify this sentence.
  • Line 69 - suggestion: Use Oxford comma before 'and' in lists
  • Line 71 - error: Avoid contractions. Use 'does not' instead of 'doesn't'.
  • Line 81 - suggestion: Spell out 'EKU' on first use
  • Line 87 - error: Use 'after' instead of 'once'
  • Line 90 - suggestion: Spell out 'VRRP' on first use
  • Line 93 - suggestion: Spell out 'SCST' on first use
  • Line 96 - suggestion: Spell out 'SSSD' on first use
  • Line 153 - suggestion: Spell out 'RFC' on first use
  • Line 159 - suggestion: Spell out 'INI' on first use
  • Line 162 - error: Avoid possessive forms ('bond's'). Rephrase to avoid using apostrophes for possession.
  • Line 171 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 174, 375, 376, 380 - suggestion: Spell out 'SMART' on first use
  • Lines 191, 320, 321 - error: Use 'login' instead of 'log in'
  • Line 275 - suggestion: Spell out 'REST' on first use
  • Lines 291, 312 - suggestion: Keep sentences under 30 words
  • Line 291 - warning: Use first person (such as 'My') sparingly.
  • Lines 296, 298, 300 - suggestion: Spell out 'SCRAM' on first use
  • Line 296 - error: Form a negative number with an en dash, not a hyphen.
  • Line 310 - suggestion: Spell out 'TOTP' on first use
  • Lines 320, 321 - suggestion: Use 'login' instead of 'log in'
  • Line 321 - suggestion: Use 'signin' instead of 'sign in'
  • Line 331 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 338 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 347, 349, 350 - error: Remove the spaces around ' — '.
  • Line 361 - suggestion: Use 'backup' instead of 'back up'
  • Line 368 - suggestion: 'Drive Health Management' should use sentence-style capitalization.
  • Line 372 - suggestion: Spell out 'HDD' on first use
  • Line 386 - suggestion: 'Upgrade Paths' should use sentence-style capitalization.

content/Containers/ManagingContainers.md (105 issues)

  • Lines 20, 171, 289, 296, 430, 435, 440, 442, 444, 446, 451, 514 - error: Use 'filesystem' instead of 'file system'
  • Line 28 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 31, 42, 105, 180, 187, 220, 223, 266, 275, 277, 284, 289, 302, 308, 367, 368, 369, 419, 420, 462 - suggestion: Use active voice instead of passive voice
  • Lines 51, 172, 174, 181, 186, 193, 197, 215, 216, 226, 228, 230, 279, 280, 302, 305, 368 - suggestion: Spell out 'UID' on first use
  • Lines 51, 174, 215, 216, 279, 368 - suggestion: Spell out 'GID' on first use
  • Line 96 - suggestion: Spell out 'NAT' on first use
  • Lines 171, 172, 226 - suggestion: Keep sentences under 30 words
  • Lines 175, 216, 280, 301 - error: Remove the spaces around ' — '.
  • Line 181 - error: Don't use 'and so on'. See the A-Z word list for details.
  • Line 272 - suggestion: Spell out 'UTC' on first use
  • Lines 284, 319 - suggestion: Spell out 'ALLOW' on first use
  • Lines 296, 426, 431, 514 - error: Use 'filesystem' instead of 'File system'
  • Line 408 - suggestion: Spell out 'AMD' on first use

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

@DjP-iX
DOCS-2633 Update upgrade target from TrueNAS 26 to 27
79ab2fe 
Users upgrade directly from 25.10 to 27. Update the migration content and the link to the 25.10 upgrade preparation section, and align the Version Notes VM preparation steps with the 25.10 procedure.
@github-actions

github-actions Bot commented Oct 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 295 issues found in changed files - 37 errors, 1 warnings, 257 suggestions

Changed files with issues:

content/GettingStarted/VersionNotes.md (115 issues)

  • Lines 38, 52, 58, 68, 87, 90, 96, 102, 111, 114, 132, 138, 147, 150, 153, 164, 183, 206, 209, 218, 221, 275, 312, 316, 321, 341, 349, 350, 447 - suggestion: Use active voice instead of passive voice
  • Line 48 - suggestion: Try to simplify this sentence.
  • Line 69 - suggestion: Use Oxford comma before 'and' in lists
  • Line 71 - error: Avoid contractions. Use 'does not' instead of 'doesn't'.
  • Line 81 - suggestion: Spell out 'EKU' on first use
  • Line 87 - error: Use 'after' instead of 'once'
  • Line 90 - suggestion: Spell out 'VRRP' on first use
  • Line 93 - suggestion: Spell out 'SCST' on first use
  • Line 96 - suggestion: Spell out 'SSSD' on first use
  • Line 153 - suggestion: Spell out 'RFC' on first use
  • Line 159 - suggestion: Spell out 'INI' on first use
  • Line 162 - error: Avoid possessive forms ('bond's'). Rephrase to avoid using apostrophes for possession.
  • Line 171 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 174, 375, 376, 380 - suggestion: Spell out 'SMART' on first use
  • Lines 191, 320, 321 - error: Use 'login' instead of 'log in'
  • Line 275 - suggestion: Spell out 'REST' on first use
  • Lines 291, 312 - suggestion: Keep sentences under 30 words
  • Line 291 - warning: Use first person (such as 'My') sparingly.
  • Lines 296, 298, 300 - suggestion: Spell out 'SCRAM' on first use
  • Line 296 - error: Form a negative number with an en dash, not a hyphen.
  • Line 310 - suggestion: Spell out 'TOTP' on first use
  • Lines 320, 321 - suggestion: Use 'login' instead of 'log in'
  • Line 321 - suggestion: Use 'signin' instead of 'sign in'
  • Line 331 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 338 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 347, 349, 350 - error: Remove the spaces around ' — '.
  • Line 368 - suggestion: 'Drive Health Management' should use sentence-style capitalization.
  • Line 372 - suggestion: Spell out 'HDD' on first use
  • Line 386 - suggestion: 'Upgrade Paths' should use sentence-style capitalization.

content/Containers/ManagingContainers.md (105 issues)

  • Lines 20, 171, 289, 296, 430, 435, 440, 442, 444, 446, 451, 514 - error: Use 'filesystem' instead of 'file system'
  • Line 28 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 31, 42, 105, 180, 187, 220, 223, 266, 275, 277, 284, 289, 302, 308, 367, 368, 369, 419, 420, 462 - suggestion: Use active voice instead of passive voice
  • Lines 51, 172, 174, 181, 186, 193, 197, 215, 216, 226, 228, 230, 279, 280, 302, 305, 368 - suggestion: Spell out 'UID' on first use
  • Lines 51, 174, 215, 216, 279, 368 - suggestion: Spell out 'GID' on first use
  • Line 96 - suggestion: Spell out 'NAT' on first use
  • Lines 171, 172, 226 - suggestion: Keep sentences under 30 words
  • Lines 175, 216, 280, 301 - error: Remove the spaces around ' — '.
  • Line 181 - error: Don't use 'and so on'. See the A-Z word list for details.
  • Line 272 - suggestion: Spell out 'UTC' on first use
  • Lines 284, 319 - suggestion: Spell out 'ALLOW' on first use
  • Lines 296, 426, 431, 514 - error: Use 'filesystem' instead of 'File system'
  • Line 408 - suggestion: Spell out 'AMD' on first use

content/VirtualMachines/ManagingVMs.md (57 issues)

  • Lines 55, 63, 68, 70, 76, 89, 101, 188, 205, 216, 222, 277, 451, 481, 524 - suggestion: Use active voice instead of passive voice
  • Line 58 - suggestion: Spell out 'UTC' on first use
  • Line 76 - suggestion: Try to simplify this sentence.
  • Line 126 - suggestion: Spell out 'QED' on first use
  • Line 126 - suggestion: Spell out 'RAW' on first use
  • Line 126 - suggestion: Spell out 'VDI' on first use
  • Line 126 - suggestion: Spell out 'VHDX' on first use
  • Line 126 - suggestion: Spell out 'VMDK' on first use
  • Lines 131, 197 - suggestion: Keep sentences under 30 words
  • Line 167 - suggestion: Spell out 'AMD' on first use
  • Line 235 - suggestion: Spell out 'ADD' on first use
  • Lines 277, 278, 279 - suggestion: Spell out 'ISO' on first use
  • Line 295 - suggestion: Spell out 'SPICE' on first use
  • Line 366 - suggestion: Spell out 'GRUB' on first use
  • Lines 404, 424 - error: Use 'login' instead of 'Log in'
  • Line 424 - suggestion: Use 'login' instead of 'Log in'
  • Lines 476, 477, 480, 482 - suggestion: Spell out 'USED' on first use
  • Line 558 - error: Use 'after' instead of 'once'

static/includes/DeprecationsList.md (18 issues)

  • Lines 17, 94, 100, 106 - suggestion: Use active voice instead of passive voice
  • Lines 39, 43, 49, 50 - suggestion: Spell out 'REST' on first use
  • Line 69 - suggestion: Spell out 'BRT' on first use
  • Lines 81, 83 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'
  • Lines 84, 88 - suggestion: Spell out 'SCRAM' on first use
  • Line 106 - error: Remove the spaces around ' — '.

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

This was referenced Oct 28, 2026
Merged
Merged
@DjP-iX

DjP-iX commented Oct 28, 2026

Copy link
Copy Markdown
Contributor Author

Should merge after #4883.

I'd also like @yocalebo or @Qubad786 (Rehan) to review all three PRs for accuracy before we merge them, so we're hopefully not updating them again too soon.

@linzi-ix linzi-ix added Technical Writer Review (LM) A technical writer is reviewing the PR. and removed Technical Writer Review (LM) A technical writer is reviewing the PR. labels Oct 29, 2026
micjohnson777
micjohnson777 previously approved these changes Oct 29, 2026
View reviewed changes
@micjohnson777 micjohnson777 added the Technical Writer Review (MJ) A technical writer is reviewing the PR. label Oct 29, 2026
@yocalebo
yocalebo requested a review from Qubad786 November 3, 2026 16:42
Qubad786
Qubad786 reviewed Nov 4, 2026
View reviewed changes
Comment thread content/Containers/ManagingContainers.md Resolved
Comment thread content/Containers/ManagingContainers.md Resolved
Comment thread content/Containers/ManagingContainers.md Resolved
Comment thread content/Containers/ManagingContainers.md Resolved
@github-actions

github-actions Bot commented Nov 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 296 issues found in changed files - 38 errors, 1 warnings, 257 suggestions

Changed files with issues:

content/GettingStarted/VersionNotes.md (113 issues)

  • Lines 38, 52, 58, 68, 87, 90, 96, 102, 111, 114, 132, 138, 147, 150, 153, 164, 183, 206, 209, 218, 221, 275, 312, 316, 321, 347, 348, 445 - suggestion: Use active voice instead of passive voice
  • Line 48 - suggestion: Try to simplify this sentence.
  • Line 69 - suggestion: Use Oxford comma before 'and' in lists
  • Line 71 - error: Avoid contractions. Use 'does not' instead of 'doesn't'.
  • Line 81 - suggestion: Spell out 'EKU' on first use
  • Line 87 - error: Use 'after' instead of 'once'
  • Line 90 - suggestion: Spell out 'VRRP' on first use
  • Line 93 - suggestion: Spell out 'SCST' on first use
  • Line 96 - suggestion: Spell out 'SSSD' on first use
  • Line 153 - suggestion: Spell out 'RFC' on first use
  • Line 159 - suggestion: Spell out 'INI' on first use
  • Line 162 - error: Avoid possessive forms ('bond's'). Rephrase to avoid using apostrophes for possession.
  • Line 171 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 174, 373, 374, 378 - suggestion: Spell out 'SMART' on first use
  • Lines 191, 320, 321 - error: Use 'login' instead of 'log in'
  • Line 275 - suggestion: Spell out 'REST' on first use
  • Lines 291, 312 - suggestion: Keep sentences under 30 words
  • Line 291 - warning: Use first person (such as 'My') sparingly.
  • Lines 296, 298, 300 - suggestion: Spell out 'SCRAM' on first use
  • Line 296 - error: Form a negative number with an en dash, not a hyphen.
  • Line 310 - suggestion: Spell out 'TOTP' on first use
  • Lines 320, 321 - suggestion: Use 'login' instead of 'log in'
  • Line 321 - suggestion: Use 'signin' instead of 'sign in'
  • Line 331 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 338 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 345, 347, 348 - error: Remove the spaces around ' — '.
  • Line 366 - suggestion: 'Drive Health Management' should use sentence-style capitalization.
  • Line 370 - suggestion: Spell out 'HDD' on first use
  • Line 384 - suggestion: 'Upgrade Paths' should use sentence-style capitalization.

content/Containers/ManagingContainers.md (108 issues)

  • Lines 20, 170, 288, 295, 429, 434, 439, 441, 443, 445, 450, 516 - error: Use 'filesystem' instead of 'file system'
  • Line 28 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 41, 104, 179, 186, 219, 222, 265, 274, 276, 283, 288, 301, 307, 366, 367, 368, 418, 419, 461, 530 - suggestion: Use active voice instead of passive voice
  • Lines 50, 171, 173, 180, 185, 192, 196, 214, 215, 225, 227, 229, 278, 279, 301, 304, 367 - suggestion: Spell out 'UID' on first use
  • Lines 50, 173, 214, 215, 278, 367 - suggestion: Spell out 'GID' on first use
  • Line 95 - suggestion: Spell out 'NAT' on first use
  • Lines 170, 171, 225 - suggestion: Keep sentences under 30 words
  • Lines 174, 215, 279, 300 - error: Remove the spaces around ' — '.
  • Line 180 - error: Don't use 'and so on'. See the A-Z word list for details.
  • Line 271 - suggestion: Spell out 'UTC' on first use
  • Lines 283, 318 - suggestion: Spell out 'ALLOW' on first use
  • Lines 295, 425, 430, 516 - error: Use 'filesystem' instead of 'File system'
  • Line 407 - suggestion: Spell out 'AMD' on first use
  • Line 507 - error: Use 'after' instead of 'once'

content/VirtualMachines/ManagingVMs.md (57 issues)

  • Lines 55, 63, 68, 70, 76, 89, 101, 188, 205, 216, 222, 277, 451, 481, 524 - suggestion: Use active voice instead of passive voice
  • Line 58 - suggestion: Spell out 'UTC' on first use
  • Line 76 - suggestion: Try to simplify this sentence.
  • Line 126 - suggestion: Spell out 'QED' on first use
  • Line 126 - suggestion: Spell out 'RAW' on first use
  • Line 126 - suggestion: Spell out 'VDI' on first use
  • Line 126 - suggestion: Spell out 'VHDX' on first use
  • Line 126 - suggestion: Spell out 'VMDK' on first use
  • Lines 131, 197 - suggestion: Keep sentences under 30 words
  • Line 167 - suggestion: Spell out 'AMD' on first use
  • Line 235 - suggestion: Spell out 'ADD' on first use
  • Lines 277, 278, 279 - suggestion: Spell out 'ISO' on first use
  • Line 295 - suggestion: Spell out 'SPICE' on first use
  • Line 366 - suggestion: Spell out 'GRUB' on first use
  • Lines 404, 424 - error: Use 'login' instead of 'Log in'
  • Line 424 - suggestion: Use 'login' instead of 'Log in'
  • Lines 476, 477, 480, 482 - suggestion: Spell out 'USED' on first use
  • Line 558 - error: Use 'after' instead of 'once'

static/includes/DeprecationsList.md (18 issues)

  • Lines 17, 94, 100, 106 - suggestion: Use active voice instead of passive voice
  • Lines 39, 43, 49, 50 - suggestion: Spell out 'REST' on first use
  • Line 69 - suggestion: Spell out 'BRT' on first use
  • Lines 81, 83 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'
  • Lines 84, 88 - suggestion: Spell out 'SCRAM' on first use
  • Line 106 - error: Remove the spaces around ' — '.

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

@github-actions

github-actions Bot commented Nov 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 296 issues found in changed files - 38 errors, 1 warnings, 257 suggestions

Changed files with issues:

content/GettingStarted/VersionNotes.md (113 issues)

  • Lines 38, 52, 58, 68, 87, 90, 96, 102, 111, 114, 132, 138, 147, 150, 153, 164, 183, 206, 209, 218, 221, 275, 312, 316, 321, 347, 348, 445 - suggestion: Use active voice instead of passive voice
  • Line 48 - suggestion: Try to simplify this sentence.
  • Line 69 - suggestion: Use Oxford comma before 'and' in lists
  • Line 71 - error: Avoid contractions. Use 'does not' instead of 'doesn't'.
  • Line 81 - suggestion: Spell out 'EKU' on first use
  • Line 87 - error: Use 'after' instead of 'once'
  • Line 90 - suggestion: Spell out 'VRRP' on first use
  • Line 93 - suggestion: Spell out 'SCST' on first use
  • Line 96 - suggestion: Spell out 'SSSD' on first use
  • Line 153 - suggestion: Spell out 'RFC' on first use
  • Line 159 - suggestion: Spell out 'INI' on first use
  • Line 162 - error: Avoid possessive forms ('bond's'). Rephrase to avoid using apostrophes for possession.
  • Line 171 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 174, 373, 374, 378 - suggestion: Spell out 'SMART' on first use
  • Lines 191, 320, 321 - error: Use 'login' instead of 'log in'
  • Line 275 - suggestion: Spell out 'REST' on first use
  • Lines 291, 312 - suggestion: Keep sentences under 30 words
  • Line 291 - warning: Use first person (such as 'My') sparingly.
  • Lines 296, 298, 300 - suggestion: Spell out 'SCRAM' on first use
  • Line 296 - error: Form a negative number with an en dash, not a hyphen.
  • Line 310 - suggestion: Spell out 'TOTP' on first use
  • Lines 320, 321 - suggestion: Use 'login' instead of 'log in'
  • Line 321 - suggestion: Use 'signin' instead of 'sign in'
  • Line 331 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 338 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 345, 347, 348 - error: Remove the spaces around ' — '.
  • Line 366 - suggestion: 'Drive Health Management' should use sentence-style capitalization.
  • Line 370 - suggestion: Spell out 'HDD' on first use
  • Line 384 - suggestion: 'Upgrade Paths' should use sentence-style capitalization.

content/Containers/ManagingContainers.md (108 issues)

  • Lines 20, 170, 288, 295, 429, 434, 439, 441, 443, 445, 450, 516 - error: Use 'filesystem' instead of 'file system'
  • Line 28 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 41, 104, 179, 186, 219, 222, 265, 274, 276, 283, 288, 301, 307, 366, 367, 368, 418, 419, 461, 530 - suggestion: Use active voice instead of passive voice
  • Lines 50, 171, 173, 180, 185, 192, 196, 214, 215, 225, 227, 229, 278, 279, 301, 304, 367 - suggestion: Spell out 'UID' on first use
  • Lines 50, 173, 214, 215, 278, 367 - suggestion: Spell out 'GID' on first use
  • Line 95 - suggestion: Spell out 'NAT' on first use
  • Lines 170, 171, 225 - suggestion: Keep sentences under 30 words
  • Lines 174, 215, 279, 300 - error: Remove the spaces around ' — '.
  • Line 180 - error: Don't use 'and so on'. See the A-Z word list for details.
  • Line 271 - suggestion: Spell out 'UTC' on first use
  • Lines 283, 318 - suggestion: Spell out 'ALLOW' on first use
  • Lines 295, 425, 430, 516 - error: Use 'filesystem' instead of 'File system'
  • Line 407 - suggestion: Spell out 'AMD' on first use
  • Line 507 - error: Use 'after' instead of 'once'

content/VirtualMachines/ManagingVMs.md (57 issues)

  • Lines 55, 63, 68, 70, 76, 89, 101, 188, 205, 216, 222, 277, 451, 481, 524 - suggestion: Use active voice instead of passive voice
  • Line 58 - suggestion: Spell out 'UTC' on first use
  • Line 76 - suggestion: Try to simplify this sentence.
  • Line 126 - suggestion: Spell out 'QED' on first use
  • Line 126 - suggestion: Spell out 'RAW' on first use
  • Line 126 - suggestion: Spell out 'VDI' on first use
  • Line 126 - suggestion: Spell out 'VHDX' on first use
  • Line 126 - suggestion: Spell out 'VMDK' on first use
  • Lines 131, 197 - suggestion: Keep sentences under 30 words
  • Line 167 - suggestion: Spell out 'AMD' on first use
  • Line 235 - suggestion: Spell out 'ADD' on first use
  • Lines 277, 278, 279 - suggestion: Spell out 'ISO' on first use
  • Line 295 - suggestion: Spell out 'SPICE' on first use
  • Line 366 - suggestion: Spell out 'GRUB' on first use
  • Lines 404, 424 - error: Use 'login' instead of 'Log in'
  • Line 424 - suggestion: Use 'login' instead of 'Log in'
  • Lines 476, 477, 480, 482 - suggestion: Spell out 'USED' on first use
  • Line 558 - error: Use 'after' instead of 'once'

static/includes/DeprecationsList.md (18 issues)

  • Lines 17, 94, 100, 106 - suggestion: Use active voice instead of passive voice
  • Lines 39, 43, 49, 50 - suggestion: Spell out 'REST' on first use
  • Line 69 - suggestion: Spell out 'BRT' on first use
  • Lines 81, 83 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'
  • Lines 84, 88 - suggestion: Spell out 'SCRAM' on first use
  • Line 106 - error: Remove the spaces around ' — '.

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

@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown

Vale Style Guide Issues

📊 Summary: 315 issues found in changed files - 38 errors, 1 warnings, 276 suggestions

Changed files with issues:

content/Containers/ManagingContainers.md (127 issues)

  • Lines 20, 170, 295, 304, 441, 449, 459, 461, 463, 529 - error: Use 'filesystem' instead of 'file system'
  • Line 28 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 41, 104, 152, 179, 186, 219, 222, 255, 268, 277, 283, 290, 295, 310, 316, 374, 375, 376, 400, 431, 432, 434, 474, 543 - suggestion: Use active voice instead of passive voice
  • Lines 50, 171, 173, 180, 185, 192, 196, 214, 215, 225, 227, 229, 285, 286, 310, 313, 375 - suggestion: Spell out 'UID' on first use
  • Lines 50, 173, 214, 215, 285, 375 - suggestion: Spell out 'GID' on first use
  • Line 95 - suggestion: Spell out 'NAT' on first use
  • Line 152 - error: Use 'Controller 1' instead of 'controller a'
  • Lines 170, 171, 225, 297, 392, 408, 434 - suggestion: Keep sentences under 30 words
  • Lines 174, 215, 286, 309 - error: Remove the spaces around ' — '.
  • Line 180 - error: Don't use 'and so on'. See the A-Z word list for details.
  • Line 274 - suggestion: Spell out 'UTC' on first use
  • Lines 290, 327 - suggestion: Spell out 'ALLOW' on first use
  • Lines 304, 436 - error: Use 'filesystem' instead of 'File System'
  • Line 392 - suggestion: Use Oxford comma before 'and' in lists
  • Line 420 - suggestion: Spell out 'AMD' on first use
  • Line 434 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Lines 439, 529 - error: Use 'filesystem' instead of 'File system'
  • Line 489 - suggestion: Spell out 'NICS' on first use
  • Line 520 - error: Use 'after' instead of 'once'

content/GettingStarted/VersionNotes.md (113 issues)

  • Lines 38, 52, 58, 68, 87, 90, 96, 102, 111, 114, 132, 138, 147, 150, 153, 164, 183, 206, 209, 218, 221, 275, 312, 316, 321, 347, 348, 445 - suggestion: Use active voice instead of passive voice
  • Line 48 - suggestion: Try to simplify this sentence.
  • Line 69 - suggestion: Use Oxford comma before 'and' in lists
  • Line 71 - error: Avoid contractions. Use 'does not' instead of 'doesn't'.
  • Line 81 - suggestion: Spell out 'EKU' on first use
  • Line 87 - error: Use 'after' instead of 'once'
  • Line 90 - suggestion: Spell out 'VRRP' on first use
  • Line 93 - suggestion: Spell out 'SCST' on first use
  • Line 96 - suggestion: Spell out 'SSSD' on first use
  • Line 153 - suggestion: Spell out 'RFC' on first use
  • Line 159 - suggestion: Spell out 'INI' on first use
  • Line 162 - error: Avoid possessive forms ('bond's'). Rephrase to avoid using apostrophes for possession.
  • Line 171 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 174, 373, 374, 378 - suggestion: Spell out 'SMART' on first use
  • Lines 191, 320, 321 - error: Use 'login' instead of 'log in'
  • Line 275 - suggestion: Spell out 'REST' on first use
  • Lines 291, 312 - suggestion: Keep sentences under 30 words
  • Line 291 - warning: Use first person (such as 'My') sparingly.
  • Lines 296, 298, 300 - suggestion: Spell out 'SCRAM' on first use
  • Line 296 - error: Form a negative number with an en dash, not a hyphen.
  • Line 310 - suggestion: Spell out 'TOTP' on first use
  • Lines 320, 321 - suggestion: Use 'login' instead of 'log in'
  • Line 321 - suggestion: Use 'signin' instead of 'sign in'
  • Line 331 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 338 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 345, 347, 348 - error: Remove the spaces around ' — '.
  • Line 366 - suggestion: 'Drive Health Management' should use sentence-style capitalization.
  • Line 370 - suggestion: Spell out 'HDD' on first use
  • Line 384 - suggestion: 'Upgrade Paths' should use sentence-style capitalization.

content/VirtualMachines/ManagingVMs.md (57 issues)

  • Lines 55, 63, 68, 70, 76, 89, 101, 188, 205, 216, 222, 277, 451, 481, 524 - suggestion: Use active voice instead of passive voice
  • Line 58 - suggestion: Spell out 'UTC' on first use
  • Line 76 - suggestion: Try to simplify this sentence.
  • Line 126 - suggestion: Spell out 'QED' on first use
  • Line 126 - suggestion: Spell out 'RAW' on first use
  • Line 126 - suggestion: Spell out 'VDI' on first use
  • Line 126 - suggestion: Spell out 'VHDX' on first use
  • Line 126 - suggestion: Spell out 'VMDK' on first use
  • Lines 131, 197 - suggestion: Keep sentences under 30 words
  • Line 167 - suggestion: Spell out 'AMD' on first use
  • Line 235 - suggestion: Spell out 'ADD' on first use
  • Lines 277, 278, 279 - suggestion: Spell out 'ISO' on first use
  • Line 295 - suggestion: Spell out 'SPICE' on first use
  • Line 366 - suggestion: Spell out 'GRUB' on first use
  • Lines 404, 424 - error: Use 'login' instead of 'Log in'
  • Line 424 - suggestion: Use 'login' instead of 'Log in'
  • Lines 476, 477, 480, 482 - suggestion: Spell out 'USED' on first use
  • Line 558 - error: Use 'after' instead of 'once'

static/includes/DeprecationsList.md (18 issues)

  • Lines 17, 94, 100, 106 - suggestion: Use active voice instead of passive voice
  • Lines 39, 43, 49, 50 - suggestion: Spell out 'REST' on first use
  • Line 69 - suggestion: Spell out 'BRT' on first use
  • Lines 81, 83 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'
  • Lines 84, 88 - suggestion: Spell out 'SCRAM' on first use
  • Line 106 - error: Remove the spaces around ' — '.

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

@micjohnson777
micjohnson777 merged commit aa17025 into 27 Nov 4, 2026
2 checks passed
@micjohnson777
micjohnson777 deleted the DOCS-2633-Migrating-Container-updates branch November 4, 2026 17:55
@bugclerk

bugclerk commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

JIRA ticket https://ixsystemsinc.atlassian.net/browse/DOCS-2633 is targeted to the following versions which have not received their corresponding PRs: 26

@bugclerk

bugclerk commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

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.

@truenas truenas locked as resolved and limited conversation to collaborators Nov 4, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@Qubad786 Qubad786 Qubad786 left review comments
@micjohnson777 micjohnson777 micjohnson777 approved these changes

Assignees

No one assigned

Labels

no-time-tracked 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.

5 participants

@DjP-iX @bugclerk @Qubad786 @micjohnson777 @linzi-ix