DOCS-2586 / 25.10 / DOCS-2586-tn-hardware-guide-hm-smr-drive-support (by linzi-ix)

[bugclerk]

Automatic cherry-pick failed. Please resolve conflicts by running:

git reset --hard HEAD~1
git cherry-pick -x 25ab3c5e5d17d621244c24bafbb2f51bb7f94a7a
git cherry-pick -x 9d30aa4adeab5c07c7d92740ddf29915f7512ca3

If the original PR was merged via a squash, you can just cherry-pick the squashed commit:

git reset --hard HEAD~1
git cherry-pick -x 1206221517130f3a9efd041d31a6cc9df72138e6

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.

Original PR: #4597
Jira URL: https://ixsystemsinc.atlassian.net/browse/DOCS-2586

[github-actions]

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 109 issues found in changed files - 10 errors, 4 warnings, 95 suggestions

Changed files with issues:

static/includes/TNHardwareGuide.md (109 issues)

• Lines 18, 19, 20, 71, 92, 261, 419 - suggestion: Avoid using first-person plural (we, us, our)
• Lines 28, 56, 65, 83, 100, 107, 153, 173, 181, 183, 229, 244, 261, 267, 269, 314, 375 - suggestion: Keep sentences under 30 words
• Lines 28, 29, 322 - error: Use 'filesystem' instead of 'file system'
• Lines 30, 314, 323, 324, 325, 331, 389, 417 - suggestion: Use active voice instead of passive voice
• Lines 51, 168, 420, 423 - error: Use 'after' instead of 'once'
• Lines 51, 232, 238, 241, 242, 243, 244, 245, 247 - suggestion: Spell out 'RAID' on first use
• Line 53 - warning: Prefer 'every day' over '24/7'.
• Line 79 - suggestion: Spell out 'RPM' on first use
• Line 80 - suggestion: Spell out 'SCSI' on first use
• Lines 122, 210, 216, 217 - suggestion: Spell out 'HDD' on first use
• Lines 136, 278 - suggestion: Spell out 'DRAM' on first use
• Lines 137, 142, 144, 146, 147, 148 - suggestion: Spell out 'SLOG' on first use
• Line 148 - error: Use 'login' instead of 'LOG in'
• Line 186 - suggestion: Spell out 'III' on first use
• Line 197 - warning: Use first person (such as ' I') sparingly.
• Line 197 - warning: Use first person (such as 'my') sparingly.
• Line 229 - warning: Prefer 'GB' over 'Gb'.
• Line 231 - suggestion: Spell out 'IBM' on first use
• Line 285 - suggestion: Use 'backup' instead of 'back up'
• Line 315 - suggestion: Spell out 'ARK' on first use
• Lines 330, 331, 336 - suggestion: Spell out 'AMD' on first use
• Lines 380, 381, 383 - suggestion: Spell out 'UPS' on first use
• Line 381 - suggestion: Spell out 'APC' on first use
• Line 390 - error: Always spell out the name of the month.

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

[github-actions]

Vale Style Guide Issues

📊 Summary: 109 issues found in changed files - 10 errors, 4 warnings, 95 suggestions

Changed files with issues:

static/includes/TNHardwareGuide.md (109 issues)

• Lines 18, 19, 20, 71, 92, 261, 419 - suggestion: Avoid using first-person plural (we, us, our)
• Lines 28, 56, 65, 83, 100, 107, 153, 173, 181, 183, 229, 244, 261, 267, 269, 314, 375 - suggestion: Keep sentences under 30 words
• Lines 28, 29, 322 - error: Use 'filesystem' instead of 'file system'
• Lines 30, 314, 323, 324, 325, 331, 389, 417 - suggestion: Use active voice instead of passive voice
• Lines 51, 168, 420, 423 - error: Use 'after' instead of 'once'
• Lines 51, 232, 238, 241, 242, 243, 244, 245, 247 - suggestion: Spell out 'RAID' on first use
• Line 53 - warning: Prefer 'every day' over '24/7'.
• Line 79 - suggestion: Spell out 'RPM' on first use
• Line 80 - suggestion: Spell out 'SCSI' on first use
• Lines 122, 210, 216, 217 - suggestion: Spell out 'HDD' on first use
• Lines 136, 278 - suggestion: Spell out 'DRAM' on first use
• Lines 137, 142, 144, 146, 147, 148 - suggestion: Spell out 'SLOG' on first use
• Line 148 - error: Use 'login' instead of 'LOG in'
• Line 186 - suggestion: Spell out 'III' on first use
• Line 197 - warning: Use first person (such as ' I') sparingly.
• Line 197 - warning: Use first person (such as 'my') sparingly.
• Line 229 - warning: Prefer 'GB' over 'Gb'.
• Line 231 - suggestion: Spell out 'IBM' on first use
• Line 285 - suggestion: Use 'backup' instead of 'back up'
• Line 315 - suggestion: Spell out 'ARK' on first use
• Lines 330, 331, 336 - suggestion: Spell out 'AMD' on first use
• Lines 380, 381, 383 - suggestion: Spell out 'UPS' on first use
• Line 381 - suggestion: Spell out 'APC' on first use
• Line 390 - error: Always spell out the name of the month.

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