DOCS-2683 / 27 / DOCS-2683 Update Datasets and Zvols UI REef Content - #4819
Conversation
This commit updates the setting descriptions in the DatasetsScreens.md and ZvolScreens.md articles, converting descriptions from how to to what descriptions, and syncs the descriptions common to both to use one description text. It also updates the snippet files with common settings.
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 149 issues found in changed files - 7 errors, 0 warnings, 142 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (82 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (45 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
|
Converting to draft to make the Add Zvol settings a snippet to use in the NVMe-oF content. |
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 149 issues found in changed files - 7 errors, 0 warnings, 142 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (82 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (45 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
This commit moves the Add Zvol screen settings to a snippet so it can be used in the NVMe-oF articles, or any other where the Add Zvol screen is opened. It adds screenshots of the zvol encryption setting otpions, and updates the EncryptionSettings.md snippet.
…github.com/truenas/documentation into DOCS-2683-Update-Datasets-and-Zvol-Content
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 150 issues found in changed files - 7 errors, 0 warnings, 143 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (82 issues)
static/includes/AddZvolSettings.md (27 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (19 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
DjP-iX
left a comment
There was a problem hiding this comment.
Mostly minor tweaks.
One thing to watch for: I found recently that using proper tags instead of <br> between list items renders better on the site. So the pattern is <ul><li>Item one</li><li>Item two</li></ul> rather than <br><li>Item one<br><li>Item two.
Co-authored-by: Dan Pizappi <133042991+DjP-iX@users.noreply.github.com>
Co-authored-by: Dan Pizappi <133042991+DjP-iX@users.noreply.github.com>
Co-authored-by: Dan Pizappi <133042991+DjP-iX@users.noreply.github.com>
Co-authored-by: Dan Pizappi <133042991+DjP-iX@users.noreply.github.com>
Co-authored-by: Dan Pizappi <133042991+DjP-iX@users.noreply.github.com>
Co-authored-by: Dan Pizappi <133042991+DjP-iX@users.noreply.github.com>
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 150 issues found in changed files - 7 errors, 0 warnings, 143 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (82 issues)
static/includes/AddZvolSettings.md (27 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (19 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
Co-authored-by: Dan Pizappi <133042991+DjP-iX@users.noreply.github.com>
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 150 issues found in changed files - 7 errors, 0 warnings, 143 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (82 issues)
static/includes/AddZvolSettings.md (27 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (19 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 152 issues found in changed files - 7 errors, 0 warnings, 145 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (84 issues)
static/includes/AddZvolSettings.md (27 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (19 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
Co-authored-by: Dan Pizappi <133042991+DjP-iX@users.noreply.github.com>
Co-authored-by: Dan Pizappi <133042991+DjP-iX@users.noreply.github.com>
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 150 issues found in changed files - 7 errors, 0 warnings, 143 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (82 issues)
static/includes/AddZvolSettings.md (27 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (19 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
Co-authored-by: Dan Pizappi <133042991+DjP-iX@users.noreply.github.com>
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 152 issues found in changed files - 7 errors, 0 warnings, 145 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (84 issues)
static/includes/AddZvolSettings.md (27 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (19 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
Co-authored-by: Dan Pizappi <133042991+DjP-iX@users.noreply.github.com>
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 152 issues found in changed files - 7 errors, 0 warnings, 145 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (84 issues)
static/includes/AddZvolSettings.md (27 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (19 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
1 similar comment
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 152 issues found in changed files - 7 errors, 0 warnings, 145 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (84 issues)
static/includes/AddZvolSettings.md (27 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (19 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
Co-authored-by: Dan Pizappi <133042991+DjP-iX@users.noreply.github.com>
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 152 issues found in changed files - 7 errors, 0 warnings, 145 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (84 issues)
static/includes/AddZvolSettings.md (27 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (19 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
Co-authored-by: Dan Pizappi <133042991+DjP-iX@users.noreply.github.com>
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 152 issues found in changed files - 7 errors, 0 warnings, 145 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (84 issues)
static/includes/AddZvolSettings.md (27 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (19 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
3 similar comments
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 152 issues found in changed files - 7 errors, 0 warnings, 145 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (84 issues)
static/includes/AddZvolSettings.md (27 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (19 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 152 issues found in changed files - 7 errors, 0 warnings, 145 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (84 issues)
static/includes/AddZvolSettings.md (27 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (19 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 152 issues found in changed files - 7 errors, 0 warnings, 145 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (84 issues)
static/includes/AddZvolSettings.md (27 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (19 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
Co-authored-by: Dan Pizappi <133042991+DjP-iX@users.noreply.github.com>
Vale Style Guide Issues (Previous - Click to expand)Vale Style Guide Issues📊 Summary: 152 issues found in changed files - 7 errors, 0 warnings, 145 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (84 issues)
static/includes/AddZvolSettings.md (27 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (19 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
Vale Style Guide Issues📊 Summary: 152 issues found in changed files - 7 errors, 0 warnings, 145 suggestions Changed files with issues: content/SCALE/Datasets/DatasetsScreens.md (84 issues)
static/includes/AddZvolSettings.md (27 issues)
content/SCALE/Datasets/Zvols/ZvolsScreens.md (19 issues)
content/SCALE/Datasets/ManagingDatasets.md (14 issues)
static/includes/DatasetQuotaSettings.md (4 issues)
static/includes/EncryptionSettings.md (4 issues)
🔧 To fix: Review the issues above and update your documentation accordingly. |
|
This PR has been merged and conversations have been locked. |
This commit updates the setting descriptions in the DatasetsScreens.md and ZvolScreens.md articles, converting descriptions from how to to what descriptions, and syncs the descriptions common to both to use one description text. It also updates the snippet files with common settings.
backport to 26
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.