Merge pull request #2688 from truenas/PD-1093-building-documenation-l…

…ocally-from-main-branch-fails-24.04

PD-1093-building-documenation-locally-from-main-branch-fails-24.04

content/GettingStarted/Migrate/MigratePrep.md

@@ -89,7 +89,7 @@ CORE Enterprise customers are encouraged to contact Support for assistance with
    After updating to the latest publicly-available release of CORE and making any changes to CORE user accounts or any other settings download these files and keep them in a safe place and where you can access them if you need to revert to CORE with a clean install using the CORE <file>iso</file> file.
 
 After completing the steps that apply to your CORE system listed above, download the [SCALE ISO file](https://www.truenas.com/download-tn-scale/) and save it to your computer.
-Burn the iso to a USB drive (see **Installing on Physical Hardware** in [Installing SCALE]({{< relref "InstallingSCALE.md #installing-on-physical-hardware" >}})) when upgrading a physical system.
+Burn the iso to a USB drive (see **Installing on Physical Hardware** in [Installing SCALE]({{< relref "InstallingSCALE.md#installing-on-physical-hardware" >}})) when upgrading a physical system.
 
 ## Deprecated Services in SCALE
 The built-in services listed in this section are available in CORE, but deprecated in SCALE 22.12.3 (Bluefin) and removed in later SCALE releases.

content/GettingStarted/SCALEReleaseNotes.md

@@ -63,7 +63,7 @@ This new directory is an immutable directory shared by service accounts and acco
   * SSH
   * Shell access (edited)
 
-  See [Managing Users]({{< relref "managelocalusersscale.md #configuring-a-user" >}}) for more information.
+  See [Managing Users]({{< relref "managelocalusersscale.md#configuring-a-user" >}}) for more information.
 
 * Users upgrading from TrueNAS SCALE 23.10 (Cobia) to 24.04 (Dragonfish) who import a Cobia configuration file might find that some services are not automatically enabled as expected.
 After uploading the configuration file and rebooting the system, review **System Settings > Services**.

content/SCALECLIReference/Storage/CLIScrub.md

@@ -30,7 +30,7 @@ The `create` command configures a new scheduled scrub task.
 
 `create` has one required property, `pool`, and four optional properties (see Create Properties below).
 The value for `pool` is the pool id number.
-Use [`storage pool query`]({{< relref "CLIPool.md #query-command" >}}) to find the id for the selected pool and enter this integer.
+Use [`storage pool query`]({{< relref "CLIPool.md#query-command" >}}) to find the id for the selected pool and enter this integer.
 
 Enter the full command string along with any optional properties you want to configure, or accept the default values, and then press <kbd>Enter</kbd>.
 `create` returns an empty line when successful.
@@ -40,7 +40,7 @@ Use [`query`](#query-command) to confirm the task is created correctly.
 {{< truetable >}}
 | Property | Required | Description | Syntax Example |
 |----------|----------|-------------|---------------|
-| `pool` | Yes | Enter the id number for the selected pool.<br>Use [`storage pool query`]({{< relref "CLIPool.md #query-command" >}}) to find the id numbers for all pools on the system. | <code>pool=<em>1</em></code> |
+| `pool` | Yes | Enter the id number for the selected pool.<br>Use [`storage pool query`]({{< relref "CLIPool.md#query-command" >}}) to find the id numbers for all pools on the system. | <code>pool=<em>1</em></code> |
 | `threshold` | No | Enter the number of days before a completed scrub is allowed to run again. Default value is `35`. This controls the task schedule. For example, scheduling a scrub to run daily and setting Threshold days to 7 means the scrub attempts to run daily. When the scrub succeeds, it continues to check daily but does not run again until the seven days have elapsed. Using a multiple of seven ensures the scrub always occurs on the same weekday. | <code>threshold=<em>7</em></code> |
 | `description` | No | Enter a human-readable name or description for the scrub task. | <code>description= "<em>scrub&nbsp;task&nbsp;1</em>"</code> |
 | `schedule` | No | Enter an array of properties that specify the date and time when the scrub task runs. The default setting is to run the task weekly, every Sunday at 00:00 (0 0 * * 0). Enter `{}` without property arguments to accept default values for schedule properties, or enter each property argument enclosed in square brackets with double-quoted properties and values. Separate each array property argument enclosed in square brackets `[]` with a comma and space. Properties are:<br><ul><li>`minute` specified in the format of minutes:seconds or use the default `00`<br><li>`hour` specified in the format of 00 (0-23) or use the default `*` for every hour. <br><li>`dom` specifies the day of month in the format of `jan` through `dec` or use the default `*` for every month.<br><li>`month` specifies the month in the format of `jan` or use the default `*` for any month.<br><li>`dow` specifies the day(s) of the week as `sun`, `mon`, `tue`, `wed`, `thu`, `fri`, or `sat` or use the default `*` for every day of the week.</ul> Command example shows the default values for each property in the object array. | <code>schedule={["minute"="00"], ["hour"="&ast;"], ["dom"="&ast;"], ["month"="&ast;"], ["dow"="&ast;"]}</code> |
@@ -178,15 +178,15 @@ The `run` command activates a one-time scrub task for the selected pool.
 #### Description
 
 `run` has one required property, `name`, and one optional property, `threshold`.
-To find the `name` of the pool you want to scrub, use [`storage pool query`]({{< relref "CLIPool.md #query-command" >}}) or [`storage dataset query id`]({{< relref "CLIDataset.md #query-command" >}}) to return the paths of all pools and child datasets on the system.
+To find the `name` of the pool you want to scrub, use [`storage pool query`]({{< relref "CLIPool.md#query-command" >}}) or [`storage dataset query id`]({{< relref "CLIDataset.md#query-command" >}}) to return the paths of all pools and child datasets on the system.
 
 `threshold` defaults to 35 days.
 To preserve system resources, the scrub runs only if time since the pool was last scrubbed is greater than the threshold value.
 To override the threshold and run immediately, you can use `threshold=0`.
 
 Enter the full command string and then press <kbd>Enter</kbd>.
 `run` returns an empty line.
-To check if the scrub starts successfully, you can use [`system alert list`]({{< relref "CLIAlert.md #list-command" >}}) to view system alerts.
+To check if the scrub starts successfully, you can use [`system alert list`]({{< relref "CLIAlert.md#list-command" >}}) to view system alerts.
 
 #### Usage
 
@@ -214,7 +214,7 @@ The `scrub` command allows you to start a one-time scrub task for the selected p
 #### Description
 
 `scrub` has two required properties, `name` and `action`.
-To find the `name` of the pool you want to scrub, use [`storage pool query`]({{< relref "CLIPool.md #query-command" >}}) or [`storage dataset query id`]({{< relref "CLIDataset.md #query-command" >}}) to return the paths of all pools and child datasets on the system.
+To find the `name` of the pool you want to scrub, use [`storage pool query`]({{< relref "CLIPool.md#query-command" >}}) or [`storage dataset query id`]({{< relref "CLIDataset.md#query-command" >}}) to return the paths of all pools and child datasets on the system.
 
 There are three possible values for `action`:
 

content/SCALECLIReference/System/CLIBoot.md

@@ -27,8 +27,8 @@ You can enter commands from the main CLI prompt or from the **boot** namespace p
 The `attach` command runs a job that attaches a device (disk) to the boot pool.
 
 Before running this command, use these commands:
-* [`storage disk query`]({{< relref "CLIDisk.md #query-command" >}}) to locate the names and size of disks.
-* [`storage disk get_unused`]({{< relref "CLIDisk.md #get_unused-command" >}}) to locate unused disks on the system.
+* [`storage disk query`]({{< relref "CLIDisk.md#query-command" >}}) to locate the names and size of disks.
+* [`storage disk get_unused`]({{< relref "CLIDisk.md#get_unused-command" >}}) to locate unused disks on the system.
 * [`system boot get_disks`](#get_disks-command) to get the name of the boot pool disk.
 
 {{< expand "Using the Attach Command" "v" >}}
@@ -114,7 +114,7 @@ xvda
 ### Get_Scrub_Interval Command
 Use the `get_scrub_interval` command to obtain the number of days between boot pool scrubs.
 
-The [`system advanced config`]({{< relref "CLIAdvanced.md #config-command" >}}) result also shows the `boot_scrub` interval.
+The [`system advanced config`]({{< relref "CLIAdvanced.md#config-command" >}}) result also shows the `boot_scrub` interval.
 
 {{< expand "Using the Get_Scrub_Interval Command" "v" >}}
 #### Description
@@ -182,8 +182,8 @@ system boot get_state
 Use the `replace` command to remove a device (drive) from the boot pool and replace it with a device of at least the same size. This command resilvers the boot pool and installs the boot loader on the new device.
 
 Before running this command, use these commands:
-* [`storage disk query`]({{< relref "CLIDisk.md #query-command" >}}) to locate the names and size of disks.
-* [`storage disk get_unused`]({{< relref "CLIDisk.md #get_unused-command" >}}) to locate unused disks on the system.
+* [`storage disk query`]({{< relref "CLIDisk.md#query-command" >}}) to locate the names and size of disks.
+* [`storage disk get_unused`]({{< relref "CLIDisk.md#get_unused-command" >}}) to locate unused disks on the system.
 * [`system boot get_disks`](#get_disks-command) to get the name of the boot pool disk.
 
 {{< expand "Using the Replace Command" "v" >}}
@@ -249,7 +249,7 @@ system boot scrub
 ### Set_Scrub_Interval Command
 Use the `set_scrub_interval` to set or change the interval (in days) between boot pool scrub operations.
 
-You can also use the [`system advanced update boot_scrub=`]({{< relref "CLIAdvanced.md #update-command" >}}) command to set the boot pool scrub interval.
+You can also use the [`system advanced update boot_scrub=`]({{< relref "CLIAdvanced.md#update-command" >}}) command to set the boot pool scrub interval.
 {{< expand "Using the Set_Scrub_Interval Command" "v" >}}
 #### Description
 The `set_scrub_interval` command has one required property, `interval`.

content/SCALECLIReference/System/CLIBootenv.md

@@ -33,7 +33,7 @@ Use [`query`](#query-command) to find the boot environment `id`.
 
 `activate` returns `true` when successful.
 `query` returns `active` values of `N` (now) for the current boot environment and `R` (reboot) for the pending one.
-Enter [`system reboot`]({{< relref "/scaleclireference/system/_index.md #reboot-command" >}}) to reboot the system and activate the pending boot environment.
+Enter [`system reboot`]({{< relref "/scaleclireference/system/_index.md#reboot-command" >}}) to reboot the system and activate the pending boot environment.
 
 #### Usage
 

content/SCALECLIReference/System/CLITrueCommand.md

@@ -82,7 +82,7 @@ system truecommand connected
 ### Update Command
 The `update` command allows you to update TrueCommand configuration.
 
-Use [`auth api_key create`]({{< relref "CLIApiKey.md #create-command" >}}) to obtain a new API key.
+Use [`auth api_key create`]({{< relref "CLIApiKey.md#create-command" >}}) to obtain a new API key.
 
 {{< expand "Using the Update Command" "v" >}}
 #### Description

content/SCALETutorials/Apps/CommunityApps/Immich.md

@@ -146,4 +146,4 @@ Enter a plain integer followed by the measurement suffix, for example 4G or 123M
 Systems with compatible GPU(s) display devices in **GPU Configuration**.
 Use the **GPU Resource** dropdown menu(s) to configure device allocation.
 
-See [Allocating GPU]({{< relref "/scaletutorials/apps/_index.md #allocating-gpu" >}}) for more information about allocating GPU devices in TrueNAS SCALE.
+See [Allocating GPU]({{< relref "/scaletutorials/apps/_index.md#allocating-gpu" >}}) for more information about allocating GPU devices in TrueNAS SCALE.

content/SCALETutorials/Apps/CommunityApps/InstallPiHoleApp.md

@@ -52,7 +52,7 @@ Click the arrow to the left of **<span class="material-icons">folder</span> /mnt
 Pi-hole uses volumes store your data between container upgrades.
 
 {{< hint type=warning >}}  
-You need to create these directories in a dataset on SCALE before you begin installing this container. To create a directory, open the TrueNAS SCALE CLI and enter [`storage filesystem mkdir path="/PATH/TO/DIRECTORY"`]({{< relref "CLIFilesystem-Storage.md #mkdir-command" >}}).
+You need to create these directories in a dataset on SCALE before you begin installing this container. To create a directory, open the TrueNAS SCALE CLI and enter [`storage filesystem mkdir path="/PATH/TO/DIRECTORY"`]({{< relref "CLIFilesystem-Storage.md#mkdir-command" >}}).
 {{< /hint >}}
 
 ![AppPiHoleStorageSettings](/images/SCALE/Apps/AppPiHoleStorageSettings.png "PiHole Storage Settings")

content/SCALETutorials/Apps/CommunityApps/jellyfin.md

@@ -204,4 +204,4 @@ Enter a plain integer followed by the measurement suffix, for example 4G.
 Systems with compatible GPU(s) display devices in **GPU Configuration**.
 Use the **GPU Resource** dropdown menu(s) to configure device allocation.
 
-See [Allocating GPU]({{< relref "/scaletutorials/apps/_index.md #allocating-gpu" >}}) for more information about allocating GPU devices in TrueNAS SCALE.
+See [Allocating GPU]({{< relref "/scaletutorials/apps/_index.md#allocating-gpu" >}}) for more information about allocating GPU devices in TrueNAS SCALE.

content/SCALETutorials/Apps/UsingCustomApp.md

@@ -30,7 +30,7 @@ If your application requires directory paths, specific datasets, or other storag
 
 You cannot exit the configuration wizard and save settings to create data storage or directories in the middle of the process. If you are unsure about any configuration settings, review the [Install Custom App Screen UI reference article]({{< relref "InstallCustomAppScreens.md" >}}) before creating a new container image.
 
-To create directories in a dataset on SCALE, before you begin installing the container, open the TrueNAS SCALE CLI and enter [`storage filesystem mkdir path="/PATH/TO/DIRECTORY"`]({{< relref "CLIFilesystem-Storage.md #mkdir-command" >}}).
+To create directories in a dataset on SCALE, before you begin installing the container, open the TrueNAS SCALE CLI and enter [`storage filesystem mkdir path="/PATH/TO/DIRECTORY"`]({{< relref "CLIFilesystem-Storage.md#mkdir-command" >}}).
 {{< /hint >}}
 
 When you are ready to create a container, go to **Apps**, click **Discover Apps**, then click **Custom App**.

content/SCALETutorials/ConfigReportsScale.md

@@ -48,7 +48,7 @@ To configure a reporting exporter in SCALE, you need the:
 * Port number the reporting service listens on.
   If using another TrueNAS system with a reporting application, this is the port number the TrueNAS system listens on (port:80)
 
-For more information on reporting exporter settings, see [Add Reporting Exporter]({{< relref "ReportingScreensSCALE.md #add-reporting-exporter" >}}).
+For more information on reporting exporter settings, see [Add Reporting Exporter]({{< relref "ReportingScreensSCALE.md#add-reporting-exporter" >}}).
 
 Go to **Reporting** and click on **Exporters** to open the **Reporting Exporters** screen.
 Any reporting exporters configured on the system display on the **Reporting Exporters** screen.

content/SCALETutorials/Shares/MixedModeShares.md

@@ -107,7 +107,7 @@ Select **Multiprotocol** from the **Dataset Preset** dropdown. The share configu
 {{< trueimage src="/images/SCALE/Datasets/AddMultimodeDataset.png" alt="Adding a Multimode Dataset and Share" id="Adding a Multimode Dataset and Share" >}}
 
 (Optional) Click **Advanced Options** to customize other dataset settings such as quotas, compression level, encryption, and case sensitivity.
-See [Creating Datasets]({{< relref "DatasetsSCALE.md #creating-a-dataset" >}}) for more information on adding and customizing datasets.
+See [Creating Datasets]({{< relref "DatasetsSCALE.md#creating-a-dataset" >}}) for more information on adding and customizing datasets.
 
 Click **Save**. TrueNAS creates the dataset and the SMB and NFS shares. Next edit both shares.
 After editing the shares, edit the dataset ACL.
@@ -178,4 +178,4 @@ After setting the dataset permission, connect to the share.
 ### Connecting to a Multiprotocol Share
 After creating and configuring the shares, connect to the mulit-protocol share using either SMB or NFS protocols from a variety of client operating systems including Windows, Apple, FreeBSD, and Linux/Unix systems.
 
-For more information on accessing shares, see [Mounting the SMB Share]({{< relref "/SCALETutorials/Shares/_index.md #mounting-the-smb-share" >}}) and [Connecting to the NFS Share]({{< relref "AddingNFSShares.md #connecting-to-the-nfs-share" >}}).
+For more information on accessing shares, see [Mounting the SMB Share]({{< relref "/SCALETutorials/Shares/SMB/_index.md#mounting-the-smb-share" >}}) and [Connecting to the NFS Share]({{< relref "AddingNFSShares.md#connecting-to-the-nfs-share" >}}).

content/SCALETutorials/Storage/Disks/SLOGOverprovisionSCALE.md

@@ -40,7 +40,7 @@ ZFS permits removing and re-adding SLOG disks to an active pool at any time.
 
 ## Resizing a Disk to Over-Provision
 
-SCALE uses the [`storage disk resize`]({{< relref "CLIDisk.md #resize-command" >}}) command to change the size of a device. The SCALE UI does not have a UI function for this command yet.
+SCALE uses the [`storage disk resize`]({{< relref "CLIDisk.md#resize-command" >}}) command to change the size of a device. The SCALE UI does not have a UI function for this command yet.
 The `storage disk resize` command supports SAS, SATA, SAT (interposer) and NVMe drives. Power cycle SATA drives before a second resize.
 
 1. Open a shell session using an SSH connection or from the local console.

content/SCALETutorials/SystemSettings/Advanced/ManageGPUSCALE.md

@@ -10,7 +10,7 @@ tags:
 ---
 
 Systems with more than one graphics processing unit (GPU) installed can isolate additional GPU device(s) from the host operating system (OS) and allocate them for use by a virtual machine (VM).
-Isolated GPU devices are unavailable to the OS and for [allocation to applications]({{< relref "/scaletutorials/apps/_index.md #allocating-gpu" >}}).
+Isolated GPU devices are unavailable to the OS and for [allocation to applications]({{< relref "/scaletutorials/apps/_index.md#allocating-gpu" >}}).
 
 {{< include file="/static/includes/AdvancedSettingsWarningSCALE.md" >}}
 

content/SCALEUIReference/Apps/InstallCustomAppScreens.md

@@ -255,7 +255,7 @@ For fewer issues, select **Kill existing pods before creating new ones**.
 Settings only display if the system detects available GPU device(s).
 
 Select the number of devices to allocate from the **Select GPU** dropdown list of devices.
-See [Allocating GPU]({{< relref "/scaletutorials/apps/_index.md #allocating-gpu" >}}) for more information.
+See [Allocating GPU]({{< relref "/scaletutorials/apps/_index.md#allocating-gpu" >}}) for more information.
 
 ### Resource Limits Settings
 

content/SCALEUIReference/ReportingScreensSCALE.md

@@ -150,4 +150,4 @@ Additional settings populate based on the selected **Type** option.
 {{< /truetable >}}
 {{< /expand >}}
 
-See [Adding a Reporting Exporter]({{< relref "ConfigReportsScale.md #adding-a-reporting-exporter" >}}) for guidance with configuring a Graphite exporter on TrueNAS.
+See [Adding a Reporting Exporter]({{< relref "ConfigReportsScale.md#adding-a-reporting-exporter" >}}) for guidance with configuring a Graphite exporter on TrueNAS.

static/includes/BrowsingSnapshotCollections1.md

@@ -23,7 +23,7 @@ To access snapshots:
     From to the dataset root folder, open the <file>.zfs</file> directory and navigate to the snapshot.
 
 * Using the TrueNAS SCALE CLI, enter <code>storage filesystem listdir path="/<em>PATH</em>/<em>TO</em>/<em>DATASET</em>/.zfs/<em>PATH</em>/<em>TO</em>/<em>SNAPSHOT</em>"</code> to view snapshot contents.
-    See also [`storage filesystem`]({{< relref "clifilesystem-storage.md #listdir-command" >}}).
+    See also [`storage filesystem`]({{< relref "clifilesystem-storage.md#listdir-command" >}}).
 
     {{< expand "Command Example" "v" >}}
 ```

static/includes/MinIODatasetRequirements.md

@@ -8,7 +8,7 @@ You can use either an existing pool or [create a new one]({{< relref "CreatePool
 After creating the dataset, create the directory where MinIO stores information the application uses.
 There are two ways to do this:
 
-* In the TrueNAS SCALE CLI, use [`storage filesystem mkdir path="/PATH/TO/minio/data"`]({{< relref "CLIFilesystem-Storage.md #mkdir-command" >}}) to create the **/data** directory in the MinIO dataset.
+* In the TrueNAS SCALE CLI, use [`storage filesystem mkdir path="/PATH/TO/minio/data"`]({{< relref "CLIFilesystem-Storage.md#mkdir-command" >}}) to create the **/data** directory in the MinIO dataset.
 
     {{< expand "Command Example" "v" >}}
 ```