PD-2231 / 25.10 / PD-2231-we-should-set-user-expectations-appropriately-for-managing-co… (by linzi-ix)

[bugclerk]

…nfigs-in-old-boot-environments

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: #4188
Jira URL: https://ixsystems.atlassian.net/browse/PD-2231

[github-actions]

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 63 issues found in changed files - 5 errors, 2 warnings, 56 suggestions

Changed files with issues:

content/SCALETutorials/SystemSettings/ManageBootEnvironSCALE.md (33 issues)

• Lines 15, 67, 78 - suggestion: Spell out 'ZFS' on first use
• Lines 19, 71 - suggestion: Verify your use of 'allows' with the A-Z word list.
• Lines 22, 98, 111 - suggestion: Keep sentences under 30 words
• Lines 23, 69, 78, 88, 94, 104 - suggestion: Avoid contractions in formal writing
• Lines 67, 78, 98 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
• Line 71 - warning: Remove 'greatly' if it's not important to the meaning of the statement.
• Line 98 - suggestion: Spell out 'IPMI' on first use
• Line 125 - suggestion: Verify your use of 'and/or' with the A-Z word list.

content/SCALEUIReference/SystemSettings/SystemBootScreensSCALE.md (20 issues)

• Line 10 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
• Lines 20, 55 - suggestion: Use Oxford comma before 'and' in lists
• Lines 20, 41, 52, 55, 91 - suggestion: Avoid contractions in formal writing
• Line 39 - error: 'Activate' is repeated!
• Lines 40, 85 - error: 'Clone' is repeated!
• Line 40 - suggestion: Verify your use of 'and/or' with the A-Z word list.
• Line 41 - error: 'Delete' is repeated!
• Line 42 - error: 'Keep' is repeated!
• Line 52 - suggestion: Use the Oxford comma in 'options, Attach or Replace.'.
• Line 55 - suggestion: Use the Oxford comma in 'options, Replace and Attach.'.
• Line 63 - suggestion: Keep sentences under 30 words

static/includes/BootPoolRecoveryProcess.md (10 issues)

• Lines 3, 29, 34 - suggestion: Avoid contractions in formal writing
• Line 22 - suggestion: Keep sentences under 30 words
• Line 27 - warning: Remove 'regularly' if it's not important to the meaning of the statement.

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

[micjohnson777]

A few suggestion to make it easier for ESL users to translate or understand the content.

[github-actions]

Vale Style Guide Issues

📊 Summary: 63 issues found in changed files - 5 errors, 3 warnings, 55 suggestions

Changed files with issues:

content/SCALETutorials/SystemSettings/ManageBootEnvironSCALE.md (33 issues)

• Lines 15, 67, 78 - suggestion: Spell out 'ZFS' on first use
• Lines 19, 71 - suggestion: Verify your use of 'allows' with the A-Z word list.
• Lines 22, 100, 113 - suggestion: Keep sentences under 30 words
• Lines 23, 69, 78, 88, 106 - suggestion: Avoid contractions in formal writing
• Lines 67, 78, 100 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
• Line 71 - warning: Remove 'greatly' if it's not important to the meaning of the statement.
• Line 100 - suggestion: Avoid using first-person plural (we, us, our)
• Line 100 - suggestion: Spell out 'IPMI' on first use
• Line 127 - suggestion: Verify your use of 'and/or' with the A-Z word list.

content/SCALEUIReference/SystemSettings/SystemBootScreensSCALE.md (20 issues)

• Line 10 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
• Lines 20, 55 - suggestion: Use Oxford comma before 'and' in lists
• Lines 20, 41, 52, 55, 91 - suggestion: Avoid contractions in formal writing
• Line 39 - error: 'Activate' is repeated!
• Lines 40, 85 - error: 'Clone' is repeated!
• Line 40 - suggestion: Verify your use of 'and/or' with the A-Z word list.
• Line 41 - error: 'Delete' is repeated!
• Line 42 - error: 'Keep' is repeated!
• Line 52 - suggestion: Use the Oxford comma in 'options, Attach or Replace.'.
• Line 55 - suggestion: Use the Oxford comma in 'options, Replace and Attach.'.
• Line 63 - suggestion: Keep sentences under 30 words

static/includes/BootPoolRecoveryProcess.md (10 issues)

• Lines 3, 29, 34 - suggestion: Avoid contractions in formal writing
• Line 22 - suggestion: Keep sentences under 30 words
• Line 27 - warning: Remove 'regularly' if it's not important to the meaning of the statement.

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

[bugclerk]

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.