Skip to content

PD-2172 / 25.04 / Pd 2172 add migrate instance vm content #4231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 9 commits into from
Oct 31, 2025
Merged

PD-2172 / 25.04 / Pd 2172 add migrate instance vm content #4231

merged 9 commits into from
Oct 31, 2025

Conversation

@micjohnson777
Copy link
Contributor

@micjohnson777 micjohnson777 commented Oct 17, 2025

This PR manually backports the content on migrating the zvols for Instance VMs to 25.10. It updates the snippet file, release notes and adds the procedure to the /virtualmachines/_index.md file.

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.

@micjohnson777
PD-2172 25.04 Manual Backport of Instance VM zvol Migration
fd2edb9 
This PR manually backports the VM changes made in the 25.10 branch into the 25.04 branch. It updates the Release Notes with information about migrating Instance VM zvols and adds the procedure to the /virtuatlMachines/_index.md tutorial.
@micjohnson777
PD-2172 Fix broken links
f0f40de
@micjohnson777 micjohnson777 requested a review from a team as a code owner October 17, 2025 17:56
@micjohnson777 micjohnson777 added the Version Specific This PR needs to be merged to a specific version branch or on a specific version release day. label Oct 17, 2025
@bugclerk bugclerk changed the title Pd 2172 add migrate instance vm content PD-2172 / 25.04 / Pd 2172 add migrate instance vm content Oct 17, 2025
@bugclerk
Copy link
Contributor

bugclerk commented Oct 17, 2025

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

@github-actions
Copy link

github-actions bot commented Oct 17, 2025 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 243 issues found in changed files - 21 errors, 1 warnings, 221 suggestions

Changed files with issues:

content/GettingStarted/SCALEReleaseNotes.md (154 issues)

  • Lines 37, 364 - suggestion: Keep sentences under 30 words
  • Line 37 - suggestion: Try to simplify this sentence.
  • Line 37 - warning: Use first person (such as 'My') sparingly.
  • Lines 41, 99, 113, 126, 137, 150, 175, 177, 187, 193, 197, 198, 199, 203, 214, 220, 228, 240, 246, 251, 260, 261, 265, 273, 277, 288, 293, 300, 324, 329, 330, 336, 347, 355, 361, 371, 372, 378, 383, 387, 390, 400, 409, 415, 420, 431, 436, 441, 443, 445, 455 - suggestion: Use active voice instead of passive voice
  • Line 118 - error: Use 'clear' instead of 'uncheck'
  • Line 143 - suggestion: Spell out 'NSS' on first use
  • Lines 164, 322 - error: Use 'after' instead of 'once'
  • Line 194 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Lines 197, 198 - error: Use 'could' instead of 'may'
  • Lines 212, 286, 345 - suggestion: Spell out 'TTY' on first use
  • Lines 212, 286, 345 - suggestion: Consider 'TrueNAS' instead of 'Docker'
  • Line 226 - error: Use 'could' instead of 'May'
  • Line 243 - suggestion: Spell out 'BOTH' on first use
  • Line 247 - suggestion: Spell out 'OOM' on first use
  • Line 256 - suggestion: Spell out 'JSON' on first use
  • Line 272 - suggestion: Spell out 'RPC' on first use
  • Line 272 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 283, 284, 342, 343, 396, 397, 451, 452 - error: Punctuation should be inside the quotes.
  • Lines 317, 384 - suggestion: Spell out 'IDMAP' on first use
  • Line 368 - suggestion: Spell out 'HDD' on first use
  • Line 368 - suggestion: Spell out 'SMART' on first use
  • Line 370 - suggestion: Spell out 'CORE' on first use
  • Line 420 - suggestion: Spell out 'REST' on first use
  • Lines 423, 424 - suggestion: Spell out 'RDMA' on first use
  • Line 426 - suggestion: Spell out 'XCOPY' on first use
  • Line 426 - suggestion: Spell out 'ZVOL' on first use

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

  • Line 49 - suggestion: Spell out 'UTC' on first use
  • Line 51 - suggestion: Spell out 'BIOS' on first use
  • Lines 55, 59, 62, 68, 169, 185, 240, 406, 447, 448, 449, 452, 458, 463, 469, 472, 511, 535, 538, 559 - suggestion: Use active voice instead of passive voice
  • Lines 61, 169, 170, 258 - suggestion: Spell out 'SPICE' on first use
  • Line 137 - suggestion: Spell out 'AMD' on first use
  • Lines 179, 397, 402, 422, 476, 511, 547, 559 - suggestion: Keep sentences under 30 words
  • Line 198 - suggestion: Spell out 'ADD' on first use
  • Lines 240, 241, 242 - suggestion: Spell out 'ISO' on first use
  • Line 328 - suggestion: Spell out 'GRUB' on first use
  • Lines 366, 386 - error: Use 'login' instead of 'Log in'
  • Line 386 - suggestion: Use 'login' instead of 'Log in'
  • Line 415 - suggestion: Use 'backup' instead of 'back up'
  • Lines 419, 523 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 419 - error: Use 'after' instead of 'once'
  • Line 421 - suggestion: Use 'login' instead of 'log in'
  • Line 421 - error: Use 'login' instead of 'log in'

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

  • Line 5 - suggestion: Spell out 'CORE' on first use
  • Lines 9, 13, 17, 20, 21 - suggestion: Use active voice instead of passive voice
  • Line 28 - suggestion: Keep sentences under 30 words

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

@micjohnson777 micjohnson777 marked this pull request as draft October 20, 2025 13:47
@micjohnson777
Copy link
Contributor Author

micjohnson777 commented Oct 20, 2025

Working on procedure updates in the 25.10 branch PR that impacts this PR. Putting into draft until edits complete in that PR.

@micjohnson777
PD-2172 Manual Backport of Changes
2bcd942 
This commit makes changes to the 25.04 branch based on merged changes in 25.10 but modified for the 25.04 branch.
@github-actions
Copy link

github-actions bot commented Oct 28, 2025 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 305 issues found in changed files - 25 errors, 2 warnings, 278 suggestions

Changed files with issues:

content/GettingStarted/SCALEReleaseNotes.md (158 issues)

  • Lines 37, 379 - suggestion: Keep sentences under 30 words
  • Line 37 - suggestion: Try to simplify this sentence.
  • Line 37 - warning: Use first person (such as 'My') sparingly.
  • Lines 41, 99, 112, 122, 129, 142, 153, 166, 191, 194, 204, 210, 214, 215, 216, 220, 231, 237, 245, 255, 261, 266, 275, 276, 280, 288, 292, 303, 308, 315, 339, 344, 345, 351, 362, 370, 376, 386, 387, 393, 398, 402, 405, 415, 424, 430, 435, 446, 451, 456, 458, 460, 470 - suggestion: Use active voice instead of passive voice
  • Line 134 - error: Use 'clear' instead of 'uncheck'
  • Line 159 - suggestion: Spell out 'NSS' on first use
  • Lines 180, 337 - error: Use 'after' instead of 'once'
  • Line 211 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Lines 214, 215 - error: Use 'could' instead of 'may'
  • Lines 229, 301, 360 - suggestion: Spell out 'TTY' on first use
  • Lines 229, 301, 360 - suggestion: Consider 'TrueNAS' instead of 'Docker'
  • Line 243 - error: Use 'could' instead of 'May'
  • Line 258 - suggestion: Spell out 'BOTH' on first use
  • Line 262 - suggestion: Spell out 'OOM' on first use
  • Line 271 - suggestion: Spell out 'JSON' on first use
  • Line 287 - suggestion: Spell out 'RPC' on first use
  • Line 287 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 298, 299, 357, 358, 411, 412, 466, 467 - error: Punctuation should be inside the quotes.
  • Lines 332, 399 - suggestion: Spell out 'IDMAP' on first use
  • Line 383 - suggestion: Spell out 'HDD' on first use
  • Line 383 - suggestion: Spell out 'SMART' on first use
  • Line 385 - suggestion: Spell out 'CORE' on first use
  • Line 435 - suggestion: Spell out 'REST' on first use
  • Lines 438, 439 - suggestion: Spell out 'RDMA' on first use
  • Line 441 - suggestion: Spell out 'XCOPY' on first use
  • Line 441 - suggestion: Spell out 'ZVOL' on first use

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

  • Line 49 - suggestion: Spell out 'UTC' on first use
  • Line 51 - suggestion: Spell out 'BIOS' on first use
  • Lines 55, 59, 62, 68, 169, 185, 240, 406, 446, 447, 448, 451, 457, 462, 466, 506, 530, 533, 555 - suggestion: Use active voice instead of passive voice
  • Lines 61, 169, 170, 258 - suggestion: Spell out 'SPICE' on first use
  • Line 137 - suggestion: Spell out 'AMD' on first use
  • Lines 179, 208, 397, 402, 420, 471, 506, 543 - suggestion: Keep sentences under 30 words
  • Line 198 - suggestion: Spell out 'ADD' on first use
  • Lines 240, 241, 242 - suggestion: Spell out 'ISO' on first use
  • Line 328 - suggestion: Spell out 'GRUB' on first use
  • Lines 366, 386 - error: Use 'login' instead of 'Log in'
  • Line 386 - suggestion: Use 'login' instead of 'Log in'
  • Lines 413, 439 - suggestion: Use 'backup' instead of 'back up'
  • Lines 417, 518 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 417 - error: Use 'after' instead of 'once'
  • Line 419 - suggestion: Use 'login' instead of 'log in'
  • Line 419 - error: Use 'login' instead of 'log in'

content/SCALETutorials/Containers/_index.md (58 issues)

  • Lines 25, 269 - error: Use 'filesystem' instead of 'file system'
  • Lines 35, 82, 120, 162, 182, 187, 196, 206, 207, 378, 379, 390, 391, 402, 411, 441, 476, 536 - suggestion: Use active voice instead of passive voice
  • Lines 162, 379 - suggestion: Use Oxford comma before 'and' in lists
  • Lines 176, 179, 190, 192, 193, 196, 206 - suggestion: Spell out 'UID' on first use
  • Lines 176, 179 - suggestion: Spell out 'GID' on first use
  • Lines 196, 585 - suggestion: Keep sentences under 30 words
  • Line 302 - suggestion: Spell out 'MAC' on first use
  • Line 318 - suggestion: Spell out 'AMD' on first use
  • Line 446 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 446 - suggestion: Spell out 'IOMMU' on first use
  • Line 584 - warning: For a general audience, use 'address' rather than 'URL'.
  • Line 585 - error: Use 'hostname' instead of 'host name'

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

  • Line 5 - suggestion: Spell out 'CORE' on first use
  • Lines 7, 11, 15, 18, 19 - suggestion: Use active voice instead of passive voice

content/SCALETutorials/Network/ContainerNASBridge.md (3 issues)

  • Lines 25, 65 - suggestion: Spell out 'MAC' on first use
  • Line 50 - suggestion: Use 'setup' instead of 'set up'

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

@github-actions
Copy link

github-actions bot commented Oct 28, 2025 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 305 issues found in changed files - 25 errors, 2 warnings, 278 suggestions

Changed files with issues:

content/GettingStarted/SCALEReleaseNotes.md (158 issues)

  • Lines 37, 379 - suggestion: Keep sentences under 30 words
  • Line 37 - suggestion: Try to simplify this sentence.
  • Line 37 - warning: Use first person (such as 'My') sparingly.
  • Lines 41, 99, 112, 122, 129, 142, 153, 166, 191, 194, 204, 210, 214, 215, 216, 220, 231, 237, 245, 255, 261, 266, 275, 276, 280, 288, 292, 303, 308, 315, 339, 344, 345, 351, 362, 370, 376, 386, 387, 393, 398, 402, 405, 415, 424, 430, 435, 446, 451, 456, 458, 460, 470 - suggestion: Use active voice instead of passive voice
  • Line 134 - error: Use 'clear' instead of 'uncheck'
  • Line 159 - suggestion: Spell out 'NSS' on first use
  • Lines 180, 337 - error: Use 'after' instead of 'once'
  • Line 211 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Lines 214, 215 - error: Use 'could' instead of 'may'
  • Lines 229, 301, 360 - suggestion: Spell out 'TTY' on first use
  • Lines 229, 301, 360 - suggestion: Consider 'TrueNAS' instead of 'Docker'
  • Line 243 - error: Use 'could' instead of 'May'
  • Line 258 - suggestion: Spell out 'BOTH' on first use
  • Line 262 - suggestion: Spell out 'OOM' on first use
  • Line 271 - suggestion: Spell out 'JSON' on first use
  • Line 287 - suggestion: Spell out 'RPC' on first use
  • Line 287 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 298, 299, 357, 358, 411, 412, 466, 467 - error: Punctuation should be inside the quotes.
  • Lines 332, 399 - suggestion: Spell out 'IDMAP' on first use
  • Line 383 - suggestion: Spell out 'HDD' on first use
  • Line 383 - suggestion: Spell out 'SMART' on first use
  • Line 385 - suggestion: Spell out 'CORE' on first use
  • Line 435 - suggestion: Spell out 'REST' on first use
  • Lines 438, 439 - suggestion: Spell out 'RDMA' on first use
  • Line 441 - suggestion: Spell out 'XCOPY' on first use
  • Line 441 - suggestion: Spell out 'ZVOL' on first use

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

  • Line 49 - suggestion: Spell out 'UTC' on first use
  • Line 51 - suggestion: Spell out 'BIOS' on first use
  • Lines 55, 59, 62, 68, 169, 185, 240, 406, 446, 447, 448, 451, 457, 462, 466, 506, 530, 533, 555 - suggestion: Use active voice instead of passive voice
  • Lines 61, 169, 170, 258 - suggestion: Spell out 'SPICE' on first use
  • Line 137 - suggestion: Spell out 'AMD' on first use
  • Lines 179, 208, 397, 402, 420, 471, 506, 543 - suggestion: Keep sentences under 30 words
  • Line 198 - suggestion: Spell out 'ADD' on first use
  • Lines 240, 241, 242 - suggestion: Spell out 'ISO' on first use
  • Line 328 - suggestion: Spell out 'GRUB' on first use
  • Lines 366, 386 - error: Use 'login' instead of 'Log in'
  • Line 386 - suggestion: Use 'login' instead of 'Log in'
  • Lines 413, 439 - suggestion: Use 'backup' instead of 'back up'
  • Lines 417, 518 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 417 - error: Use 'after' instead of 'once'
  • Line 419 - error: Use 'login' instead of 'log in'
  • Line 419 - suggestion: Use 'login' instead of 'log in'

content/SCALETutorials/Containers/_index.md (58 issues)

  • Lines 25, 269 - error: Use 'filesystem' instead of 'file system'
  • Lines 35, 82, 120, 162, 182, 187, 196, 206, 207, 378, 379, 390, 391, 402, 411, 441, 476, 536 - suggestion: Use active voice instead of passive voice
  • Lines 162, 379 - suggestion: Use Oxford comma before 'and' in lists
  • Lines 176, 179, 190, 192, 193, 196, 206 - suggestion: Spell out 'UID' on first use
  • Lines 176, 179 - suggestion: Spell out 'GID' on first use
  • Lines 196, 585 - suggestion: Keep sentences under 30 words
  • Line 302 - suggestion: Spell out 'MAC' on first use
  • Line 318 - suggestion: Spell out 'AMD' on first use
  • Line 446 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 446 - suggestion: Spell out 'IOMMU' on first use
  • Line 584 - warning: For a general audience, use 'address' rather than 'URL'.
  • Line 585 - error: Use 'hostname' instead of 'host name'

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

  • Line 5 - suggestion: Spell out 'CORE' on first use
  • Lines 7, 11, 15, 18, 19 - suggestion: Use active voice instead of passive voice

content/SCALETutorials/Network/ContainerNASBridge.md (3 issues)

  • Lines 25, 65 - suggestion: Spell out 'MAC' on first use
  • Line 50 - suggestion: Use 'setup' instead of 'set up'

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

@micjohnson777 micjohnson777 marked this pull request as ready for review October 28, 2025 15:41
@micjohnson777
Copy link
Contributor Author

micjohnson777 commented Oct 28, 2025

Updated manually with changes made to 25.10 branch versions but still appropriate for 25.04 branch

@github-actions
Copy link

github-actions bot commented Oct 28, 2025 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 307 issues found in changed files - 26 errors, 2 warnings, 279 suggestions

Changed files with issues:

content/GettingStarted/SCALEReleaseNotes.md (160 issues)

  • Lines 37, 383 - suggestion: Keep sentences under 30 words
  • Line 37 - suggestion: Try to simplify this sentence.
  • Line 37 - warning: Use first person (such as 'My') sparingly.
  • Lines 41, 99, 112, 122, 129, 142, 153, 166, 191, 194, 204, 214, 218, 219, 220, 224, 235, 241, 249, 259, 265, 270, 279, 280, 284, 292, 296, 307, 312, 319, 343, 348, 349, 355, 366, 374, 380, 390, 391, 397, 402, 406, 409, 419, 428, 434, 439, 450, 455, 460, 462, 464, 474 - suggestion: Use active voice instead of passive voice
  • Line 134 - error: Use 'clear' instead of 'uncheck'
  • Line 159 - suggestion: Spell out 'NSS' on first use
  • Lines 180, 212, 341 - error: Use 'after' instead of 'once'
  • Line 211 - suggestion: Spell out 'DST' on first use
  • Line 215 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Lines 218, 219 - error: Use 'could' instead of 'may'
  • Lines 233, 305, 364 - suggestion: Spell out 'TTY' on first use
  • Lines 233, 305, 364 - suggestion: Consider 'TrueNAS' instead of 'Docker'
  • Line 247 - error: Use 'could' instead of 'May'
  • Line 262 - suggestion: Spell out 'BOTH' on first use
  • Line 266 - suggestion: Spell out 'OOM' on first use
  • Line 275 - suggestion: Spell out 'JSON' on first use
  • Line 291 - suggestion: Spell out 'RPC' on first use
  • Line 291 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 302, 303, 361, 362, 415, 416, 470, 471 - error: Punctuation should be inside the quotes.
  • Lines 336, 403 - suggestion: Spell out 'IDMAP' on first use
  • Line 387 - suggestion: Spell out 'HDD' on first use
  • Line 387 - suggestion: Spell out 'SMART' on first use
  • Line 389 - suggestion: Spell out 'CORE' on first use
  • Line 439 - suggestion: Spell out 'REST' on first use
  • Lines 442, 443 - suggestion: Spell out 'RDMA' on first use
  • Line 445 - suggestion: Spell out 'XCOPY' on first use
  • Line 445 - suggestion: Spell out 'ZVOL' on first use

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

  • Line 49 - suggestion: Spell out 'UTC' on first use
  • Line 51 - suggestion: Spell out 'BIOS' on first use
  • Lines 55, 59, 62, 68, 169, 185, 240, 406, 446, 447, 448, 451, 457, 462, 466, 506, 530, 533, 555 - suggestion: Use active voice instead of passive voice
  • Lines 61, 169, 170, 258 - suggestion: Spell out 'SPICE' on first use
  • Line 137 - suggestion: Spell out 'AMD' on first use
  • Lines 179, 208, 397, 402, 420, 471, 506, 543 - suggestion: Keep sentences under 30 words
  • Line 198 - suggestion: Spell out 'ADD' on first use
  • Lines 240, 241, 242 - suggestion: Spell out 'ISO' on first use
  • Line 328 - suggestion: Spell out 'GRUB' on first use
  • Lines 366, 386 - error: Use 'login' instead of 'Log in'
  • Line 386 - suggestion: Use 'login' instead of 'Log in'
  • Lines 413, 439 - suggestion: Use 'backup' instead of 'back up'
  • Lines 417, 518 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 417 - error: Use 'after' instead of 'once'
  • Line 419 - suggestion: Use 'login' instead of 'log in'
  • Line 419 - error: Use 'login' instead of 'log in'

content/SCALETutorials/Containers/_index.md (58 issues)

  • Lines 25, 269 - error: Use 'filesystem' instead of 'file system'
  • Lines 35, 82, 120, 162, 182, 187, 196, 206, 207, 378, 379, 390, 391, 402, 411, 441, 476, 536 - suggestion: Use active voice instead of passive voice
  • Lines 162, 379 - suggestion: Use Oxford comma before 'and' in lists
  • Lines 176, 179, 190, 192, 193, 196, 206 - suggestion: Spell out 'UID' on first use
  • Lines 176, 179 - suggestion: Spell out 'GID' on first use
  • Lines 196, 585 - suggestion: Keep sentences under 30 words
  • Line 302 - suggestion: Spell out 'MAC' on first use
  • Line 318 - suggestion: Spell out 'AMD' on first use
  • Line 446 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 446 - suggestion: Spell out 'IOMMU' on first use
  • Line 584 - warning: For a general audience, use 'address' rather than 'URL'.
  • Line 585 - error: Use 'hostname' instead of 'host name'

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

  • Line 5 - suggestion: Spell out 'CORE' on first use
  • Lines 7, 11, 15, 18, 19 - suggestion: Use active voice instead of passive voice

content/SCALETutorials/Network/ContainerNASBridge.md (3 issues)

  • Lines 25, 65 - suggestion: Spell out 'MAC' on first use
  • Line 50 - suggestion: Use 'setup' instead of 'set up'

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

@micjohnson777
PD-2172 Updates to match 25.10 Branch Changes
deb2f60 
This commit adds information and a new command to set zvol properties to match those of natively-created VM zvols.
@github-actions

This comment was marked as outdated.

Sign in to view
@github-actions

This comment was marked as duplicate.

Sign in to view
@github-actions
Copy link

github-actions bot commented Oct 31, 2025 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 305 issues found in changed files - 26 errors, 2 warnings, 277 suggestions

Changed files with issues:

content/GettingStarted/SCALEReleaseNotes.md (162 issues)

  • Lines 37, 390 - suggestion: Keep sentences under 30 words
  • Line 37 - suggestion: Try to simplify this sentence.
  • Line 37 - warning: Use first person (such as 'My') sparingly.
  • Lines 41, 99, 112, 119, 129, 136, 149, 160, 173, 198, 201, 211, 221, 225, 226, 227, 231, 242, 248, 256, 266, 272, 277, 286, 287, 291, 299, 303, 314, 319, 326, 350, 355, 356, 362, 373, 381, 387, 397, 398, 404, 409, 413, 416, 426, 435, 441, 446, 457, 462, 467, 469, 471, 481 - suggestion: Use active voice instead of passive voice
  • Line 141 - error: Use 'clear' instead of 'uncheck'
  • Line 166 - suggestion: Spell out 'NSS' on first use
  • Lines 187, 219, 348 - error: Use 'after' instead of 'once'
  • Line 218 - suggestion: Spell out 'DST' on first use
  • Line 222 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Lines 225, 226 - error: Use 'could' instead of 'may'
  • Lines 240, 312, 371 - suggestion: Spell out 'TTY' on first use
  • Lines 240, 312, 371 - suggestion: Consider 'TrueNAS' instead of 'Docker'
  • Line 254 - error: Use 'could' instead of 'May'
  • Line 269 - suggestion: Spell out 'BOTH' on first use
  • Line 273 - suggestion: Spell out 'OOM' on first use
  • Line 282 - suggestion: Spell out 'JSON' on first use
  • Line 298 - suggestion: Spell out 'RPC' on first use
  • Line 298 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 309, 310, 368, 369, 422, 423, 477, 478 - error: Punctuation should be inside the quotes.
  • Lines 343, 410 - suggestion: Spell out 'IDMAP' on first use
  • Line 394 - suggestion: Spell out 'HDD' on first use
  • Line 394 - suggestion: Spell out 'SMART' on first use
  • Line 396 - suggestion: Spell out 'CORE' on first use
  • Line 446 - suggestion: Spell out 'REST' on first use
  • Lines 449, 450 - suggestion: Spell out 'RDMA' on first use
  • Line 452 - suggestion: Spell out 'XCOPY' on first use
  • Line 452 - suggestion: Spell out 'ZVOL' on first use

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

  • Line 49 - suggestion: Spell out 'UTC' on first use
  • Line 51 - suggestion: Spell out 'BIOS' on first use
  • Lines 55, 59, 62, 68, 169, 240, 406, 446, 447, 448, 451, 457, 462, 466, 506, 531, 555 - suggestion: Use active voice instead of passive voice
  • Lines 61, 169, 170, 258 - suggestion: Spell out 'SPICE' on first use
  • Line 137 - suggestion: Spell out 'AMD' on first use
  • Lines 179, 208, 397, 402, 420, 471, 506 - suggestion: Keep sentences under 30 words
  • Line 198 - suggestion: Spell out 'ADD' on first use
  • Lines 240, 241, 242 - suggestion: Spell out 'ISO' on first use
  • Line 328 - suggestion: Spell out 'GRUB' on first use
  • Lines 366, 386 - error: Use 'login' instead of 'Log in'
  • Line 386 - suggestion: Use 'login' instead of 'Log in'
  • Lines 413, 439 - suggestion: Use 'backup' instead of 'back up'
  • Lines 417, 518 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 417 - error: Use 'after' instead of 'once'
  • Line 419 - error: Use 'login' instead of 'log in'
  • Line 419 - suggestion: Use 'login' instead of 'log in'
  • Line 455 - suggestion: Spell out 'QEM' on first use

content/SCALETutorials/Containers/_index.md (58 issues)

  • Lines 25, 269 - error: Use 'filesystem' instead of 'file system'
  • Lines 35, 82, 120, 162, 182, 187, 196, 206, 207, 378, 379, 390, 391, 402, 411, 441, 476, 536 - suggestion: Use active voice instead of passive voice
  • Lines 162, 379 - suggestion: Use Oxford comma before 'and' in lists
  • Lines 176, 179, 190, 192, 193, 196, 206 - suggestion: Spell out 'UID' on first use
  • Lines 176, 179 - suggestion: Spell out 'GID' on first use
  • Lines 196, 585 - suggestion: Keep sentences under 30 words
  • Line 302 - suggestion: Spell out 'MAC' on first use
  • Line 318 - suggestion: Spell out 'AMD' on first use
  • Line 446 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 446 - suggestion: Spell out 'IOMMU' on first use
  • Line 584 - warning: For a general audience, use 'address' rather than 'URL'.
  • Line 585 - error: Use 'hostname' instead of 'host name'

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

  • Line 5 - suggestion: Spell out 'CORE' on first use
  • Lines 7, 11, 15, 18, 19 - suggestion: Use active voice instead of passive voice

content/SCALETutorials/Network/ContainerNASBridge.md (3 issues)

  • Lines 25, 65 - suggestion: Spell out 'MAC' on first use
  • Line 50 - suggestion: Use 'setup' instead of 'set up'

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

@github-actions
Copy link

github-actions bot commented Oct 31, 2025

Vale Style Guide Issues

📊 Summary: 305 issues found in changed files - 26 errors, 2 warnings, 277 suggestions

Changed files with issues:

content/GettingStarted/SCALEReleaseNotes.md (162 issues)

  • Lines 37, 390 - suggestion: Keep sentences under 30 words
  • Line 37 - suggestion: Try to simplify this sentence.
  • Line 37 - warning: Use first person (such as 'My') sparingly.
  • Lines 41, 99, 112, 119, 129, 136, 149, 160, 173, 198, 201, 211, 221, 225, 226, 227, 231, 242, 248, 256, 266, 272, 277, 286, 287, 291, 299, 303, 314, 319, 326, 350, 355, 356, 362, 373, 381, 387, 397, 398, 404, 409, 413, 416, 426, 435, 441, 446, 457, 462, 467, 469, 471, 481 - suggestion: Use active voice instead of passive voice
  • Line 141 - error: Use 'clear' instead of 'uncheck'
  • Line 166 - suggestion: Spell out 'NSS' on first use
  • Lines 187, 219, 348 - error: Use 'after' instead of 'once'
  • Line 218 - suggestion: Spell out 'DST' on first use
  • Line 222 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Lines 225, 226 - error: Use 'could' instead of 'may'
  • Lines 240, 312, 371 - suggestion: Spell out 'TTY' on first use
  • Lines 240, 312, 371 - suggestion: Consider 'TrueNAS' instead of 'Docker'
  • Line 254 - error: Use 'could' instead of 'May'
  • Line 269 - suggestion: Spell out 'BOTH' on first use
  • Line 273 - suggestion: Spell out 'OOM' on first use
  • Line 282 - suggestion: Spell out 'JSON' on first use
  • Line 298 - suggestion: Spell out 'RPC' on first use
  • Line 298 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 309, 310, 368, 369, 422, 423, 477, 478 - error: Punctuation should be inside the quotes.
  • Lines 343, 410 - suggestion: Spell out 'IDMAP' on first use
  • Line 394 - suggestion: Spell out 'HDD' on first use
  • Line 394 - suggestion: Spell out 'SMART' on first use
  • Line 396 - suggestion: Spell out 'CORE' on first use
  • Line 446 - suggestion: Spell out 'REST' on first use
  • Lines 449, 450 - suggestion: Spell out 'RDMA' on first use
  • Line 452 - suggestion: Spell out 'XCOPY' on first use
  • Line 452 - suggestion: Spell out 'ZVOL' on first use

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

  • Line 49 - suggestion: Spell out 'UTC' on first use
  • Line 51 - suggestion: Spell out 'BIOS' on first use
  • Lines 55, 59, 62, 68, 169, 240, 406, 446, 447, 448, 451, 457, 462, 466, 506, 531, 555 - suggestion: Use active voice instead of passive voice
  • Lines 61, 169, 170, 258 - suggestion: Spell out 'SPICE' on first use
  • Line 137 - suggestion: Spell out 'AMD' on first use
  • Lines 179, 208, 397, 402, 420, 471, 506 - suggestion: Keep sentences under 30 words
  • Line 198 - suggestion: Spell out 'ADD' on first use
  • Lines 240, 241, 242 - suggestion: Spell out 'ISO' on first use
  • Line 328 - suggestion: Spell out 'GRUB' on first use
  • Lines 366, 386 - error: Use 'login' instead of 'Log in'
  • Line 386 - suggestion: Use 'login' instead of 'Log in'
  • Lines 413, 439 - suggestion: Use 'backup' instead of 'back up'
  • Lines 417, 518 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 417 - error: Use 'after' instead of 'once'
  • Line 419 - suggestion: Use 'login' instead of 'log in'
  • Line 419 - error: Use 'login' instead of 'log in'
  • Line 455 - suggestion: Spell out 'QEM' on first use

content/SCALETutorials/Containers/_index.md (58 issues)

  • Lines 25, 269 - error: Use 'filesystem' instead of 'file system'
  • Lines 35, 82, 120, 162, 182, 187, 196, 206, 207, 378, 379, 390, 391, 402, 411, 441, 476, 536 - suggestion: Use active voice instead of passive voice
  • Lines 162, 379 - suggestion: Use Oxford comma before 'and' in lists
  • Lines 176, 179, 190, 192, 193, 196, 206 - suggestion: Spell out 'UID' on first use
  • Lines 176, 179 - suggestion: Spell out 'GID' on first use
  • Lines 196, 585 - suggestion: Keep sentences under 30 words
  • Line 302 - suggestion: Spell out 'MAC' on first use
  • Line 318 - suggestion: Spell out 'AMD' on first use
  • Line 446 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 446 - suggestion: Spell out 'IOMMU' on first use
  • Line 584 - warning: For a general audience, use 'address' rather than 'URL'.
  • Line 585 - error: Use 'hostname' instead of 'host name'

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

  • Line 5 - suggestion: Spell out 'CORE' on first use
  • Lines 7, 11, 15, 18, 19 - suggestion: Use active voice instead of passive voice

content/SCALETutorials/Network/ContainerNASBridge.md (3 issues)

  • Lines 25, 65 - suggestion: Spell out 'MAC' on first use
  • Line 50 - suggestion: Use 'setup' instead of 'set up'

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

@DjP-iX DjP-iX merged commit 69fe871 into 25.04 Oct 31, 2025
4 checks passed
@DjP-iX DjP-iX deleted the PD-2172-Add-Migratee-Instance-VM-Content branch October 31, 2025 13:28
@bugclerk
Copy link
Contributor

bugclerk commented Oct 31, 2025

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 Oct 31, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@DjP-iX DjP-iX DjP-iX approved these changes

Assignees

No one assigned

Labels

Version Specific This PR needs to be merged to a specific version branch or on a specific version release day.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@micjohnson777 @bugclerk @DjP-iX @tonyriv3