Skip to content

DOCS-2610 / 27 / Docs 2610 apps UI ref content updates (by micjohnson777) - #4866

Merged
tonyriv3 merged 3 commits into
27from
DOCS-2610-27
Oct 12, 2026
Merged

tonyriv3 merged 3 commits into
27from
DOCS-2610-27

Conversation

@bugclerk

@bugclerk bugclerk commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

This PR updates the AppsScreens.md and InstallCustomappScreens.md articles with new screenshots and setting content descriptions. It also adds content missing in the current documentation. Tutorial content remains in the apps-web repo and website, but the UI ref content in the Docs Hub needs to be as complete as possible. Not all possible apps Install wizard settings are included in the AppsScreens.md article as there are too many and they vary by application. Only the most common settings are included.

Backports to 27.

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: #4862
Jira URL: https://ixsystemsinc.atlassian.net/browse/DOCS-2610

this is the first commit of changes to the AppsScreens.md file.

(cherry picked from commit 1acd4ac)
This PR update the AppsScreens.md and InstallCuystomAppScreens.md articles with missing settings content and new screenshots. This content should be included in the Docs Hub as it is where users encounter these settings. Tutorials remain in the apps-web repo and website.

(cherry picked from commit af50fb4)
(cherry picked from commit a378144)
@bugclerk
bugclerk requested a review from a team as a code owner October 9, 2026 16:42
@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown

Vale Style Guide Issues

📊 Summary: 164 issues found in changed files - 14 errors, 7 warnings, 143 suggestions

Changed files with issues:

content/Apps/AppsScreens.md (118 issues)

  • Lines 19, 93, 167, 391, 472, 497, 645 - suggestion: Keep sentences under 30 words
  • Lines 136, 138, 143, 158, 159, 160, 167, 183, 197, 236, 255, 274, 281, 299, 319, 337, 460, 515, 518, 523, 524, 525, 563, 594, 657, 672 - suggestion: Use active voice instead of passive voice
  • Lines 151, 591 - suggestion: Use Oxford comma before 'and' in lists
  • Line 151 - suggestion: Spell out 'URI' on first use
  • Lines 158, 589 - suggestion: Use single space after periods and single empty lines between paragraphs
  • Lines 161, 162 - suggestion: Use 'signin' instead of 'sign in'
  • Lines 183, 199 - suggestion: Consider 'TrueNAS' instead of 'Docker'
  • Lines 191, 193, 237, 320 - warning: For a general audience, use 'address' rather than 'URL'.
  • Lines 197, 225 - suggestion: Don't use language (such as 'Disabled') that defines people by their disability.
  • Lines 197, 274, 526 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Line 197 - error: Remove the spaces around ' — '.
  • Lines 248, 565, 573, 672 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Lines 255, 287, 289, 308 - suggestion: Use 'rollback' instead of 'Roll Back'
  • Line 255 - error: 'to' is repeated!
  • Lines 265, 330, 331, 411, 431 - suggestion: Spell out 'YAML' on first use
  • Line 293 - suggestion: Use 'rollback' instead of 'roll back'
  • Lines 298, 302 - suggestion: Use 'rollback' instead of 'Roll back'
  • Line 497 - suggestion: Spell out 'UID' on first use
  • Line 526 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 589 - error: 'd. A' should have one space.
  • Line 670 - suggestion: Use 'MB' instead of 'megabytes'

content/Apps/InstallCustomAppScreens.md (46 issues)

  • Lines 13, 371, 372 - suggestion: Spell out 'YAML' on first use
  • Lines 28, 77, 84, 85, 139, 150, 154, 208, 213, 224, 232, 254, 267, 364, 382 - suggestion: Use active voice instead of passive voice
  • Line 79 - error: Punctuation should be inside the quotes.
  • Line 83 - error: Form a negative number with an en dash, not a hyphen.
  • Line 139 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 208, 262 - suggestion: Use single space after periods and single empty lines between paragraphs
  • Line 262 - error: 'd. A' should have one space.
  • Line 264 - suggestion: Use Oxford comma before 'and' in lists
  • Line 336 - suggestion: Keep sentences under 30 words
  • Lines 351, 364 - error: Don't add '(s)' to a singular noun. Use plural instead.
  • Line 362 - suggestion: Use 'MB' instead of 'megabytes'
  • Line 382 - warning: Prefer 'alphabetical' over 'alphabetic'.

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

@tonyriv3
tonyriv3 merged commit a7480c5 into 27 Oct 12, 2026
2 checks passed
@tonyriv3
tonyriv3 deleted the DOCS-2610-27 branch October 12, 2026 13:18
@bugclerk

Copy link
Copy Markdown
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 12, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants