Skip to content

Commit

Permalink
24.04 top-level Parallelism review - SCALE Tutorials
Browse files Browse the repository at this point in the history
Review the sections inside the SCALE tutorials book and update according to the latest 24.04 nightly build's UI layout.
Reweight all primary sections to correct the order against the UI left side menu.
Elevate the Datasets subsection to the top level to match the UI left side menu.
Move the Disk management content into the Disks subsection landing page and delete the now redundant .md file.
Move a few articles related to storage disks to that related subsection.
Add aliases for all URLs impacted by these changes.
Local build testing and fix some cross-references that errored on build.
  • Loading branch information
Mrt134 committed Dec 5, 2023
1 parent 46a42cc commit 9cd375a
Show file tree
Hide file tree
Showing 34 changed files with 78 additions and 69 deletions.
Expand Up @@ -139,7 +139,7 @@ If your installation includes a UPS, configure and enable the UPS service as wel
All systems can take advantage of the SMART service and testing if your disks support this service.
Disks that do not support SMART testing do not display the option to set up testing.

See [Managing SMART Tests]({{< relref "SmartTestsScale.md" >}}) for information on running or managing scheduled SMART tests or [Managing Disks]({{< relref "ManagingDisks.md" >}}) for more information on running a manual test from a selected disk.
See [Managing SMART Tests]({{< relref "SmartTestsScale.md" >}}) for information on running or managing scheduled SMART tests or [Managing Disks]({{< relref "/SCALE/SCALETutorials/Storage/Disks/_index.md" >}}) for more information on running a manual test from a selected disk.

## Setting Up Backup Solutions

Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/SCALETutorials/Apps/_index.md
Expand Up @@ -2,7 +2,7 @@
title: "Apps"
description: "Expanding TrueNAS SCALE functionality with additional applications."
geekdocCollapseSection: true
weight: 100
weight: 12
aliases:
- /scale/scaletutorials/apps/usingapps/
- /scale/scaleuireference/apps/usingapps/
Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/SCALETutorials/ConfigReportsScale.md
@@ -1,7 +1,7 @@
---
title: "Reporting"
description: "Provides information on changing settings that control how TrueNAS displays report graphs, interacting with graphs, and the TrueCommand Enhancement option."
weight: 110
weight: 13
alias:
- /scale/scaletutorials/reporting/configreportsscale/
- /scale/scaletutorials/reporting/
Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/SCALETutorials/Credentials/_index.md
Expand Up @@ -2,7 +2,7 @@
title: "Credentials"
description: "Tutorials for configuring the different credentials needed for TrueNAS SCALE features."
geekdocCollapseSection: true
weight: 70
weight: 10
related: false
---

Expand Down
8 changes: 6 additions & 2 deletions content/SCALE/SCALETutorials/Dashboard/_index.md
@@ -1,11 +1,15 @@
---
title: Main Dashboard
title: Dashboard
description: "Tutorials related to using the TrueNAS SCALE Dashboard."
geekdocCollapseSection: true
weight: 3
weight: 4
tags:
- dashboard
related: false
---

This section contains tutorials involving the [SCALE Dashboard]({{< relref "SCALEDashboard.md" >}}).

## Contents

{{< children sort="name" depth="2" description="true" >}}
Expand Up @@ -20,7 +20,7 @@ iXsystems is not responsible for any charges incurred from using third-party ven

## Cloud Sync Task Requirements

* You must have all system [storage]({{< relref "/SCALE/SCALETutorials/Storage/Pools/_index.md" >}}) configured and ready to receive or send data.
* You must have all system [storage]({{< relref "/SCALE/SCALETutorials/Storage/_index.md" >}}) configured and ready to receive or send data.
* You must have a cloud storage provider account and location (like an Amazon S3 bucket).

You can create the cloud storage account credentials using **Credentials > Backup Credentials > Cloud Credentials** before creating the sync task or add it at the time you create the cloud sync task on **Data Protection > Cloud Sync Task > Add Cloud Sync Task**. See the [Cloud Credentials]({{< relref "/SCALE/SCALETutorials/Credentials/BackupCredentials/AddCloudCredentials.md" >}}) article for instructions on adding a backup credential using cloud credentials.
Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/SCALETutorials/DataProtection/_index.md
Expand Up @@ -2,7 +2,7 @@
title: "Data Protection"
description: "Tutorials related to configuring data backup features in TrueNAS SCALE."
geekdocCollapseSection: true
weight: 50
weight: 8
related: false
---

Expand Down
Expand Up @@ -2,7 +2,9 @@
title: "Adding and Managing Zvols"
description: "Provides instructions on creating, editing and managing zvols."
weight: 20
aliases: /scale/scaleuireference/storage/pools/zvolsscale/
aliases:
- /scale/scaleuireference/storage/pools/zvolsscale/
- /scale/scaletutorials/storage/datasets/addmanagezvols/
tags:
- zvol
- storage
Expand Down
Expand Up @@ -5,6 +5,7 @@ weight: 40
aliases:
- /scale/scaleuireference/storage/snapshotsscale/
- /scale/scaletutorials/storage/snapshotsscale/
- /scale/scaletutorials/storage/datasets/creatingsnapshots/
tags:
- snapshots
- backup
Expand Down
Expand Up @@ -5,6 +5,7 @@ weight: 10
aliases:
- /scale/scaleuireference/storage/pools/datasetsscale/
- /scale/scaletutorials/storage/pools/datasetsscale/
- /scale/scaletutorials/storage/datasets/datasetsscale/
tags:
- datasets
- storage
Expand Down
Expand Up @@ -2,7 +2,9 @@
title: "Storage Encryption"
description: "Provides information on SCALE storage encryption for pools, root datasets, datasets, and Zvols."
weight: 50
aliases: /scale/storage/encryptionscale/
aliases:
- /scale/storage/encryptionscale/
- /scale/scaletutorials/storage/datasets/encryptionscale/
tags:
- encryption
- datasets
Expand Down
Expand Up @@ -2,6 +2,8 @@
title: "Managing User or Group Quotas"
description: "Provides information on managing user and group quotas."
weight: 35
aliases:
- /scale/scaletutorials/storage/datasets/managequotas/
tags:
- quotas
- datasets
Expand Down
Expand Up @@ -5,6 +5,7 @@ weight: 45
aliases:
- /scale/scaleuireference/storage/snapshotsscale/
- /scale/scaletutorials/storage/snapshotsscale/
- /scale/scaletutorials/storage/datasets/managesnapshotsscale/
tags:
- snapshots
- backup
Expand Down
Expand Up @@ -5,6 +5,7 @@ weight: 55
aliases:
- /scale/scaleuireference/storage/pools/permissionsscale
- /scale/scaletutorials/storage/pools/permissionsscale
- /scale/scaletutorials/storage/datasets/permissionsscale/
tags:
- acl
- datasets
Expand Down
Expand Up @@ -2,9 +2,11 @@
title: "Datasets"
description: "Tutorials for creating and managing datasets in TrueNAS SCALE."
geekdocCollapseSection: true
weight: 20
weight: 6
aliases:
- /scale/scaletutorials/storage/datasets/
- /scale/scaletutorials/storage/datasets/importingdata/
- /scale/scaletutorials/storage/datasets/datasetsscale/
related: false
---

Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/SCALETutorials/Network/_index.md
Expand Up @@ -2,7 +2,7 @@
title: "Network"
description: "Tutorials for configuring network interfaces and connections in TrueNAS SCALE."
geekdocCollapseSection: true
weight: 10
weight: 9
aliases:
- /scale/network/
related: false
Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/SCALETutorials/Shares/_index.md
Expand Up @@ -3,7 +3,7 @@ title: "Shares"
description: "Tutorials for configuring the various data sharing features in TrueNAS SCALE."
geekdocCollapseSection: true
aliases: /scale/scaletutorials/shares/
weight: 110
weight: 7
tags:
- shares
related: false
Expand Down
Expand Up @@ -8,7 +8,7 @@ tags:
- iscsi
---

To get started with iSCSI shares, make sure you have already created a [zvol]({{< relref "/SCALE/SCALETutorials/Storage/Datasets/AddManageZvols.md" >}}) or a [dataset]({{< relref "DatasetsSCALE.md" >}}) with at least one file to share.
To get started with iSCSI shares, make sure you have already created a [zvol]({{< relref "AddManageZvols.md" >}}) or a [dataset]({{< relref "DatasetsSCALE.md" >}}) with at least one file to share.

Go to **Shares** and click **Configure** in the **Block (iSCSI) Shares Targets** window. You can either use the creation wizard or set one up manually.

Expand Down
@@ -1,9 +1,10 @@
---
title: "Pool Creation Wizard"
title: "Create Pool"
description: "Background considerations and a simple tutorial on creating storage pools in TrueNAS SCALE."
weight: 05
weight: 30
aliases:
- /scale/scaletutorials/storage/pools/createpoolscale/
- /scale/scaletutorials/storage/pools/createpoolwizard/
tags:
- storage
- pools
Expand Down
@@ -1,9 +1,9 @@
---
title: "Replacing Disks"
description: "Provides disk replacement instructions that includes taking a failed disk offline and replacing a disk in an existing VDEV. It automatically triggers a pool resilver during the replacement process."
weight: 20
weight: 10
aliases:
- /scale/scaletutorials/storage/disks/replacingdisks/
- /scale/scaletutorials/storage/pools/disks/replacingdisks/
tags:
- disks
---
Expand Down
@@ -1,7 +1,9 @@
---
title: "Installing and Managing Self-Encrypting Drives"
title: "Managing Self-Encrypting Drives (SED)"
description: "Covers self-encrypting drives including supported specifications, implementing and managing SEDs in TrueNAS, and managing SED passwords and data."
weight: 55
weight: 40
aliases:
- /scale/scaletutorials/storage/sedscale/
tags:
- sed
- disks
Expand Down
@@ -1,8 +1,9 @@
---
title: "SLOG Over-Provisioning"
title: "SLOG Over-Provision"
description: "Provides information on the disk_resize command in TrueNAS SCALE."
weight: 40
aliases:
weight: 30
aliases:
- /scale/scaletutorials/storage/pools/slogoverprovisionscale/
tags:
- disks
- pools
Expand Down
@@ -1,7 +1,9 @@
---
title: "Wiping a Disk"
description: "Provides instructions for wiping a disk."
weight: 25
weight: 20
aliases:
- /scale/scaletutorials/storage/pools/disks/wipingdisks/
tags:
- disks
---
Expand Down
@@ -1,10 +1,14 @@
---
title: "Managing Disks"
description: "Provides information on managing disks, performing manual S.M.A.R.T. testing and viewing S.M.A.R.T. test results."
weight: 10
title: "Disks"
description: "Articles with instructions for managing, replacing, and wiping disks."
geekdocCollapseSection: true
weight: 20
aliases:
- /scale/scaletutorials/storage/pools/disks/
- /scale/scaletutorials/storage/disks/managingdisks/
tags:
- disks
- smart
- disks
- smart
---

To manage disks, go to **Storage** and click **Disks** on the top right of the screen to display the **Storage Disks** screen.
Expand Down Expand Up @@ -36,3 +40,7 @@ For information on automated S.M.A.R.T. testing, see the [S.M.A.R.T. tests]({{<
To review test results, expand the disk and click **S.M.A.R.T. Test Results**.

{{< trueimage src="/images/SCALE/DataProtection/SMARTTestResultsofDiskExpanded.png" alt="S.M.A.R.T. Test Results Screen" id="S.M.A.R.T. Test Results Screen" >}}

## Contents

{{< children depth="2" description="true" >}}
@@ -1,8 +1,10 @@
---
title: "Fusion Pools"
description: "Provides information on setting up and using fusion pools."
weight: 30
alias: /scale/scaleuireference/storage/pools/fusionpoolsscale/
weight: 35
aliases:
- /scale/scaleuireference/storage/pools/fusionpoolsscale/
- /scale/scaletutorials/storage/pools/fusionpoolsscale/
tags:
- pools
- storage
Expand Down
@@ -1,11 +1,12 @@
---
title: "Importing a Pool"
title: "Import Pool"
description: "Provides information on ZFS importing for storage pools in TrueNAS SCALE. It also addresses GELI-encrypted pools."
weight: 25
weight: 10
aliases:
- /scale/scaletutorials/storage/datasets/importpoolscale/
- /scale/scaletutorials/storage/datasets/importingdata/
- /scale/scaleuireference/storage/datasets/importdatascreenscale/
- /scale/scaletutorials/storage/pools/importpoolscale/
tags:
- install
- disks
Expand Down
@@ -1,8 +1,9 @@
---
title: "Managing Pools"
description: "Provides instructions on managing storage pools, VDEVS and disks in TrueNAS SCALE."
weight: 20
aliases:
weight: 40
aliases:
- /scale/scaletutorials/storage/pools/managepoolsscale/
tags:
- pools
- storage
Expand Down Expand Up @@ -137,7 +138,7 @@ To manage disks in a pool, click on the VDEV to expand it and show the disks in
Click on a disk to see the devices widgets for that disk.
You can take a disk offline, detach it, replace it, manage the SED encryption password, and perform other disk management tasks from this screen.

See [Replacing Disks]({{< relref "/SCALE/SCALETutorials/Storage/Pools/Disks/ReplacingDisks.md" >}}) for more information on the **Offline**, **Replace** and **Online** options.
See [Replacing Disks]({{< relref "ReplacingDisks.md" >}}) for more information on the **Offline**, **Replace** and **Online** options.

## Expanding a Pool

Expand Down
12 changes: 0 additions & 12 deletions content/SCALE/SCALETutorials/Storage/Pools/Disks/_index.md

This file was deleted.

15 changes: 0 additions & 15 deletions content/SCALE/SCALETutorials/Storage/Pools/_index.md

This file was deleted.

4 changes: 3 additions & 1 deletion content/SCALE/SCALETutorials/Storage/_index.md
Expand Up @@ -2,7 +2,9 @@
title: "Storage"
description: "Tutorials for configuring the various features contained within the Storage area of the TrueNAS SCALE web interface."
geekdocCollapseSection: true
weight: 30
weight: 5
aliases:
- /scale/scaletutorials/storage/pools/
related: false
---

Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/SCALETutorials/SystemSettings/_index.md
Expand Up @@ -2,7 +2,7 @@
title: "System Settings"
description: "Tutorials for configuring the system management options in the System Settings area of the TrueNAS SCALE web interface."
geekdocCollapseSection: true
weight: 120
weight: 14
related: false
---

Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/SCALETutorials/TopToolbar/_index.md
Expand Up @@ -2,7 +2,7 @@
title: Top Toolbar
description: "Tutorials about options available from the TrueNAS SCALE top toolbar."
geekdocCollapseSection: true
weight: 4
weight: 3
tags:
- tasks
related: false
Expand Down
4 changes: 2 additions & 2 deletions content/SCALE/SCALETutorials/Virtualization/_index.md
@@ -1,8 +1,8 @@
---
title: "Virtualization Tutorials"
title: "Virtualization"
description: "Tutorials for configuring TrueNAS SCALE virtualization features."
geekdocCollapseSection: true
weight: 80
weight: 11
related: false
---

Expand Down
Expand Up @@ -127,7 +127,7 @@ The **Wipe Disk *diskname*** opens after clicking **Wipe** on the expanded view
![WipeDiskDialog](/images/SCALE/Storage/WipeDiskDialog.png "Wipe Disk Dialog")

**Method** provides options for how you want the system to wipe the disk. Options are **Quick**, **Full with zeros**, or **Full with random data**.
See [Wiping Disks]({{< relref "/SCALE/SCALETutorials/Storage/Pools/Disks/WipingDisks.md" >}}) for more information.
See [Wiping Disks]({{< relref "WipingDisks.md" >}}) for more information.

**Wipe** opens the wipe disk confirmation dialog.

Expand Down

0 comments on commit 9cd375a

Please sign in to comment.