Skip to content

Conversation

@bugclerk
Copy link
Contributor

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

git cherry-pick -x c5a922c2db6210b2f7530deebfa60d25cfecbeef
git cherry-pick -x f2aa58f45ca22184cb4c320cd225d9f5cdf26b46
git cherry-pick -x 83cc7b53b9491a13f3571f7ec34297892c2b0720
git cherry-pick -x 7060768978f7c683cbd4a620d3a9cb73437dac57

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

git reset --hard HEAD~7
git cherry-pick -x fbd498505c4840aee97abdafbdcb2c91a6bb438b

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

(cherry picked from commit 5f8fcf9)
(cherry picked from commit 74a3de3)
(cherry picked from commit 3132cf5)
(cherry picked from commit 86fb120)
(cherry picked from commit 6b96eff)
(cherry picked from commit 24251d0)
@github-actions
Copy link

github-actions bot commented Oct 27, 2025

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 181 issues found in changed files - 16 errors, 2 warnings, 163 suggestions

Changed files with issues:

content/SCALE/SCALETutorials/Shares/SMB/_index.md (75 issues)

  • Lines 29, 37, 55, 72, 93, 107, 126, 131, 174, 179, 183, 189, 193, 197, 221, 229, 262, 366, 415 - suggestion: Use active voice instead of passive voice
  • Line 51 - warning: Use first person (such as ' I') sparingly.
  • Line 51 - warning: Don't use end punctuation in headings.
  • Lines 67, 72, 100, 141, 142, 264, 320, 333, 392, 397, 406, 412 - suggestion: Keep sentences under 30 words
  • Line 89 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 152 - error: Use 'filesystem' instead of 'file system'
  • Lines 186, 400 - suggestion: Spell out 'SHARE' on first use
  • Line 225 - error: Use 'login' instead of 'log in'
  • Lines 242, 248, 361 - error: Use 'hostname' instead of 'host name'
  • Lines 268, 269 - suggestion: Spell out 'NTFS' on first use
  • Lines 273, 397 - suggestion: Use 'setup' instead of 'set up'
  • Line 356 - suggestion: Spell out 'YES' on first use

content/SCALE/SCALETutorials/Shares/iSCSI/AddingISCSIShares.md (31 issues)

  • Lines 34, 99, 253 - suggestion: Use Title Case for headings
  • Line 77 - suggestion: Keep sentences under 30 words
  • Lines 91, 120, 197, 233 - suggestion: Spell out 'CIDR' on first use
  • Lines 93, 94, 186 - error: Use 'hostname' instead of 'host name'
  • Lines 123, 235, 238, 248 - suggestion: Use active voice instead of passive voice
  • Line 143 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 176 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Line 186 - suggestion: Spell out 'ISNS' on first use
  • Lines 211, 213, 215, 216, 243 - suggestion: Spell out 'CHAP' on first use

content/SCALE/SCALETutorials/Shares/MixedModeShares.md (30 issues)

  • Lines 29, 81, 95 - suggestion: Use active voice instead of passive voice
  • Lines 31, 161 - suggestion: Spell out 'APPL' on first use
  • Lines 51, 59, 63, 86, 92, 143, 151, 200, 233 - suggestion: Keep sentences under 30 words
  • Lines 51, 169 - suggestion: Spell out 'UNIX' on first use
  • Line 151 - suggestion: Spell out 'SBM' on first use
  • Line 200 - error: Use 'filesystem' instead of 'file system'

content/SCALE/SCALETutorials/Shares/AddingNFSShares.md (15 issues)

  • Line 19 - error: Use 'filesystem' instead of 'File System'
  • Line 23 - error: Use 'filesystem' instead of 'file system'
  • Lines 80, 81 - suggestion: Spell out 'CIDR' on first use
  • Line 85 - error: Use 'hostname' instead of 'host name'
  • Lines 104, 134 - suggestion: Use active voice instead of passive voice
  • Lines 154, 155, 157 - suggestion: Spell out 'RDMA' on first use
  • Line 175 - suggestion: Keep sentences under 30 words
  • Line 189 - suggestion: Spell out 'ESXI' on first use

content/SCALE/SCALETutorials/Shares/SMB/SetUpBasicTimeMachineSMBShare.md (14 issues)

  • Line 21 - suggestion: Use 'setup' instead of 'set up'
  • Line 23 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Lines 32, 44, 81, 86 - suggestion: Keep sentences under 30 words
  • Line 72 - suggestion: Use active voice instead of passive voice

content/SCALE/SCALETutorials/Credentials/_index.md (10 issues)

  • Lines 11, 30 - suggestion: Use active voice instead of passive voice
  • Lines 19, 23, 28 - suggestion: Use 'setup' instead of 'set up'
  • Line 23 - suggestion: Use 'backup' instead of 'back up'
  • Line 30 - suggestion: Use 'login' instead of 'log in'
  • Line 30 - error: Use 'login' instead of 'log in'

content/SCALE/SCALETutorials/SystemSettings/_index.md (6 issues)

  • Lines 20, 41, 49 - suggestion: Use active voice instead of passive voice
  • Line 41 - suggestion: Use Oxford comma before 'and' in lists

🔧 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 (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 181 issues found in changed files - 16 errors, 2 warnings, 163 suggestions

Changed files with issues:

content/SCALE/SCALETutorials/Shares/SMB/_index.md (75 issues)

  • Lines 29, 37, 55, 72, 93, 107, 126, 131, 174, 179, 183, 189, 193, 197, 221, 229, 262, 366, 415 - suggestion: Use active voice instead of passive voice
  • Line 51 - warning: Use first person (such as ' I') sparingly.
  • Line 51 - warning: Don't use end punctuation in headings.
  • Lines 67, 72, 100, 141, 142, 264, 320, 333, 392, 397, 406, 412 - suggestion: Keep sentences under 30 words
  • Line 89 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 152 - error: Use 'filesystem' instead of 'file system'
  • Lines 186, 400 - suggestion: Spell out 'SHARE' on first use
  • Line 225 - error: Use 'login' instead of 'log in'
  • Lines 242, 248, 361 - error: Use 'hostname' instead of 'host name'
  • Lines 268, 269 - suggestion: Spell out 'NTFS' on first use
  • Lines 273, 397 - suggestion: Use 'setup' instead of 'set up'
  • Line 356 - suggestion: Spell out 'YES' on first use

content/SCALE/SCALETutorials/Shares/iSCSI/AddingISCSIShares.md (31 issues)

  • Lines 34, 99, 253 - suggestion: Use Title Case for headings
  • Line 77 - suggestion: Keep sentences under 30 words
  • Lines 91, 120, 197, 233 - suggestion: Spell out 'CIDR' on first use
  • Lines 93, 94, 186 - error: Use 'hostname' instead of 'host name'
  • Lines 123, 235, 238, 248 - suggestion: Use active voice instead of passive voice
  • Line 143 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 176 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Line 186 - suggestion: Spell out 'ISNS' on first use
  • Lines 211, 213, 215, 216, 243 - suggestion: Spell out 'CHAP' on first use

content/SCALE/SCALETutorials/Shares/MixedModeShares.md (30 issues)

  • Lines 29, 81, 95 - suggestion: Use active voice instead of passive voice
  • Lines 31, 161 - suggestion: Spell out 'APPL' on first use
  • Lines 51, 59, 63, 86, 92, 143, 151, 200, 233 - suggestion: Keep sentences under 30 words
  • Lines 51, 169 - suggestion: Spell out 'UNIX' on first use
  • Line 151 - suggestion: Spell out 'SBM' on first use
  • Line 200 - error: Use 'filesystem' instead of 'file system'

content/SCALE/SCALETutorials/Shares/AddingNFSShares.md (15 issues)

  • Line 19 - error: Use 'filesystem' instead of 'File System'
  • Line 23 - error: Use 'filesystem' instead of 'file system'
  • Lines 80, 81 - suggestion: Spell out 'CIDR' on first use
  • Line 85 - error: Use 'hostname' instead of 'host name'
  • Lines 104, 134 - suggestion: Use active voice instead of passive voice
  • Lines 154, 155, 157 - suggestion: Spell out 'RDMA' on first use
  • Line 175 - suggestion: Keep sentences under 30 words
  • Line 189 - suggestion: Spell out 'ESXI' on first use

content/SCALE/SCALETutorials/Shares/SMB/SetUpBasicTimeMachineSMBShare.md (14 issues)

  • Line 21 - suggestion: Use 'setup' instead of 'set up'
  • Line 23 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Lines 32, 44, 81, 86 - suggestion: Keep sentences under 30 words
  • Line 72 - suggestion: Use active voice instead of passive voice

content/SCALE/SCALETutorials/Credentials/_index.md (10 issues)

  • Lines 11, 30 - suggestion: Use active voice instead of passive voice
  • Lines 19, 23, 28 - suggestion: Use 'setup' instead of 'set up'
  • Line 23 - suggestion: Use 'backup' instead of 'back up'
  • Line 30 - suggestion: Use 'login' instead of 'log in'
  • Line 30 - error: Use 'login' instead of 'log in'

content/SCALE/SCALETutorials/SystemSettings/_index.md (6 issues)

  • Lines 20, 41, 49 - suggestion: Use active voice instead of passive voice
  • Line 41 - suggestion: Use Oxford comma before 'and' in lists

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

DjP-iX and others added 2 commits October 31, 2025 12:01
* Update _index.md

* Update AddingNFSShares.md

* Update AddingISCSIShares.md

* Update MixedModeShares.md

* Update _index.md

* Update SetUpBasicTimeMachineSMBShare.md

* Update _index.md

* Update ManageGlobal2FASCALE.md

* Update _index.md

* Update _index.md

---------

Co-authored-by: linzibelle <linzi.moore@ixsystems.com>
(cherry picked from commit fbd4985)
@DjP-iX DjP-iX marked this pull request as ready for review October 31, 2025 16:01
@DjP-iX DjP-iX requested a review from a team as a code owner October 31, 2025 16:01
@tonyriv3 tonyriv3 added the Technical Writer Review (TR) A technical writer is reviewing the PR. label Oct 31, 2025
@github-actions
Copy link

Vale Style Guide Issues

📊 Summary: 235 issues found in changed files - 29 errors, 2 warnings, 204 suggestions

Changed files with issues:

content/SCALE/SCALETutorials/Shares/SMB/_index.md (75 issues)

  • Lines 29, 37, 55, 72, 93, 107, 126, 131, 174, 179, 183, 189, 193, 197, 221, 229, 262, 366, 415 - suggestion: Use active voice instead of passive voice
  • Line 51 - warning: Use first person (such as ' I') sparingly.
  • Line 51 - warning: Don't use end punctuation in headings.
  • Lines 67, 72, 100, 141, 142, 264, 320, 333, 392, 397, 406, 412 - suggestion: Keep sentences under 30 words
  • Line 89 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 152 - error: Use 'filesystem' instead of 'file system'
  • Lines 186, 400 - suggestion: Spell out 'SHARE' on first use
  • Line 225 - error: Use 'login' instead of 'log in'
  • Lines 242, 248, 361 - error: Use 'hostname' instead of 'host name'
  • Lines 268, 269 - suggestion: Spell out 'NTFS' on first use
  • Lines 273, 397 - suggestion: Use 'setup' instead of 'set up'
  • Line 356 - suggestion: Spell out 'YES' on first use

content/SCALE/SCALETutorials/SystemSettings/Advanced/ManageGlobal2FASCALE.md (52 issues)

  • Lines 28, 54, 91, 114, 117, 132 - suggestion: Use 'setup' instead of 'set up'
  • Lines 30, 34, 35, 69, 117, 174 - suggestion: Use active voice instead of passive voice
  • Lines 33, 34, 52, 59, 114, 118, 126, 132, 156 - suggestion: Use 'login' instead of 'log in'
  • Lines 33, 34, 52, 59, 114, 118, 126, 132, 156 - error: Use 'login' instead of 'log in'
  • Lines 34, 117 - error: Use 'after' instead of 'once'
  • Line 38 - suggestion: Spell out 'GPOS' on first use
  • Line 47 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 69 - suggestion: Keep sentences under 30 words
  • Line 75 - suggestion: Use 'setup' instead of 'Set up'
  • Lines 98, 106 - suggestion: Use 'setup' instead of 'Set Up'
  • Line 142 - suggestion: Use 'login' instead of 'Log in'
  • Line 142 - error: Use 'login' instead of 'Log in'
  • Line 158 - suggestion: Use Title Case for headings
  • Line 172 - error: Use 'hostname' instead of 'host name'

content/SCALE/SCALETutorials/Shares/iSCSI/AddingISCSIShares.md (31 issues)

  • Lines 34, 99, 253 - suggestion: Use Title Case for headings
  • Line 77 - suggestion: Keep sentences under 30 words
  • Lines 91, 120, 197, 233 - suggestion: Spell out 'CIDR' on first use
  • Lines 93, 94, 186 - error: Use 'hostname' instead of 'host name'
  • Lines 123, 235, 238, 248 - suggestion: Use active voice instead of passive voice
  • Line 143 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 176 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Line 186 - suggestion: Spell out 'ISNS' on first use
  • Lines 211, 213, 215, 216, 243 - suggestion: Spell out 'CHAP' on first use

content/SCALE/SCALETutorials/Shares/MixedModeShares.md (30 issues)

  • Lines 29, 81, 95 - suggestion: Use active voice instead of passive voice
  • Lines 31, 161 - suggestion: Spell out 'APPL' on first use
  • Lines 51, 59, 63, 86, 92, 143, 151, 200, 233 - suggestion: Keep sentences under 30 words
  • Lines 51, 169 - suggestion: Spell out 'UNIX' on first use
  • Line 151 - suggestion: Spell out 'SBM' on first use
  • Line 200 - error: Use 'filesystem' instead of 'file system'

content/SCALE/SCALETutorials/Shares/AddingNFSShares.md (15 issues)

  • Line 19 - error: Use 'filesystem' instead of 'File System'
  • Line 23 - error: Use 'filesystem' instead of 'file system'
  • Lines 80, 81 - suggestion: Spell out 'CIDR' on first use
  • Line 85 - error: Use 'hostname' instead of 'host name'
  • Lines 104, 134 - suggestion: Use active voice instead of passive voice
  • Lines 154, 155, 157 - suggestion: Spell out 'RDMA' on first use
  • Line 175 - suggestion: Keep sentences under 30 words
  • Line 189 - suggestion: Spell out 'ESXI' on first use

content/SCALE/SCALETutorials/Shares/SMB/SetUpBasicTimeMachineSMBShare.md (14 issues)

  • Line 21 - suggestion: Use 'setup' instead of 'set up'
  • Line 23 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Lines 32, 44, 81, 86 - suggestion: Keep sentences under 30 words
  • Line 72 - suggestion: Use active voice instead of passive voice

content/SCALE/SCALETutorials/Credentials/_index.md (10 issues)

  • Lines 11, 30 - suggestion: Use active voice instead of passive voice
  • Lines 19, 23, 28 - suggestion: Use 'setup' instead of 'set up'
  • Line 23 - suggestion: Use 'backup' instead of 'back up'
  • Line 30 - suggestion: Use 'login' instead of 'log in'
  • Line 30 - error: Use 'login' instead of 'log in'

content/SCALE/SCALETutorials/SystemSettings/_index.md (6 issues)

  • Lines 20, 41, 49 - suggestion: Use active voice instead of passive voice
  • Line 41 - suggestion: Use Oxford comma before 'and' in lists

content/SCALE/SCALEUIReference/SystemSettings/Services/_index.md (2 issues)

  • Line 31 - suggestion: Use active voice instead of passive voice

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

@tonyriv3 tonyriv3 merged commit f86a7cf into master Oct 31, 2025
6 checks passed
@tonyriv3 tonyriv3 deleted the PD-2266-26.04 branch October 31, 2025 16:09
@bugclerk
Copy link
Contributor Author

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.

Labels

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