Merge branch 'master' into DOCS-3617-Create-Docs-page-for-CLI-on-True…

…NAS-SCALE
truenas · Oct 10, 2022 · ef29ecd · ef29ecd
2 parents 9293e12 + 7244963
commit ef29ecd
Show file tree

Hide file tree

Showing 25 changed files with 221 additions and 130 deletions.
diff --git a/content/CORE/API/_index.md b/content/CORE/API/_index.md
@@ -1,7 +1,10 @@
 ---
 title: "API Reference"
+description: "This article describes how to access the API documentation in TrueNAS CORE."
 geekdocCollapseSection: true
 weight: 160
+tags:
+- coreapi
 ---
 
 TrueNAS CORE API documentation is available from the web interface by clicking **<i class="material-icons" aria-hidden="true" title="Settings">settings</i>&nbsp;> API Keys > DOCS**.
@@ -17,3 +20,5 @@ For convenience, static builds of the current 2.0 API documentation stored on th
 ## CORE Documentation Sections
 
 {{< include file="/_includes/COREDocsSections.md" type="page" >}}
+
+{{< taglist tag="coretopmenu" limit="10" >}}
diff --git a/content/CORE/CORETutorials/Network/IPMI.md b/content/CORE/CORETutorials/Network/IPMI.md
@@ -35,4 +35,6 @@ Save the configuration. Access the IPMI interface using a web browser and the IP
 
 Log in to the management interface. Here you can change the default administrative user name and create extra IPMI users. The appearance of the IPMI utility and the functions that are available vary by hardware.
 
-{{< taglist tag="corenetwork" limit="10" >}}
+{{< taglist tag="coreipmi" limit="10" >}}
+
+{{< taglist tag="corenetwork" limit="10" title="Related Articles" >}}
diff --git a/content/CORE/CORETutorials/Network/Interfaces/BridgeCreate.md b/content/CORE/CORETutorials/Network/Interfaces/BridgeCreate.md
@@ -22,12 +22,6 @@ See [Interfaces Screen]({{< relref "/CORE/UIReference/Network/InterfacesScreen.m
 
 {{< include file="/content/_includes/InterfaceOptions.md" markdown="true" >}}
 
-## Additional Information
-
-[Managing Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/ManagingJails.md" >}})
-
-[Managing Plugins]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Plugins/ManagingPlugins.md" >}})
-
-[Creating Basic Virtual Machines]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/VirtualMachines/CreatingBasicVM.md" >}})
-
 {{< taglist tag="corenetworkinterfaces" limit="10" >}}
+
+{{< taglist tag="corejailspluginsvm" limit="10" title="Related Articles" >}}
diff --git a/content/CORE/CORETutorials/Network/Interfaces/LAGGCreate.md b/content/CORE/CORETutorials/Network/Interfaces/LAGGCreate.md
@@ -47,14 +47,6 @@ See [Interfaces Screen]({{< relref "/CORE/UIReference/Network/InterfacesScreen.m
 
 {{< include file="/content/_includes/InterfaceOptions.md" markdown="true" >}}
 
-## Additional Information
-
-[Managing Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/ManagingJails.md" >}})
-
-[Managing Plugins]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Plugins/ManagingPlugins.md" >}})
-
-[Creating Basic Virtual Machines]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/VirtualMachines/CreatingBasicVM.md" >}})
-
 {{< taglist tag="corenetworkinterfaces" limit="10" >}}
 
 {{< taglist tag="corejailspluginsvm" limit="10" title="Related Articles" >}}
diff --git a/content/CORE/CORETutorials/Network/Interfaces/VLANCreate.md b/content/CORE/CORETutorials/Network/Interfaces/VLANCreate.md
@@ -30,12 +30,6 @@ See [Interfaces Screen]({{< relref "/CORE/UIReference/Network/InterfacesScreen.m
 
 {{< include file="/content/_includes/InterfaceOptions.md" markdown="true" >}}
 
-## Additional Information
-
-[Managing Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/ManagingJails.md" >}})
-
-[Managing Plugins]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Plugins/ManagingPlugins.md" >}})
-
-[Creating Basic Virtual Machines]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/VirtualMachines/CreatingBasicVM.md" >}})
-
 {{< taglist tag="corenetworkinterfaces" limit="10" >}}
+
+{{< taglist tag="corejailspluginsvm" limit="10" title="Related Articles" >}}
diff --git a/content/CORE/CORETutorials/UpdatingTrueNAS/UpdatingENTERPRISE.md b/content/CORE/CORETutorials/UpdatingTrueNAS/UpdatingENTERPRISE.md
@@ -1,9 +1,13 @@
 ---
 title: "Updating CORE ENTERPRISE"
+description: "This article describes how to update TrueNAS CORE ENTERPRISE."
 geekdocCollapseSection: true
 weight: 20
 aliases:
   - /core/system/update/updateenterprise/
+tags:
+- coreenterprise
+- coreupdateenterprise
 ---
 
 {{< toc >}}
@@ -113,4 +117,6 @@ Enterprise customers should contact iX Support for assistance updating their Tru
 * The Manual update uploads the file, installs it to both controllers, then reboots the Standby Controller. To complete the upgrade, click **Close** in the dialog box. Initiate a failover of the standby controller, as instructed, by clicking **INITIATE FAILOVER** from the Standby Controller's Dashboard card.
 * Log into the system.
 * Click **Continue** in the **Pending Upgrade** dialog box. The standby controller reboots completing the upgrade.
-{{< /expand >}}
+{{< /expand >}}
+
+{{< taglist tag="coreha" limit="10" >}}
diff --git a/content/CORE/CORETutorials/UpdatingTrueNAS/UpdatingSoftwareforaMajorVersion.md b/content/CORE/CORETutorials/UpdatingTrueNAS/UpdatingSoftwareforaMajorVersion.md
@@ -1,9 +1,12 @@
 ---
 title: "Updating Software for a Major Version"
+description: "This article describes options for keeping TrueNAS updated."
 geekdocCollapseSection: true
 weight: 30
 aliases:
   - /core/system/update/majorupgrade/
+tags:
+- coreupdate
 ---
 
 {{< toc >}}
@@ -115,4 +118,6 @@ During reboot, the previous configuration database can convert to the new versio
 The conversion happens during the reboot `Applying database schema changes` line.
 The conversion can take a long time to finish, sometimes fifteen minutes or more, and can cause the system to reboot again.
 The system boots normally afterwards.
-If database errors display but the web interface is accessible, log in, go to **System > General**, and use the **UPLOAD CONFIG** button to upload the configuration backup you downloaded before starting the upgrade.
+If database errors display but the web interface is accessible, log in, go to **System > General**, and use the **UPLOAD CONFIG** button to upload the configuration backup you downloaded before starting the upgrade.
+
+{{< taglist tag="coreupdate" limit="10" >}}
diff --git a/content/CORE/UIReference/Accounts/Groups.md b/content/CORE/UIReference/Accounts/Groups.md
@@ -1,6 +1,12 @@
 ---
 title: "Groups"
+description: "This article describes the fields on the Groups screen in TrueNAS CORE." 
 weight: 10
+tags:
+- coreusersandgroups
+- coregroups
+- coreusers
+- coreaccounts
 ---
 
 {{< toc >}}
@@ -13,24 +19,26 @@ The **Groups** screen lets you create and manage UNIX-style groups.
 
 | Name | Description |
 |------|------|
-| Filter Groups | Filters groups by keyword. |
-| COLUMNS | Lets users display/hide list columns. |
-| ADD | Opens the **Group Configuration** form  |
+| **Filter Groups** | Filters groups by keyword. |
+| **COLUMNS** | Lets users display/hide list columns. |
+| **ADD** | Opens the **Group Configuration** form  |
 | <span class="iconify" data-icon="mdi:cog"></span> | Displays/hides built-in groups |
-| Group | Group name. |
-| GID | Group ID number. |
-| Builtin | Whether or not the group is built-in. |
-| Permit Sudo | Whether or not the group has PErmit Sudo enabled. |
-| Samba Authentication | Whether or not the group has Samba Authentication enabled. |
+| **Group** | Group name. |
+| **GID** | Group ID number. |
+| **Builtin** | Whether or not the group is built-in. |
+| **Permit Sudo** | Whether or not the group has PErmit Sudo enabled. |
+| **Samba Authentication** | Whether or not the group has Samba Authentication enabled. |
 
 ## Groups Configuration
 
 ![UIRefGroupsAdd](/images/CORE/13.0/UIRefGroupsAdd.png "Accounts Groups Add")
 
 | Name | Description |
 |------|------|
-| GID | A unique number used to identify a Unix group. |
-| Name | Descriptive name for the group. |
-| Permit Sudo | Allows group members to use sudo. Group members are prompted for their password when using sudo. |
-| Samba Authentication | Allows group to be used for Samba permissions and authentication. |
-| Allow Duplicate GIDs | Allows more than one group to have the same group ID. |
+| **GID** | A unique number used to identify a Unix group. |
+| **Name** | Descriptive name for the group. |
+| **Permit Sudo** | Allows group members to use sudo. Group members are prompted for their password when using sudo. |
+| **Samba Authentication** | Allows group to be used for Samba permissions and authentication. |
+| **Allow Duplicate GIDs** | Allows more than one group to have the same group ID. |
+
+{{< taglist tag="coregroups" limit="10" >}}
diff --git a/content/CORE/UIReference/Network/GlobalConfigScreen.md b/content/CORE/UIReference/Network/GlobalConfigScreen.md
@@ -1,7 +1,11 @@
 ---
 title: "Global Configuration Screen"
+description: "This article describes how to use the Global Configuration screen in TrueNAS CORE."
 weight: 20
 aliases: /core/network/globalconfig/
+tags:
+- coreglobalconfiguration
+- coreconfiguration
 ---
 
 {{< toc >}}
@@ -71,3 +75,5 @@ Some options only display when the appropriate hardware is present.
 | **Enable Netwait Feature** | Select to prevents network services from starting until the interface can ping the addresses listed in the **Netwait IP list**. |
 | **Netwait IP List** | Select only appears when **Enable Netwait Feature** is set. Enter a list of IP addresses to ping. Separate entries by pressing <kbd>Enter</kbd>. Each address is tried until one is successful or the list is exhausted. Leave empty to use the default gateway. |
 | **Host Name Database** | Enter the database host name. Used to add one entry per line which is appended to <file>/etc/hosts</file>. Separate entries by pressing <kbd>Enter</kbd>. Use the format *IP_address space hostname* where multiple host names can be used if separated by a space. Hosts defined here are still accessible by name even when DNS is not available. See <a href="https://www.freebsd.org/cgi/man.cgi?query=hosts">hosts</a> for additional information. |
+
+{{< taglist tag="coreconfiguration" limit="10" >}}
diff --git a/content/CORE/UIReference/Network/IPMIScreen.md b/content/CORE/UIReference/Network/IPMIScreen.md
@@ -1,6 +1,10 @@
 ---
 title: "IPMI Screen"
+description: "This article describes the fields on the IPMI screen in TrueNAS CORE."
 weight: 50
+tags:
+- coreipmi
+- corenetworkinterfaces
 ---
 
 
@@ -24,3 +28,7 @@ Use the I**Network > IPMI** screen to configure the TrueNAS for an IPMI connecti
 Use **SAVE** to save the IPMI settings.
 
 See [IPMI]({{< relref "/CORE/CORETutorials/Network/IPMI.md" >}})
+
+{{< taglist tag="coreipmi" limit="10" >}}
+
+{{< taglist tag="corenetworkinterfaces" limit="10" title="Related Network Articles" >}}
diff --git a/content/CORE/UIReference/Network/InterfacesScreen.md b/content/CORE/UIReference/Network/InterfacesScreen.md
@@ -1,6 +1,10 @@
 ---
 title: "Interfaces Screen"
+description: "This article describes the fields in the Network Interface screen on TrueNAS CORE."
 weight: 10
+tags:
+- corenetworkinterfaces
+- coreinterfaces
 ---
 
 Use the **Network > Interface** Screen to add various network interfaces to your TrueNAS. 
@@ -106,10 +110,4 @@ The **Interface Edit** screen displays only the editable configuration settings
 
 Use **APPLY** to save changes to settings and return to the **Interfaces** screen.
 
-## Additional Information
-
-[Setting Up a Network Bridge]({{< relref "/CORE/CORETutorials/Network/Interfaces/BridgeCreate.md" >}}) 
-
-[Setting Up Link Aggregations]({{< relref "/CORE/CORETutorials/Network/Interfaces/LAGGCreate.md" >}})
-
-[Setting Up a VLAN]({{< relref "/CORE/CORETutorials/Network/Interfaces/VLANCreate.md" >}})
+{{< taglist tag="corenetworkinterfaces" limit="10" >}}
diff --git a/content/CORE/UIReference/Network/NetworkSummary.md b/content/CORE/UIReference/Network/NetworkSummary.md
@@ -1,6 +1,10 @@
 ---
 title: "Network Summary"
+description: "This article describes the Network Summary screen in TrueNAS CORE."
 weight: 10
+tags:
+- corenetworksummary
+- corenetworkinterfaces
 ---
 
 It is recommended to set up your system connections before setting up data sharing.
@@ -28,3 +32,5 @@ These areas are not editable.
 Define any Static Routes in **Network > [Static Routes]({{< relref "/CORE/CORETutorials/Network/StaticRoutes.md" >}})**.
 
 Out of Band Management is managed from **Network > [IPMI]({{< relref "/CORE/CORETutorials/Network/IPMI.md" >}})**. This option is visible only when TrueNAS detects the appropriate physical hardware.
+
+{{< taglist tag="corenetworkinterfaces" limit="10" >}}
diff --git a/content/CORE/UIReference/Network/NetworkSummaryScreen.md b/content/CORE/UIReference/Network/NetworkSummaryScreen.md
@@ -1,7 +1,11 @@
 ---
 title: "Network Summary Screen"
+description: "This article describes the fields in the Network Summary screen in TrueNAS CORE."
 weight: 10
 aliases: /core/network/networksummary/
+tags:
+- corenetworksummary
+- corenetworkinterfaces
 ---
 
 It is recommended to set up your system connections before setting up data sharing.
@@ -30,3 +34,5 @@ The IPv4 or IPv6 address displays when a [static IP]({{< relref "/CORE/CORETutor
 Define any Static Routes in **Network > [Static Routes]({{< relref "/CORE/UIReference/Network/StaticRoutesScreen.md" >}})**.
 
 Out-of-band management is managed from **Network > [IPMI]({{< relref "/CORE/CORETutorials/Network/IPMI.md" >}})**. This option is visible only when TrueNAS detects the appropriate physical hardware.
+
+{{< taglist tag="corenetworkinterfaces" limit="10" >}}
diff --git a/content/CORE/UIReference/Network/StaticRoutesScreen.md b/content/CORE/UIReference/Network/StaticRoutesScreen.md
@@ -1,6 +1,10 @@
 ---
 title: "Static Routes Screen"
+description: "This article describes how to configure static routes in TrueNAS CORE."
 weight: 40
+tags:
+- corestaticroutes
+- corenetworkinterfaces
 ---
 
 Use the **Network Static Routes** screen to define static routes on your TrueNAS. By default, no static routes are defined on a default TrueNAS system.
@@ -21,4 +25,6 @@ Use **Add** to dispay the **Static Routes Add** screen.
 | **Gateway** | Enter the IP address of the gateway. |
 | **Description** | Enter any notes or identifiers describing the static route. |
 
-The **SUBMIT** button activates after entering values in the required fields. Use **CANCEL** to exit without saving and retun to the **Static Routes** screen.
+The **SUBMIT** button activates after entering values in the required fields. Use **CANCEL** to exit without saving and retun to the **Static Routes** screen.
+
+{{< taglist tag="corenetworkinterfaces" limit="10" >}}
diff --git a/content/CORE/UIReference/ReportingGraphs.md b/content/CORE/UIReference/ReportingGraphs.md
@@ -1,7 +1,11 @@
 ---
 title: "Reporting"
+description: "This article contains information about the graphs displayed on the Reporting screen in TrueNAS CORE."
 weight: 135
 Aliases: /core/system/reporting/
+tags:
+- corereporting
+- coregraphs
 ---
 
 {{< toc >}}
@@ -125,3 +129,5 @@ Temperature monitoring for the disk is disabled if **HDD Standby** is enabled. C
 ![ReportingZFSTab](/images/CORE/12.0/ReportingZFSTab.png "ZFS Reporting")
 
 {{< /expand >}}
+
+{{< taglist tag="corereporting" limit="10" >}}
diff --git a/content/CORE/UIReference/System/Advanced.md b/content/CORE/UIReference/System/Advanced.md
@@ -1,6 +1,10 @@
 ---
 title: "Advanced"
+description: "This article describes advanced options for configuring system settings on TrueNAS CORE."
 weight: 40
+tags:
+- coreconfiguration
+- coresettings
 ---
 
 **System > Advanced** contains advanced options for configuring system settings.
@@ -14,4 +18,6 @@ Make sure you are comfortable with ZFS, FreeBSD, and system [configuration backu
 
 {{< include file="static/includes/Reference/SystemAdvancedFields.md.part" markdown="true" >}}
 
-**SAVE DEBUG** generates text files that contain diagnostic information.
+**SAVE DEBUG** generates text files that contain diagnostic information.
+
+{{< taglist tag="coreconfiguration" limit="10" >}}