DOCS-2100 / 27 / DOCS-2100 OpenShift Operator Documentation

[micjohnson777]

This commit creates the OpenShift Operator documentation in the Solutions > Integrations area. It adds the main _index.md file, the OpenShiftOperator.md admin guide, the OpenShiftReference.md reference guide, and the OpenShiftOperatorUserGuide.md for end users.

This can backport to 25.10 and 26.0 branches.

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.

[bugclerk]

Jira URL: https://ixsystemsinc.atlassian.net/browse/DOCS-2100

[micjohnson777]

Do not merge until the devs review and provide technical feedback.

[github-actions]

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 101 issues found in changed files - 16 errors, 2 warnings, 83 suggestions

Changed files with issues:

content/Solutions/Integrations/OpenShift/OpenShiftReference.md (29 issues)

• Lines 3, 15, 19 - error: Use 'after' instead of 'once'
• Lines 3, 15, 44, 54, 138 - suggestion: Spell out 'YAML' on first use
• Line 3 - suggestion: Use Oxford comma before 'and' in lists
• Lines 25, 263, 295, 299 - suggestion: Use active voice instead of passive voice
• Lines 31, 35, 44, 45, 47 - suggestion: Spell out 'PVC' on first use
• Lines 42, 180 - suggestion: Use Title Case for headings
• Line 107 - warning: For a general audience, use 'address' rather than 'URL'.
• Lines 263, 266 - error: Remove the spaces around ' — '.
• Line 351 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'

content/Solutions/Integrations/OpenShift/OpenShiftOperator.md (28 issues)

• Lines 34, 37 - suggestion: Keep sentences under 30 words
• Lines 34, 252 - suggestion: Spell out 'PVC' on first use
• Lines 34, 128, 241 - suggestion: Spell out 'YAML' on first use
• Lines 37, 80, 103 - suggestion: Use active voice instead of passive voice
• Line 37 - error: Don't add '(s)' to a singular noun. Use plural instead.
• Lines 56, 198, 199 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'
• Lines 57, 58 - error: Remove the spaces around ' — '.
• Line 59 - suggestion: Spell out 'CIDR' on first use
• Lines 67, 117 - suggestion: Use 'login' instead of 'Log in'
• Lines 67, 117 - error: Use 'login' instead of 'Log in'
• Line 71 - warning: Use first person (such as 'My') sparingly.
• Line 191 - error: Use 'Controller 1' instead of 'controller a'

content/Solutions/Integrations/OpenShift/_index.md (27 issues)

• Lines 23, 30 - suggestion: Spell out 'OLM' on first use
• Line 32 - suggestion: Spell out 'CRD' on first use
• Lines 32, 53 - suggestion: Spell out 'YAML' on first use
• Lines 37, 42, 44, 55, 56 - suggestion: Use active voice instead of passive voice
• Lines 41, 48, 53 - suggestion: Keep sentences under 30 words
• Line 41 - error: Don't use 'backend'. See the A-Z word list for details.
• Line 48 - error: Remove the spaces around ' — '.
• Line 48 - error: Avoid contractions. Use 'are not' instead of 'aren't'.
• Line 48 - error: Avoid contractions. Use 'they are' instead of 'they're'.
• Line 64 - suggestion: Spell out 'PVC' on first use

content/Solutions/Integrations/OpenShift/OpenShiftOperatorUserGuide.md (17 issues)

• Lines 16, 27, 33, 58, 60, 73, 129 - suggestion: Spell out 'PVC' on first use
• Lines 16, 274 - suggestion: Spell out 'YAML' on first use
• Lines 27, 73, 103 - suggestion: Use active voice instead of passive voice
• Line 201 - suggestion: Use Oxford comma before 'and' in lists
• Line 204 - suggestion: Use Title Case for headings

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

[zsw10]

Looks good. We've are released a new version of the driver which added some new features that will require additional documentation.

[github-actions]

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 86 issues found in changed files - 11 errors, 2 warnings, 73 suggestions

Changed files with issues:

content/Solutions/Integrations/OpenShift/OpenShiftReference.md (29 issues)

• Lines 3, 15, 19 - error: Use 'after' instead of 'once'
• Lines 3, 15, 44, 54, 138 - suggestion: Spell out 'YAML' on first use
• Line 3 - suggestion: Use Oxford comma before 'and' in lists
• Lines 21, 25, 263, 295, 299 - suggestion: Use active voice instead of passive voice
• Lines 31, 35, 44, 45, 47 - suggestion: Spell out 'PVC' on first use
• Line 107 - warning: For a general audience, use 'address' rather than 'URL'.
• Line 180 - suggestion: Use Title Case for headings
• Lines 263, 266 - error: Remove the spaces around ' — '.
• Line 351 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'

content/Solutions/Integrations/OpenShift/OpenShiftOperator.md (26 issues)

• Lines 34, 37 - suggestion: Keep sentences under 30 words
• Lines 34, 252 - suggestion: Spell out 'PVC' on first use
• Lines 34, 35, 128, 241 - suggestion: Spell out 'YAML' on first use
• Lines 37, 80, 103 - suggestion: Use active voice instead of passive voice
• Line 37 - error: Don't add '(s)' to a singular noun. Use plural instead.
• Line 59 - suggestion: Spell out 'CIDR' on first use
• Lines 67, 117 - error: Use 'login' instead of 'Log in'
• Lines 67, 117 - suggestion: Use 'login' instead of 'Log in'
• Line 71 - warning: Use first person (such as 'My') sparingly.
• Line 191 - error: Use 'Controller 1' instead of 'controller a'
• Lines 198, 199 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'

content/Solutions/Integrations/OpenShift/OpenShiftOperatorUserGuide.md (18 issues)

• Lines 16, 27, 33, 58, 60, 73, 129 - suggestion: Spell out 'PVC' on first use
• Lines 16, 276 - suggestion: Spell out 'YAML' on first use
• Lines 27, 73, 103 - suggestion: Use active voice instead of passive voice
• Line 161 - error: Use 'filesystem' instead of 'file system'
• Line 203 - suggestion: Use Oxford comma before 'and' in lists
• Line 206 - suggestion: Use Title Case for headings

content/Solutions/Integrations/OpenShift/_index.md (13 issues)

• Lines 23, 30 - suggestion: Spell out 'OLM' on first use
• Line 32 - suggestion: Spell out 'CRD' on first use
• Lines 32, 52 - suggestion: Spell out 'YAML' on first use
• Lines 37, 42, 56 - suggestion: Use active voice instead of passive voice
• Line 41 - error: Don't use 'backend'. See the A-Z word list for details.
• Line 64 - suggestion: Spell out 'PVC' on first use

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

[DjP-iX]

Submitted some simpler style edits and then a few other questions to take a look at. Overall it looks good

[github-actions]

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 86 issues found in changed files - 11 errors, 2 warnings, 73 suggestions

Changed files with issues:

content/Solutions/Integrations/OpenShift/OpenShiftReference.md (29 issues)

• Lines 3, 15, 19 - error: Use 'after' instead of 'once'
• Lines 3, 15, 44, 54, 138 - suggestion: Spell out 'YAML' on first use
• Line 3 - suggestion: Use Oxford comma before 'and' in lists
• Lines 21, 25, 263, 295, 299 - suggestion: Use active voice instead of passive voice
• Lines 31, 35, 44, 45, 47 - suggestion: Spell out 'PVC' on first use
• Line 107 - warning: For a general audience, use 'address' rather than 'URL'.
• Line 180 - suggestion: Use Title Case for headings
• Lines 263, 266 - error: Remove the spaces around ' — '.
• Line 351 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'

content/Solutions/Integrations/OpenShift/OpenShiftOperator.md (26 issues)

• Lines 34, 37 - suggestion: Keep sentences under 30 words
• Lines 34, 252 - suggestion: Spell out 'PVC' on first use
• Lines 34, 35, 128, 241 - suggestion: Spell out 'YAML' on first use
• Lines 37, 80, 103 - suggestion: Use active voice instead of passive voice
• Line 37 - error: Don't add '(s)' to a singular noun. Use plural instead.
• Line 59 - suggestion: Spell out 'CIDR' on first use
• Lines 67, 117 - error: Use 'login' instead of 'Log in'
• Lines 67, 117 - suggestion: Use 'login' instead of 'Log in'
• Line 71 - warning: Use first person (such as 'My') sparingly.
• Line 191 - error: Use 'Controller 1' instead of 'controller a'
• Lines 198, 199 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'

content/Solutions/Integrations/OpenShift/OpenShiftOperatorUserGuide.md (18 issues)

• Lines 16, 27, 33, 58, 60, 73, 129 - suggestion: Spell out 'PVC' on first use
• Lines 16, 276 - suggestion: Spell out 'YAML' on first use
• Lines 27, 73, 103 - suggestion: Use active voice instead of passive voice
• Line 161 - error: Use 'filesystem' instead of 'file system'
• Line 203 - suggestion: Use Oxford comma before 'and' in lists
• Line 206 - suggestion: Use Title Case for headings

content/Solutions/Integrations/OpenShift/_index.md (13 issues)

• Lines 23, 30 - suggestion: Spell out 'OLM' on first use
• Line 32 - suggestion: Spell out 'CRD' on first use
• Lines 32, 52 - suggestion: Spell out 'YAML' on first use
• Lines 37, 42, 56 - suggestion: Use active voice instead of passive voice
• Line 41 - error: Don't use 'backend'. See the A-Z word list for details.
• Line 64 - suggestion: Spell out 'PVC' on first use

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

[github-actions]

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 86 issues found in changed files - 11 errors, 2 warnings, 73 suggestions

Changed files with issues:

content/Solutions/Integrations/OpenShift/OpenShiftReference.md (29 issues)

• Lines 3, 15, 19 - error: Use 'after' instead of 'once'
• Lines 3, 15, 44, 54, 138 - suggestion: Spell out 'YAML' on first use
• Line 3 - suggestion: Use Oxford comma before 'and' in lists
• Lines 21, 25, 263, 295, 299 - suggestion: Use active voice instead of passive voice
• Lines 31, 35, 44, 45, 47 - suggestion: Spell out 'PVC' on first use
• Line 107 - warning: For a general audience, use 'address' rather than 'URL'.
• Line 180 - suggestion: Use Title Case for headings
• Lines 263, 266 - error: Remove the spaces around ' — '.
• Line 351 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'

content/Solutions/Integrations/OpenShift/OpenShiftOperator.md (26 issues)

• Lines 34, 37 - suggestion: Keep sentences under 30 words
• Lines 34, 252 - suggestion: Spell out 'PVC' on first use
• Lines 34, 35, 128, 241 - suggestion: Spell out 'YAML' on first use
• Lines 37, 80, 103 - suggestion: Use active voice instead of passive voice
• Line 37 - error: Don't add '(s)' to a singular noun. Use plural instead.
• Line 59 - suggestion: Spell out 'CIDR' on first use
• Lines 67, 117 - error: Use 'login' instead of 'Log in'
• Lines 67, 117 - suggestion: Use 'login' instead of 'Log in'
• Line 71 - warning: Use first person (such as 'My') sparingly.
• Line 191 - error: Use 'Controller 1' instead of 'controller a'
• Lines 198, 199 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'

content/Solutions/Integrations/OpenShift/OpenShiftOperatorUserGuide.md (18 issues)

• Lines 16, 27, 33, 58, 60, 73, 129 - suggestion: Spell out 'PVC' on first use
• Lines 16, 276 - suggestion: Spell out 'YAML' on first use
• Lines 27, 73, 103 - suggestion: Use active voice instead of passive voice
• Line 161 - error: Use 'filesystem' instead of 'file system'
• Line 203 - suggestion: Use Oxford comma before 'and' in lists
• Line 206 - suggestion: Use Title Case for headings

content/Solutions/Integrations/OpenShift/_index.md (13 issues)

• Lines 23, 30 - suggestion: Spell out 'OLM' on first use
• Line 32 - suggestion: Spell out 'CRD' on first use
• Lines 32, 52 - suggestion: Spell out 'YAML' on first use
• Lines 37, 42, 56 - suggestion: Use active voice instead of passive voice
• Line 41 - error: Don't use 'backend'. See the A-Z word list for details.
• Line 64 - suggestion: Spell out 'PVC' on first use

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

[github-actions]

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 86 issues found in changed files - 11 errors, 2 warnings, 73 suggestions

Changed files with issues:

content/Solutions/Integrations/OpenShift/OpenShiftReference.md (29 issues)

• Lines 3, 15, 19 - error: Use 'after' instead of 'once'
• Lines 3, 15, 44, 54, 138 - suggestion: Spell out 'YAML' on first use
• Line 3 - suggestion: Use Oxford comma before 'and' in lists
• Lines 21, 25, 263, 295, 299 - suggestion: Use active voice instead of passive voice
• Lines 31, 35, 44, 45, 47 - suggestion: Spell out 'PVC' on first use
• Line 107 - warning: For a general audience, use 'address' rather than 'URL'.
• Line 180 - suggestion: Use Title Case for headings
• Lines 263, 266 - error: Remove the spaces around ' — '.
• Line 351 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'

content/Solutions/Integrations/OpenShift/OpenShiftOperator.md (26 issues)

• Lines 34, 37 - suggestion: Keep sentences under 30 words
• Lines 34, 252 - suggestion: Spell out 'PVC' on first use
• Lines 34, 35, 128, 241 - suggestion: Spell out 'YAML' on first use
• Lines 37, 80, 103 - suggestion: Use active voice instead of passive voice
• Line 37 - error: Don't add '(s)' to a singular noun. Use plural instead.
• Line 59 - suggestion: Spell out 'CIDR' on first use
• Lines 67, 117 - error: Use 'login' instead of 'Log in'
• Lines 67, 117 - suggestion: Use 'login' instead of 'Log in'
• Line 71 - warning: Use first person (such as 'My') sparingly.
• Line 191 - error: Use 'Controller 1' instead of 'controller a'
• Lines 198, 199 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'

content/Solutions/Integrations/OpenShift/OpenShiftOperatorUserGuide.md (18 issues)

• Lines 16, 27, 33, 58, 60, 73, 129 - suggestion: Spell out 'PVC' on first use
• Lines 16, 276 - suggestion: Spell out 'YAML' on first use
• Lines 27, 73, 103 - suggestion: Use active voice instead of passive voice
• Line 161 - error: Use 'filesystem' instead of 'file system'
• Line 203 - suggestion: Use Oxford comma before 'and' in lists
• Line 206 - suggestion: Use Title Case for headings

content/Solutions/Integrations/OpenShift/_index.md (13 issues)

• Lines 23, 30 - suggestion: Spell out 'OLM' on first use
• Line 32 - suggestion: Spell out 'CRD' on first use
• Lines 32, 52 - suggestion: Spell out 'YAML' on first use
• Lines 37, 42, 56 - suggestion: Use active voice instead of passive voice
• Line 41 - error: Don't use 'backend'. See the A-Z word list for details.
• Line 64 - suggestion: Spell out 'PVC' on first use

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

[micjohnson777]

This appears to be ready for re-review as all comments are now resolved. Unless we need to complete the proposed ECN process for it before it is merged.

[billohanlon]

LGTM

[billohanlon]

LGTM

[github-actions]

Vale Style Guide Issues

📊 Summary: 86 issues found in changed files - 11 errors, 2 warnings, 73 suggestions

Changed files with issues:

content/Solutions/Integrations/OpenShift/OpenShiftReference.md (29 issues)

• Lines 3, 15, 19 - error: Use 'after' instead of 'once'
• Lines 3, 15, 44, 54, 138 - suggestion: Spell out 'YAML' on first use
• Line 3 - suggestion: Use Oxford comma before 'and' in lists
• Lines 21, 25, 263, 295, 299 - suggestion: Use active voice instead of passive voice
• Lines 31, 35, 44, 45, 47 - suggestion: Spell out 'PVC' on first use
• Line 107 - warning: For a general audience, use 'address' rather than 'URL'.
• Line 180 - suggestion: Use Title Case for headings
• Lines 263, 266 - error: Remove the spaces around ' — '.
• Line 351 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'

content/Solutions/Integrations/OpenShift/OpenShiftOperator.md (26 issues)

• Lines 34, 37 - suggestion: Keep sentences under 30 words
• Lines 34, 252 - suggestion: Spell out 'PVC' on first use
• Lines 34, 35, 128, 241 - suggestion: Spell out 'YAML' on first use
• Lines 37, 80, 103 - suggestion: Use active voice instead of passive voice
• Line 37 - error: Don't add '(s)' to a singular noun. Use plural instead.
• Line 59 - suggestion: Spell out 'CIDR' on first use
• Lines 67, 117 - error: Use 'login' instead of 'Log in'
• Lines 67, 117 - suggestion: Use 'login' instead of 'Log in'
• Line 71 - warning: Use first person (such as 'My') sparingly.
• Line 191 - error: Use 'Controller 1' instead of 'controller a'
• Lines 198, 199 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'

content/Solutions/Integrations/OpenShift/OpenShiftOperatorUserGuide.md (18 issues)

• Lines 16, 27, 33, 58, 60, 73, 129 - suggestion: Spell out 'PVC' on first use
• Lines 16, 276 - suggestion: Spell out 'YAML' on first use
• Lines 27, 73, 103 - suggestion: Use active voice instead of passive voice
• Line 161 - error: Use 'filesystem' instead of 'file system'
• Line 203 - suggestion: Use Oxford comma before 'and' in lists
• Line 206 - suggestion: Use Title Case for headings

content/Solutions/Integrations/OpenShift/_index.md (13 issues)

• Lines 23, 30 - suggestion: Spell out 'OLM' on first use
• Line 32 - suggestion: Spell out 'CRD' on first use
• Lines 32, 52 - suggestion: Spell out 'YAML' on first use
• Lines 37, 42, 56 - suggestion: Use active voice instead of passive voice
• Line 41 - error: Don't use 'backend'. See the A-Z word list for details.
• Line 64 - suggestion: Spell out 'PVC' on first use

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