PD-379: Docs Hub section pages (home, indexes) review #1916
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Fix descriptions that weren't properly displaying. - Pare down some section content lists when there are to0 many child articles. - Remove off-brand images in section index files (to be replaced with TrueNAS-branding related imagery) - remove additional navigation instructions as too many pointers were becoming confusing. - Clean up some directories that had a single file (with aliases added for removed URLs).
- Add missing description front matter - Fix up some directories with a single file. - Replace Article Summaries with Contents - generally standardize how _index files present information and child articles.
- Add missing descriptions - Remove single file directories (and alias the content file) - Standardize the Contents sections and children article display.
…as/documentation into PD-293_sectionpagesrefresh
Changes hint to enterprise shortcode
…as/documentation into PD-293_sectionpagesrefresh
…om/truenas/documentation into PD-293_sectionpagesrefresh" This reverts commit 38a9678, reversing changes made to 9c61b38.
…as/documentation into PD-293_sectionpagesrefresh
…as/documentation into PD-293_sectionpagesrefresh
micjohnson777
approved these changes
May 24, 2023
micjohnson777
added
the
Technical Writer Review (MJ)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a large PR that reviews all the index files contained in the Docs Hub file structure and makes these general updates:
A large number of files are being changed, although the specific changes to each file are minimal. My recommendation for review is to pull this branch and locally build test.
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.