Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pd 1093 building documenation locally from main branch fails #2686

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/SCALE/GettingStarted/Migrate/MigratePrep.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,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.
Expand Down
10 changes: 5 additions & 5 deletions content/SCALE/SCALECLIReference/Storage/CLIScrub.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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> |
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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`:

Expand Down
12 changes: 6 additions & 6 deletions content/SCALE/SCALECLIReference/System/CLIBoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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" >}}
Expand Down Expand Up @@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/SCALECLIReference/System/CLIBootenv.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 "/scale/scaleclireference/system/_index.md #reboot-command" >}}) to reboot the system and activate the pending boot environment.
Enter [`system reboot`]({{< relref "/scale/scaleclireference/system/_index.md#reboot-command" >}}) to reboot the system and activate the pending boot environment.

#### Usage

Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/SCALECLIReference/System/CLITrueCommand.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ 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 "/scale/scaletutorials/apps/_index.md #allocating-gpu" >}}) for more information about allocating GPU devices in TrueNAS SCALE.
See [Allocating GPU]({{< relref "/scale/scaletutorials/apps/_index.md#allocating-gpu" >}}) for more information about allocating GPU devices in TrueNAS SCALE.

## Immich Database Backup and Restore

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,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")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 "/scale/scaletutorials/apps/_index.md #allocating-gpu" >}}) for more information about allocating GPU devices in TrueNAS SCALE.
See [Allocating GPU]({{< relref "/scale/scaletutorials/apps/_index.md#allocating-gpu" >}}) for more information about allocating GPU devices in TrueNAS SCALE.
2 changes: 1 addition & 1 deletion content/SCALE/SCALETutorials/Apps/UsingCustomApp.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,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**.
Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/SCALETutorials/ConfigReportsScale.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,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.
Expand Down
4 changes: 2 additions & 2 deletions content/SCALE/SCALETutorials/Shares/MixedModeShares.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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 "/SCALE/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 "/SCALE/SCALETutorials/Shares/_index.md#mounting-the-smb-share" >}}) and [Connecting to the NFS Share]({{< relref "AddingNFSShares.md#connecting-to-the-nfs-share" >}}).
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,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.
Expand Down Expand Up @@ -145,6 +145,6 @@ The `storage disk resize` command supports SAS, SATA, SAT (interposer) and NVMe

f. Go to **Review** and click **Update Pool**

See [Managing Pools]({{< relref "/SCALE/scaletutorials/storage/managepoolsscale.md #adding-a-vdev-using-pool-manager" >}}) for more information on using **Add Vdevs to Pool**.
See [Managing Pools]({{< relref "/SCALE/scaletutorials/storage/managepoolsscale.md#adding-a-vdev-using-pool-manager" >}}) for more information on using **Add Vdevs to Pool**.

{{< /expand >}}
Original file line number Diff line number Diff line change
Expand Up @@ -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 "/scale/scaletutorials/apps/_index.md #allocating-gpu" >}}).
Isolated GPU devices are unavailable to the OS and for [allocation to applications]({{< relref "/scale/scaletutorials/apps/_index.md#allocating-gpu" >}}).

{{< include file="/static/includes/AdvancedSettingsWarningSCALE.md" >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,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 "/scale/scaletutorials/apps/_index.md #allocating-gpu" >}}) for more information.
See [Allocating GPU]({{< relref "/scale/scaletutorials/apps/_index.md#allocating-gpu" >}}) for more information.

### Resource Limits Settings

Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/SCALEUIReference/ReportingScreensSCALE.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,4 +154,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.
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ When the console opens, it displays the TrueNAS Console Setup screen.

{{< trueimage src="/images/VMWareESXi/TrueNASConsoleSetup.png" alt="TrueNAS Console Setup" id="TrueNAS Console Setup" >}}

Follow the installation instructions documented for [SCALE]({{< relref "/SCALE/GettingStarted/Install/InstallingSCALE.md #using-the-truenas-installer" >}}) or [CORE]({{< relref "/CORE/GettingStarted/Install.md #install-process" >}}) to complete the installation of TrueNAS.
Follow the installation instructions documented for [SCALE]({{< relref "/SCALE/GettingStarted/Install/InstallingSCALE.md#using-the-truenas-installer" >}}) or [CORE]({{< relref "/CORE/GettingStarted/Install.md#install-process" >}}) to complete the installation of TrueNAS.

## Editing the Virtual Machine

Expand Down
Loading
Loading