Skip to content

DOCS-2633 / 25.10 / Update upgrade preparation for TrueNAS 27 - #4885

Merged
tonyriv3 merged 3 commits into
25.10from
DOCS-2633-25.10-upgrade-prep
Nov 6, 2026
Merged

tonyriv3 merged 3 commits into
25.10from
DOCS-2633-25.10-upgrade-prep

Conversation

@DjP-iX

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

Copy link
Copy Markdown
Contributor

Follow-up to #4834. Users upgrade directly from 25.10 to 27, so the upgrade preparation content needs to say 27 and cover containers as well as VMs.

26 to 27 rename

  • "Preparing to Upgrade to TrueNAS 27" heading, steps and links, including the 27 docs URLs. The anchor is now #preparing-to-upgrade-to-truenas-27, which the 27 branch links to (DOCS-2633 / 27 / Consolidate container migration content #4884).
  • REST API removal notice, three "resolved in TrueNAS 26" known issues, and the upgrade-path diagrams.

Container migration guidance

  • Add the Enterprise HA and Apps license migration cases and a legacy VM pointer to static/includes/25.04Virtualization.md, which appears on the Containers tutorial, Containers UI reference, Version Notes and VM/app setup page.
  • In the VM preparation steps, replace the unqualified "Containers migrate automatically" with a link to the Containers tutorial.

Merge this before #4884 so the 27 link to the preparation section resolves.
The 27 docs URL path (/docs/scale/27/virtualmachines/managingvms/) is assumed from the 26 pattern.

Users upgrade directly from 25.10 to 27. Rename the 26 references to 27, add container migration and legacy VM guidance to the shared Virtualization include, and point the VM preparation steps to the Containers tutorial for which systems migrate containers.
@DjP-iX
DjP-iX requested a review from a team as a code owner October 28, 2026 16:43
@bugclerk

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Oct 28, 2026 •

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

Vale Style Guide Issues

📊 Summary: 506 issues found in changed files - 65 errors, 5 warnings, 436 suggestions

Changed files with issues:

content/GettingStarted/VersionNotes.md (395 issues)

  • Line 36 - suggestion: Try to simplify this sentence.
  • Lines 41, 48, 53, 57, 59, 63, 75, 84, 90, 99, 114, 120, 143, 152, 155, 161, 163, 164, 177, 186, 189, 192, 198, 201, 206, 207, 210, 220, 225, 228, 231, 243, 245, 256, 265, 268, 280, 289, 313, 314, 322, 336, 366, 375, 377, 381, 387, 414, 441, 444, 487, 503, 513, 517, 527, 529, 538, 544, 553, 559, 578, 587, 593, 617, 639, 671, 676, 680, 700, 705, 707, 713, 715, 716, 726, 730, 733, 737, 805, 829, 831, 850, 867, 868, 873, 875, 917, 992 - suggestion: Use active voice instead of passive voice
  • Lines 45, 104, 148, 182 - suggestion: Spell out 'LTS' on first use
  • Line 47 - error: Avoid possessive forms ('client's'). Rephrase to avoid using apostrophes for possession.
  • Line 48 - suggestion: Spell out 'NULL' on first use
  • Lines 56, 105, 422 - suggestion: Spell out 'RDMA' on first use
  • Line 59 - error: Avoid possessive forms ('target's'). Rephrase to avoid using apostrophes for possession.
  • Lines 60, 189, 246, 696, 811 - error: Use 'after' instead of 'once'
  • Line 63 - suggestion: Spell out 'VRRP' on first use
  • Line 63 - error: Avoid possessive forms ('controller's'). Rephrase to avoid using apostrophes for possession.
  • Line 63 - suggestion: Spell out 'VIP' on first use
  • Line 66 - error: Use 'Controller 1' instead of 'controller a'
  • Line 72 - suggestion: Spell out 'SSSD' on first use
  • Line 87 - warning: Prefer 'cloud' over 'the Cloud'.
  • Lines 92, 134, 169, 212, 250, 270, 330, 356, 405, 497, 531, 580, 650 - error: Use 'login' instead of 'log in'
  • Lines 105, 149, 183, 186, 257 - error: Form a negative number with an en dash, not a hyphen.
  • Line 105 - suggestion: Spell out 'TIPC' on first use
  • Line 111 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 117, 155, 248, 446, 447, 640, 641, 642, 643, 644, 802, 861, 867, 869, 873, 874, 875, 883, 887, 896, 897, 901 - suggestion: Spell out 'SMART' on first use
  • Line 137 - error: Remove the spaces around ' –'.
  • Line 139 - suggestion: '*****.0 Notable Changes' should use sentence-style capitalization.
  • Line 149 - suggestion: Spell out 'ACK' on first use
  • Line 149 - suggestion: Spell out 'SCTP' on first use
  • Line 152 - suggestion: Spell out 'OOM' on first use
  • Line 164 - suggestion: Spell out 'RFC' on first use
  • Line 186 - suggestion: Spell out 'WORM' on first use
  • Line 186 - error: Use 'after' instead of 'Once'
  • Line 189 - suggestion: Spell out 'BRT' on first use
  • Lines 195, 645, 877 - suggestion: Spell out 'SCSI' on first use
  • Lines 228, 441, 635 - error: Don't use 'backend'. See the A-Z word list for details.
  • Line 237 - suggestion: Spell out 'MII' on first use
  • Lines 240, 699 - suggestion: Spell out 'EBUSY' on first use
  • Line 243 - suggestion: Use 'MB' instead of 'megabytes'
  • Line 246 - error: Avoid possessive forms ('snapshot's'). Rephrase to avoid using apostrophes for possession.
  • Line 246 - error: Remove the spaces around ' — '.
  • Line 254 - error: Use 'could' instead of 'May'
  • Lines 257, 262 - suggestion: Spell out 'AEAD' on first use
  • Line 261 - suggestion: Spell out 'CVSS' on first use
  • Line 268 - warning: Prefer 'personal digital assistant' over 'agent'.
  • Line 268 - suggestion: Spell out 'MIB' on first use
  • Line 298 - suggestion: Spell out 'YAML' on first use
  • Lines 317, 555 - suggestion: Spell out 'CORE' on first use
  • Line 319 - suggestion: Spell out 'URI' on first use
  • Lines 337, 416, 596, 788, 926, 927 - suggestion: Keep sentences under 30 words
  • Lines 376, 377, 638, 639 - suggestion: Spell out 'REST' on first use
  • Line 383 - suggestion: Spell out 'PIN' on first use
  • Line 385 - suggestion: Spell out 'OVMF' on first use
  • Line 387 - suggestion: Spell out 'ISO' on first use
  • Lines 388, 423, 572 - suggestion: Spell out 'VDI' on first use
  • Lines 400, 893 - suggestion: Spell out 'HDD' on first use
  • Line 401 - suggestion: Spell out 'OID' on first use
  • Lines 423, 572 - suggestion: Spell out 'RAW' on first use
  • Lines 423, 572 - suggestion: Spell out 'VHDX' on first use
  • Lines 423, 572 - suggestion: Spell out 'VMDK' on first use
  • Lines 439, 914, 915 - suggestion: Spell out 'RTX' on first use
  • Lines 439, 914, 922 - suggestion: Spell out 'GTX' on first use
  • Lines 440, 441, 635, 797 - suggestion: Spell out 'IDMAP' on first use
  • Lines 441, 636, 798 - suggestion: Spell out 'RID' on first use
  • Lines 488, 489 - suggestion: Spell out 'AMD' on first use
  • Lines 510, 511 - suggestion: Spell out 'VFS' on first use
  • Line 521 - error: Punctuation should be inside the quotes.
  • Line 565 - warning: Prefer 'KB' over 'kB'.
  • Line 572 - suggestion: Spell out 'QED' on first use
  • Line 578 - suggestion: Spell out 'PGP' on first use
  • Line 611 - suggestion: Spell out 'ACME' on first use
  • Line 705 - suggestion: Avoid using 'will' - use present tense instead of future tense
  • Line 716 - suggestion: Spell out 'SCST' on first use
  • Line 718 - suggestion: Use Oxford comma before 'and' in lists
  • Line 788 - warning: Use first person (such as 'My') sparingly.
  • Line 797 - error: Don't use 'Backend'. See the A-Z word list for details.
  • Line 819 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 836 - suggestion: 'TrueNAS Apps' should use sentence-style capitalization.
  • Line 907 - suggestion: 'NVIDIA GPU Support' should use sentence-style capitalization.
  • Line 915 - suggestion: Spell out 'PRO' on first use
  • Lines 915, 923 - suggestion: Spell out 'GSP' on first use
  • Line 931 - suggestion: 'Upgrade Paths' should use sentence-style capitalization.

content/SCALETutorials/VirtualMachines/_index.md (92 issues)

  • Lines 51, 59, 64, 66, 72, 85, 176, 193, 204, 210, 265, 437, 478, 479, 480, 484, 486, 499, 542, 544, 548, 585, 610, 642 - suggestion: Use active voice instead of passive voice
  • Line 54 - suggestion: Spell out 'UTC' on first use
  • Line 72 - suggestion: Try to simplify this sentence.
  • Line 114 - suggestion: Spell out 'QED' on first use
  • Line 114 - suggestion: Spell out 'RAW' on first use
  • Line 114 - suggestion: Spell out 'VDI' on first use
  • Line 114 - suggestion: Spell out 'VHDX' on first use
  • Line 114 - suggestion: Spell out 'VMDK' on first use
  • Lines 119, 185, 233, 432, 455, 459, 490, 598 - suggestion: Keep sentences under 30 words
  • Line 155 - suggestion: Spell out 'AMD' on first use
  • Line 223 - suggestion: Spell out 'ADD' on first use
  • Lines 265, 266, 267 - suggestion: Spell out 'ISO' on first use
  • Line 283 - suggestion: Spell out 'SPICE' on first use
  • Line 354 - suggestion: Spell out 'GRUB' on first use
  • Lines 392, 412 - error: Use 'login' instead of 'Log in'
  • Line 412 - suggestion: Use 'login' instead of 'Log in'
  • Lines 446, 471 - suggestion: Use 'backup' instead of 'back up'
  • Lines 452, 565 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 452 - error: Use 'after' instead of 'once'
  • Line 454 - suggestion: Use 'login' instead of 'log in'
  • Line 454 - error: Use 'login' instead of 'log in'
  • Lines 511, 641, 642 - suggestion: Spell out 'USED' on first use
  • Line 511 - suggestion: Spell out 'REFER' on first use

static/includes/RESTAPIDeprecationNotice.md (9 issues)

  • Lines 4, 5, 7 - suggestion: Spell out 'REST' on first use
  • Lines 4, 5, 7 - suggestion: Use active voice instead of passive voice

static/includes/25.04Virtualization.md (7 issues)

  • Lines 7, 16, 19 - suggestion: Use active voice instead of passive voice
  • Line 14 - error: Don't use 'backend'. See the A-Z word list for details.

static/includes/SCALEUpgradePaths.md (3 issues)

  • Line 81 - suggestion: Spell out 'ISO' on first use
  • Line 85 - suggestion: Use active voice instead of passive voice

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

@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.

@tonyriv3 tonyriv3 added the Technical Writer Review (TR) A technical writer is reviewing the PR. label Oct 30, 2026
Comment thread static/includes/25.04Virtualization.md Resolved
Comment thread static/includes/25.04Virtualization.md Resolved
@github-actions

github-actions Bot commented Nov 4, 2026 •

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

Vale Style Guide Issues

📊 Summary: 502 issues found in changed files - 65 errors, 5 warnings, 432 suggestions

Changed files with issues:

content/GettingStarted/VersionNotes.md (395 issues)

  • Line 36 - suggestion: Try to simplify this sentence.
  • Lines 41, 48, 53, 57, 59, 63, 75, 84, 90, 99, 114, 120, 143, 152, 155, 161, 163, 164, 177, 186, 189, 192, 198, 201, 206, 207, 210, 220, 225, 228, 231, 243, 245, 256, 265, 268, 280, 289, 313, 314, 322, 336, 366, 375, 377, 381, 387, 414, 441, 444, 487, 503, 513, 517, 527, 529, 538, 544, 553, 559, 578, 587, 593, 617, 639, 671, 676, 680, 700, 705, 707, 713, 715, 716, 726, 730, 733, 737, 805, 829, 831, 850, 867, 868, 873, 875, 917, 992 - suggestion: Use active voice instead of passive voice
  • Lines 45, 104, 148, 182 - suggestion: Spell out 'LTS' on first use
  • Line 47 - error: Avoid possessive forms ('client's'). Rephrase to avoid using apostrophes for possession.
  • Line 48 - suggestion: Spell out 'NULL' on first use
  • Lines 56, 105, 422 - suggestion: Spell out 'RDMA' on first use
  • Line 59 - error: Avoid possessive forms ('target's'). Rephrase to avoid using apostrophes for possession.
  • Lines 60, 189, 246, 696, 811 - error: Use 'after' instead of 'once'
  • Line 63 - suggestion: Spell out 'VRRP' on first use
  • Line 63 - error: Avoid possessive forms ('controller's'). Rephrase to avoid using apostrophes for possession.
  • Line 63 - suggestion: Spell out 'VIP' on first use
  • Line 66 - error: Use 'Controller 1' instead of 'controller a'
  • Line 72 - suggestion: Spell out 'SSSD' on first use
  • Line 87 - warning: Prefer 'cloud' over 'the Cloud'.
  • Lines 92, 134, 169, 212, 250, 270, 330, 356, 405, 497, 531, 580, 650 - error: Use 'login' instead of 'log in'
  • Lines 105, 149, 183, 186, 257 - error: Form a negative number with an en dash, not a hyphen.
  • Line 105 - suggestion: Spell out 'TIPC' on first use
  • Line 111 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 117, 155, 248, 446, 447, 640, 641, 642, 643, 644, 802, 861, 867, 869, 873, 874, 875, 883, 887, 896, 897, 901 - suggestion: Spell out 'SMART' on first use
  • Line 137 - error: Remove the spaces around ' –'.
  • Line 139 - suggestion: '*****.0 Notable Changes' should use sentence-style capitalization.
  • Line 149 - suggestion: Spell out 'ACK' on first use
  • Line 149 - suggestion: Spell out 'SCTP' on first use
  • Line 152 - suggestion: Spell out 'OOM' on first use
  • Line 164 - suggestion: Spell out 'RFC' on first use
  • Line 186 - suggestion: Spell out 'WORM' on first use
  • Line 186 - error: Use 'after' instead of 'Once'
  • Line 189 - suggestion: Spell out 'BRT' on first use
  • Lines 195, 645, 877 - suggestion: Spell out 'SCSI' on first use
  • Lines 228, 441, 635 - error: Don't use 'backend'. See the A-Z word list for details.
  • Line 237 - suggestion: Spell out 'MII' on first use
  • Lines 240, 699 - suggestion: Spell out 'EBUSY' on first use
  • Line 243 - suggestion: Use 'MB' instead of 'megabytes'
  • Line 246 - error: Avoid possessive forms ('snapshot's'). Rephrase to avoid using apostrophes for possession.
  • Line 246 - error: Remove the spaces around ' — '.
  • Line 254 - error: Use 'could' instead of 'May'
  • Lines 257, 262 - suggestion: Spell out 'AEAD' on first use
  • Line 261 - suggestion: Spell out 'CVSS' on first use
  • Line 268 - warning: Prefer 'personal digital assistant' over 'agent'.
  • Line 268 - suggestion: Spell out 'MIB' on first use
  • Line 298 - suggestion: Spell out 'YAML' on first use
  • Lines 317, 555 - suggestion: Spell out 'CORE' on first use
  • Line 319 - suggestion: Spell out 'URI' on first use
  • Lines 337, 416, 596, 788, 926, 927 - suggestion: Keep sentences under 30 words
  • Lines 376, 377, 638, 639 - suggestion: Spell out 'REST' on first use
  • Line 383 - suggestion: Spell out 'PIN' on first use
  • Line 385 - suggestion: Spell out 'OVMF' on first use
  • Line 387 - suggestion: Spell out 'ISO' on first use
  • Lines 388, 423, 572 - suggestion: Spell out 'VDI' on first use
  • Lines 400, 893 - suggestion: Spell out 'HDD' on first use
  • Line 401 - suggestion: Spell out 'OID' on first use
  • Lines 423, 572 - suggestion: Spell out 'RAW' on first use
  • Lines 423, 572 - suggestion: Spell out 'VHDX' on first use
  • Lines 423, 572 - suggestion: Spell out 'VMDK' on first use
  • Lines 439, 914, 915 - suggestion: Spell out 'RTX' on first use
  • Lines 439, 914, 922 - suggestion: Spell out 'GTX' on first use
  • Lines 440, 441, 635, 797 - suggestion: Spell out 'IDMAP' on first use
  • Lines 441, 636, 798 - suggestion: Spell out 'RID' on first use
  • Lines 488, 489 - suggestion: Spell out 'AMD' on first use
  • Lines 510, 511 - suggestion: Spell out 'VFS' on first use
  • Line 521 - error: Punctuation should be inside the quotes.
  • Line 565 - warning: Prefer 'KB' over 'kB'.
  • Line 572 - suggestion: Spell out 'QED' on first use
  • Line 578 - suggestion: Spell out 'PGP' on first use
  • Line 611 - suggestion: Spell out 'ACME' on first use
  • Line 705 - suggestion: Avoid using 'will' - use present tense instead of future tense
  • Line 716 - suggestion: Spell out 'SCST' on first use
  • Line 718 - suggestion: Use Oxford comma before 'and' in lists
  • Line 788 - warning: Use first person (such as 'My') sparingly.
  • Line 797 - error: Don't use 'Backend'. See the A-Z word list for details.
  • Line 819 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 836 - suggestion: 'TrueNAS Apps' should use sentence-style capitalization.
  • Line 907 - suggestion: 'NVIDIA GPU Support' should use sentence-style capitalization.
  • Line 915 - suggestion: Spell out 'PRO' on first use
  • Lines 915, 923 - suggestion: Spell out 'GSP' on first use
  • Line 931 - suggestion: 'Upgrade Paths' should use sentence-style capitalization.

content/SCALETutorials/VirtualMachines/_index.md (92 issues)

  • Lines 51, 59, 64, 66, 72, 85, 176, 193, 204, 210, 265, 437, 478, 479, 480, 484, 486, 499, 542, 544, 548, 585, 610, 642 - suggestion: Use active voice instead of passive voice
  • Line 54 - suggestion: Spell out 'UTC' on first use
  • Line 72 - suggestion: Try to simplify this sentence.
  • Line 114 - suggestion: Spell out 'QED' on first use
  • Line 114 - suggestion: Spell out 'RAW' on first use
  • Line 114 - suggestion: Spell out 'VDI' on first use
  • Line 114 - suggestion: Spell out 'VHDX' on first use
  • Line 114 - suggestion: Spell out 'VMDK' on first use
  • Lines 119, 185, 233, 432, 455, 459, 490, 598 - suggestion: Keep sentences under 30 words
  • Line 155 - suggestion: Spell out 'AMD' on first use
  • Line 223 - suggestion: Spell out 'ADD' on first use
  • Lines 265, 266, 267 - suggestion: Spell out 'ISO' on first use
  • Line 283 - suggestion: Spell out 'SPICE' on first use
  • Line 354 - suggestion: Spell out 'GRUB' on first use
  • Lines 392, 412 - error: Use 'login' instead of 'Log in'
  • Line 412 - suggestion: Use 'login' instead of 'Log in'
  • Lines 446, 471 - suggestion: Use 'backup' instead of 'back up'
  • Lines 452, 565 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 452 - error: Use 'after' instead of 'once'
  • Line 454 - suggestion: Use 'login' instead of 'log in'
  • Line 454 - error: Use 'login' instead of 'log in'
  • Lines 511, 641, 642 - suggestion: Spell out 'USED' on first use
  • Line 511 - suggestion: Spell out 'REFER' on first use

static/includes/RESTAPIDeprecationNotice.md (7 issues)

  • Lines 4, 5, 7 - suggestion: Spell out 'REST' on first use
  • Lines 4, 7 - suggestion: Use active voice instead of passive voice

static/includes/25.04Virtualization.md (5 issues)

  • Lines 7, 20 - suggestion: Use active voice instead of passive voice
  • Line 14 - error: Don't use 'backend'. See the A-Z word list for details.

static/includes/SCALEUpgradePaths.md (3 issues)

  • Line 81 - suggestion: Spell out 'ISO' on first use
  • Line 85 - suggestion: Use active voice instead of passive voice

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

@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown

Vale Style Guide Issues

📊 Summary: 535 issues found in changed files - 85 errors, 5 warnings, 445 suggestions

Changed files with issues:

content/GettingStarted/VersionNotes.md (431 issues)

  • Line 36 - suggestion: Try to simplify this sentence.
  • Lines 41, 47, 57, 63, 67, 76, 88, 95, 100, 104, 106, 110, 122, 131, 137, 147, 162, 168, 190, 199, 202, 208, 210, 211, 224, 233, 236, 239, 245, 248, 253, 254, 257, 267, 272, 275, 278, 290, 292, 303, 312, 315, 327, 336, 360, 361, 369, 383, 413, 422, 424, 428, 434, 461, 488, 491, 534, 550, 560, 564, 574, 576, 585, 591, 600, 606, 625, 634, 640, 664, 686, 718, 723, 727, 747, 752, 754, 760, 762, 763, 773, 777, 780, 784, 852, 876, 878, 897, 914, 915, 920, 922, 964, 1039 - suggestion: Use active voice instead of passive voice
  • Lines 49, 92, 152, 195, 229 - suggestion: Spell out 'LTS' on first use
  • Lines 53, 54, 55, 56, 57, 58, 153, 196, 230, 233, 304 - error: Form a negative number with an en dash, not a hyphen.
  • Line 57 - suggestion: Spell out 'BIG' on first use
  • Line 61 - error: Use 'filesystem' instead of 'file system'
  • Lines 79, 139, 182, 216, 259, 297, 317, 377, 403, 452, 544, 578, 627, 697 - error: Use 'login' instead of 'log in'
  • Line 82 - error: Remove the spaces around ' –'.
  • Line 84 - suggestion: '*****.0 Notable Changes' should use sentence-style capitalization.
  • Line 94 - error: Avoid possessive forms ('client's'). Rephrase to avoid using apostrophes for possession.
  • Line 95 - suggestion: Spell out 'NULL' on first use
  • Lines 103, 153, 469 - suggestion: Spell out 'RDMA' on first use
  • Line 106 - error: Avoid possessive forms ('target's'). Rephrase to avoid using apostrophes for possession.
  • Lines 107, 236, 293, 743, 858 - error: Use 'after' instead of 'once'
  • Line 110 - suggestion: Spell out 'VRRP' on first use
  • Line 110 - error: Avoid possessive forms ('controller's'). Rephrase to avoid using apostrophes for possession.
  • Line 110 - suggestion: Spell out 'VIP' on first use
  • Line 113 - error: Use 'Controller 1' instead of 'controller a'
  • Line 119 - suggestion: Spell out 'SSSD' on first use
  • Line 134 - warning: Prefer 'cloud' over 'the Cloud'.
  • Line 153 - suggestion: Spell out 'TIPC' on first use
  • Line 159 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 165, 202, 295, 493, 494, 687, 688, 689, 690, 691, 849, 908, 914, 916, 920, 921, 922, 930, 934, 943, 944, 948 - suggestion: Spell out 'SMART' on first use
  • Line 196 - suggestion: Spell out 'ACK' on first use
  • Line 196 - suggestion: Spell out 'SCTP' on first use
  • Line 199 - suggestion: Spell out 'OOM' on first use
  • Line 211 - suggestion: Spell out 'RFC' on first use
  • Line 233 - suggestion: Spell out 'WORM' on first use
  • Line 233 - error: Use 'after' instead of 'Once'
  • Line 236 - suggestion: Spell out 'BRT' on first use
  • Lines 242, 692, 924 - suggestion: Spell out 'SCSI' on first use
  • Lines 275, 488, 682 - error: Don't use 'backend'. See the A-Z word list for details.
  • Line 284 - suggestion: Spell out 'MII' on first use
  • Lines 287, 746 - suggestion: Spell out 'EBUSY' on first use
  • Line 290 - suggestion: Use 'MB' instead of 'megabytes'
  • Line 293 - error: Avoid possessive forms ('snapshot's'). Rephrase to avoid using apostrophes for possession.
  • Line 293 - error: Remove the spaces around ' — '.
  • Line 301 - error: Use 'could' instead of 'May'
  • Lines 304, 309 - suggestion: Spell out 'AEAD' on first use
  • Line 308 - suggestion: Spell out 'CVSS' on first use
  • Line 315 - warning: Prefer 'personal digital assistant' over 'agent'.
  • Line 315 - suggestion: Spell out 'MIB' on first use
  • Line 345 - suggestion: Spell out 'YAML' on first use
  • Lines 364, 602 - suggestion: Spell out 'CORE' on first use
  • Line 366 - suggestion: Spell out 'URI' on first use
  • Lines 384, 463, 643, 835, 973, 974 - suggestion: Keep sentences under 30 words
  • Lines 423, 424, 685, 686 - suggestion: Spell out 'REST' on first use
  • Line 430 - suggestion: Spell out 'PIN' on first use
  • Line 432 - suggestion: Spell out 'OVMF' on first use
  • Line 434 - suggestion: Spell out 'ISO' on first use
  • Lines 435, 470, 619 - suggestion: Spell out 'VDI' on first use
  • Lines 447, 940 - suggestion: Spell out 'HDD' on first use
  • Line 448 - suggestion: Spell out 'OID' on first use
  • Lines 470, 619 - suggestion: Spell out 'RAW' on first use
  • Lines 470, 619 - suggestion: Spell out 'VHDX' on first use
  • Lines 470, 619 - suggestion: Spell out 'VMDK' on first use
  • Lines 486, 961, 962 - suggestion: Spell out 'RTX' on first use
  • Lines 486, 961, 969 - suggestion: Spell out 'GTX' on first use
  • Lines 487, 488, 682, 844 - suggestion: Spell out 'IDMAP' on first use
  • Lines 488, 683, 845 - suggestion: Spell out 'RID' on first use
  • Lines 535, 536 - suggestion: Spell out 'AMD' on first use
  • Lines 557, 558 - suggestion: Spell out 'VFS' on first use
  • Line 568 - error: Punctuation should be inside the quotes.
  • Line 612 - warning: Prefer 'KB' over 'kB'.
  • Line 619 - suggestion: Spell out 'QED' on first use
  • Line 625 - suggestion: Spell out 'PGP' on first use
  • Line 658 - suggestion: Spell out 'ACME' on first use
  • Line 752 - suggestion: Avoid using 'will' - use present tense instead of future tense
  • Line 763 - suggestion: Spell out 'SCST' on first use
  • Line 765 - suggestion: Use Oxford comma before 'and' in lists
  • Line 835 - warning: Use first person (such as 'My') sparingly.
  • Line 844 - error: Don't use 'Backend'. See the A-Z word list for details.
  • Line 866 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 883 - suggestion: 'TrueNAS Apps' should use sentence-style capitalization.
  • Line 954 - suggestion: 'NVIDIA GPU Support' should use sentence-style capitalization.
  • Line 962 - suggestion: Spell out 'PRO' on first use
  • Lines 962, 970 - suggestion: Spell out 'GSP' on first use
  • Line 978 - suggestion: 'Upgrade Paths' should use sentence-style capitalization.

content/SCALETutorials/VirtualMachines/_index.md (92 issues)

  • Lines 51, 59, 64, 66, 72, 85, 176, 193, 204, 210, 265, 437, 478, 479, 480, 484, 486, 499, 542, 544, 548, 585, 610, 642 - suggestion: Use active voice instead of passive voice
  • Line 54 - suggestion: Spell out 'UTC' on first use
  • Line 72 - suggestion: Try to simplify this sentence.
  • Line 114 - suggestion: Spell out 'QED' on first use
  • Line 114 - suggestion: Spell out 'RAW' on first use
  • Line 114 - suggestion: Spell out 'VDI' on first use
  • Line 114 - suggestion: Spell out 'VHDX' on first use
  • Line 114 - suggestion: Spell out 'VMDK' on first use
  • Lines 119, 185, 233, 432, 455, 459, 490, 598 - suggestion: Keep sentences under 30 words
  • Line 155 - suggestion: Spell out 'AMD' on first use
  • Line 223 - suggestion: Spell out 'ADD' on first use
  • Lines 265, 266, 267 - suggestion: Spell out 'ISO' on first use
  • Line 283 - suggestion: Spell out 'SPICE' on first use
  • Line 354 - suggestion: Spell out 'GRUB' on first use
  • Lines 392, 412 - error: Use 'login' instead of 'Log in'
  • Line 412 - suggestion: Use 'login' instead of 'Log in'
  • Lines 446, 471 - suggestion: Use 'backup' instead of 'back up'
  • Lines 452, 565 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 452 - error: Use 'after' instead of 'once'
  • Line 454 - suggestion: Use 'login' instead of 'log in'
  • Line 454 - error: Use 'login' instead of 'log in'
  • Lines 511, 641, 642 - suggestion: Spell out 'USED' on first use
  • Line 511 - suggestion: Spell out 'REFER' on first use

static/includes/RESTAPIDeprecationNotice.md (7 issues)

  • Lines 4, 5, 7 - suggestion: Spell out 'REST' on first use
  • Lines 4, 7 - suggestion: Use active voice instead of passive voice

static/includes/25.04Virtualization.md (5 issues)

  • Lines 7, 20 - suggestion: Use active voice instead of passive voice
  • Line 14 - error: Don't use 'backend'. See the A-Z word list for details.

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

@tonyriv3
tonyriv3 merged commit 52637ab into 25.10 Nov 6, 2026
2 checks passed
@tonyriv3
tonyriv3 deleted the DOCS-2633-25.10-upgrade-prep branch November 6, 2026 14:32
@bugclerk

bugclerk commented Nov 6, 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 6, 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 6, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

no-time-tracked Technical Writer Review (TR) A technical writer is reviewing the PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants