PD-1555 / 25.04 / PD-1555 Rename App Snippets and Updates (#3280)

* PD-1555 Rename App Snippets and Updates This commit renames app Install Wizard snippets and modifies the paths in app articles. It also modifies the content in a few snippets. * Update InstallWizardSettingsOverview.md * Update SyncthingStable.md --------- Co-authored-by: tonyriv3 <[email protected]>
truenas · Dec 2, 2024 · 40a8ec4 · 40a8ec4
1 parent 9a3029b
commit 40a8ec4
Show file tree

Hide file tree

Showing 41 changed files with 101 additions and 92 deletions.
diff --git a/content/TruenasApps/CommunityApps/Chia.md b/content/TruenasApps/CommunityApps/Chia.md
@@ -175,7 +175,7 @@ The following sections provide more details on the settings found in each sectio
 
 ### Application Name Settings
 
-{{< include file="/static/includes/AppsWizardAppNameAndVersion.md" >}}
+{{< include file="/static/includes/InstallWizardAppNameAndVersion.md" >}}
 
 ### Chia Configuration
 The **Chia Configuration** section includes four settings: **Timezone**, **Chia Service Node**, **Full Node Peer**, and **Additional Environments**.

diff --git a/content/TruenasApps/CommunityApps/Immich.md b/content/TruenasApps/CommunityApps/Immich.md
@@ -99,7 +99,7 @@ The following sections provide more detailed explanations of the settings found
 
 ### Application Name Settings
 
-{{< include file="/static/includes/AppsWizardAppNameAndVersion.md" >}}
+{{< include file="/static/includes/InstallWizardAppNameAndVersion.md" >}}
 
 ### Immich Configuration Settings
 

diff --git a/content/TruenasApps/CommunityApps/_index.md b/content/TruenasApps/CommunityApps/_index.md
@@ -39,7 +39,7 @@ Some apps in this section replace deprecated services or functionality previousl
 
 ## Understanding App Install Wizard Settings
 
-{{< include file="/static/includes/apps/AppsInstallWizardSettings.md" >}}
+{{< include file="/static/includes/apps/InstallWizardSettingsOverview.md" >}}
 
 <div class="noprint">
 

diff --git a/content/TruenasApps/CommunityApps/ddns-updater.md b/content/TruenasApps/CommunityApps/ddns-updater.md
@@ -97,7 +97,7 @@ Find specific fields or skip to a particular section with the navigation box in
 
 ### Application Name
 
-{{< include file="/static/includes/AppsWizardAppNameAndVersion.md" >}}
+{{< include file="/static/includes/InstallWizardAppNameAndVersion.md" >}}
 
 ### DDNS Updater Configuration
 

diff --git a/content/TruenasApps/CommunityApps/jellyfin.md b/content/TruenasApps/CommunityApps/jellyfin.md
@@ -116,7 +116,7 @@ The following sections provide more detailed explanations of the settings found
 
 ### Application Name Settings
 
-{{< include file="/static/includes/AppsWizardAppNameAndVersion.md" >}}
+{{< include file="/static/includes/InstallWizardAppNameAndVersion.md" >}}
 
 ### Jellyfin Configuration Settings
 

diff --git a/content/TruenasApps/EnterpriseApps/MinIO/ConfigMinioEnterpriseMNMD.md b/content/TruenasApps/EnterpriseApps/MinIO/ConfigMinioEnterpriseMNMD.md
@@ -34,7 +34,7 @@ Community members can add and use the MinIO Enterprise app or the default commun
 ## Before You Begin
 To install the MinIO **enterprise** train app, do the following:
 
-{{< include file="/static/includes/apps/AppsEnterprieseBeforeYouBegin.md" >}}
+{{< include file="/static/includes/apps/BeforeYouBeginEnterpriseApps.md" >}}
 
 {{< include file="/static/includes/MinIOEnterpriseMultiModeBeforeYouBegin.md" >}}
 
@@ -48,7 +48,7 @@ This basic procedure covers the required MinIO enterprise app settings.
 For optional settings, see [Understanding MinIO Wizard Settings](#understanding-minio-wizard-settings).
 {{< /hint >}}
 
-{{< include file="/static/includes/apps/AddMultipleAppInstancesAndNaming.md" >}}
+{{< include file="/static/includes/apps/MultipleAppInstancesAndNaming.md" >}}
 
 {{< include file="/static/includes/apps/MinIoEnterpriseConfig1.md" >}}
 
@@ -101,7 +101,7 @@ The following section provides more detailed explanations of the settings in eac
 
 ### Application Name Settings
 
-{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}}
+{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}}
 
 ### MinIO Configuration Settings
 
@@ -115,7 +115,7 @@ Click **Enabled** under **Multi Mode (SNMD or MNMD) Configuration** to enable mu
 
 ### User and Group Configuration
 
-{{< include file="/static/includes/apps/AppUserAndGroupConfig.md" >}}
+{{< include file="/static/includes/apps/InstallWizardUserAndGroupConfig.md" >}}
 
 ### Network Configuration
 
@@ -135,7 +135,7 @@ Specify the default user UID **568** or the UID for the new user created in True
 
 {{< trueimage src="/images/SCALE/Apps/InstallMinIOEnterpriseData1ACLandACESettings.png" alt="MinIO Enterprise ACL and ACE Settings" id="MinIO Enterprise ACL and ACE Setting" >}} 
 
-{{< include file="/static/includes/apps/AppInstallWizardACLConfiguration.md" >}}
+{{< include file="/static/includes/apps/InstallWizardStorageACLConfig.md" >}}
 
 Set ACL permissions for each dataset in the configuration, and on each system in the cluster.
 

diff --git a/content/TruenasApps/EnterpriseApps/MinIO/ConfigMinioEnterpriseSNMD.md b/content/TruenasApps/EnterpriseApps/MinIO/ConfigMinioEnterpriseSNMD.md
@@ -32,7 +32,7 @@ Community members can add and use the MinIO Enterprise app or the default commun
 ## Before You Begin
 To install the MinIO **enterprise** train app, do the following:
 
-{{< include file="/static/includes/apps/AppsEnterprieseBeforeYouBegin.md" >}}
+{{< include file="/static/includes/apps/BeforeYouBeginEnterpriseApps.md" >}}
 
 {{< include file="/static/includes/MinIOEnterpriseMultiModeBeforeYouBegin.md" >}}
 
@@ -46,7 +46,7 @@ This basic procedure covers the required MinIO enterprise app settings.
 For optional settings, see [Understanding MinIO Wizard Settings](#understanding-minio-wizard-settings).
 {{< /hint >}}
 
-{{< include file="/static/includes/apps/AddMultipleAppInstancesAndNaming.md" >}}
+{{< include file="/static/includes/apps/MultipleAppInstancesAndNaming.md" >}}
 
 {{< include file="/static/includes/apps/MinIoEnterpriseConfig1.md" >}}
 
@@ -87,7 +87,7 @@ The following section provides more detailed explanations of the settings in eac
 
 ### Application Name Settings
 
-{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}}
+{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}}
 
 ### MinIO Configuration Settings
 
@@ -101,7 +101,7 @@ Click **Enabled** under **Multi Mode (SNMD or MNMD) Configuration** to enable mu
 
 ### User and Group Configuration
 
-{{< include file="/static/includes/apps/AppUserAndGroupConfig.md" >}}
+{{< include file="/static/includes/apps/InstallWizardUserAndGroupConfig.md" >}}
 
 ### Network Configuration
 
@@ -121,7 +121,7 @@ Specify the default user UID **568** or the UID for the new user created in True
 
 {{< trueimage src="/images/SCALE/Apps/InstallMinIOEnterpriseData1ACLandACESettings.png" alt="MinIO Enterprise ACL and ACE Settings" id="MinIO Enterprise ACL and ACE Setting" >}}
 
-{{< include file="/static/includes/apps/AppInstallWizardACLConfiguration.md" >}}
+{{< include file="/static/includes/apps/InstallWizardStorageACLConfig.md" >}}
 
 Set ACL permissions for each dataset in the configuration.
 

diff --git a/content/TruenasApps/EnterpriseApps/MinIO/_index.md b/content/TruenasApps/EnterpriseApps/MinIO/_index.md
@@ -30,7 +30,7 @@ Community members can add and use the MinIO Enterprise app or the default commun
 ## Before You Begin
 To install the MinIO **enterprise** train app, do the following:
 
-{{< include file="/static/includes/apps/AppsEnterprieseBeforeYouBegin.md" >}}
+{{< include file="/static/includes/apps/BeforeYouBeginEnterpriseApps.md" >}}
 
 {{< include file="/static/includes/apps/MinIODatasetRequirements.md" >}}
 
@@ -43,7 +43,7 @@ This basic procedure covers the required MinIO enterprise app settings.
 For optional settings, see [Understanding MinIO Wizard Settings](#understanding-minio-wizard-settings).
 {{< /hint >}}
 
-{{< include file="/static/includes/apps/AddMultipleAppInstancesAndNaming.md" >}}
+{{< include file="/static/includes/apps/MultipleAppInstancesAndNaming.md" >}}
 
 {{< include file="/static/includes/apps/MinIoEnterpriseConfig1.md" >}}
 
@@ -77,7 +77,7 @@ The following section provides more detailed explanations of the settings in eac
 
 ### Application Name Settings
 
-{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}}
+{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}}
 
 ### MinIO Configuration Settings
 
@@ -99,13 +99,13 @@ For more information see:
 
 ### User and Group Configuration
 
-{{< include file="/static/includes/apps/AppInstallWizardUserAndGroupConfig.md" >}}
+{{< include file="/static/includes/apps/InstallWizardUserAndGroupConfig.md" >}}
 
 ### Network Configuration
 
 {{< include file="/static/includes/apps/MinIOEnterpriseNetworkConfig.md" >}}
 
-{{< include file="/static/includes/apps/AppInstallWizardCertificateSettings.md" >}}
+{{< include file="/static/includes/apps/InstallWizardCertificateSettings.md" >}}
 
 ### Storage Configuration
 
@@ -115,19 +115,19 @@ For more information see:
 
 {{< trueimage src="/images/SCALE/Apps/InstallMinIOEnterpriseData1ACLandACESettings.png" alt="Home and Data1 Host Path ACL and ACE Settings" id="Home and Data1 Host Path ACL and ACE Settings" >}}
 
-{{< include file="/static/includes/apps/AppInstallWizardACLConfiguration.md" >}}
+{{< include file="/static/includes/InstallWizardStorageACLConfig.md" >}}
 
 #### Mounting an SMB Share
 The TrueNAS MinIO app includes the option to mount an SMB share inside the container pod.
 
-{{< include file="/static/includes/AppWizardStorageSMBOption.md" >}}
+{{< include file="/static/includes/InstallWizardStorageSMBOption.md" >}}
 
 
 ### Resource Configuration
 
 {{< trueimage src="/images/SCALE/Apps/InstallMinIOEnterpriseResourcesConfig.png" alt="MinIO Enterprise Resource Limits" id="MinIO Enterprise Resource Limits" >}}
 
-{{< include file="/static/includes/apps/AppInstallWizardResourceConfig.md" >}}
+{{< include file="/static/includes/apps/InstallWizardResourceConfig.md" >}}
 
 <div class="noprint">
 

diff --git a/content/TruenasApps/EnterpriseApps/Syncthing.md b/content/TruenasApps/EnterpriseApps/Syncthing.md
@@ -35,7 +35,7 @@ Community users can access enterprise versions of apps by adding the **enterpris
 Before launching the app installation wizard, do the following:
 * Create a self-signed certificate for the Syncthing enterprise app.
 
-  {{< include file="/static/includes/apps/AddAppCertificate.md" >}}
+  {{< include file="/static/includes/apps/AddingAppCertificate.md" >}}
 
 * Create the required datasets, **home** and **data1**.
 
@@ -49,11 +49,11 @@ Before launching the app installation wizard, do the following:
 
 {{< trueimage src="/images/SCALE/Apps/InstallSyncthingEnterpriseScreen.png" alt="Install Syncthing Enterprise Screen" id="Install Syncthing Enterprise Screen" >}}
 
-{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}}
+{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}}
 
 Next, enter the **Syncthing Configuration** settings.
 
-{{< include file="/static/includes/apps/AppsInstallWizardTimezoneSetting.md" >}}
+{{< include file="/static/includes/apps/InstallWizardTimezoneSetting.md" >}}
 
 Accept the default user and group IDs or enter the UID for any new TrueNAS user created to serve as the administrator for this app. See [User and Group Settings](#user-and-group-settings) below for more information.
 
@@ -94,10 +94,10 @@ The following sections provide detailed explanations of the settings found in ea
 
 ### Application Name Settings
 
-{{< include file="/static/includes/Apps/AppsWizardAppNameAndVersion.md" >}}
+{{< include file="/static/includes/Apps/InstallWizardAppNameAndVersion.md" >}}
 
 ### Configuration Setting
-{{< include file="/static/includes/apps/AppsInstallWizardTimezoneSetting.md" >}}
+{{< include file="/static/includes/apps/InstallWizardTimezoneSetting.md" >}}
 
 {{< include file="/static/includes/apps/AppInstallWizardEnvironVariablesSettings.md" >}}
 
@@ -133,7 +133,7 @@ Selecting **Migrate Data** forces a read-only mount regardless of the **Read Onl
 The SMB mount options are set to **vers=3.0**, **cifsacl**, and **noperm**.
 ACL preservation is not guaranteed if in a non-AD environment, or if the ACL or remote server contains local users.
 
-{{< include file="/static/includes/apps/AppWizardStorageSMBOption.md" >}}
+{{< include file="/static/includes/apps/InstallWizardStorageSMBOption.md" >}}
 
 ### Resource Configuration Settings
 

diff --git a/content/TruenasApps/EnterpriseApps/_index.md b/content/TruenasApps/EnterpriseApps/_index.md
@@ -31,7 +31,7 @@ For more information on configuring general application functions and installati
 
 ## Understanding App Install Wizard Settings
 
-{{< include file="/static/includes/apps/AppsInstallWizardSettings.md" >}}
+{{< include file="/static/includes/apps/InstallWizardSettingsOverview.md" >}}
 
 For information on adding to or changing the train for the apps catalog, see [Managing App Trains]({{< relref "UsingTrains.md" >}}).
 

diff --git a/content/TruenasApps/StableApps/InstallNetdataApp.md b/content/TruenasApps/StableApps/InstallNetdataApp.md
@@ -84,7 +84,7 @@ The following sections provide more detail explanations of the settings found in
 
 ### Application Name Settings
 
-{{< include file="/static/includes/AppsWizardAppNameAndVersion.md" >}}
+{{< include file="/static/includes/InstallWizardAppNameAndVersion.md" >}}
 
 ### Netdata Configuration Settings
 You can accept the defaults in the **Netdata Configuration** settings or enter the settings you want to use.

diff --git a/content/TruenasApps/StableApps/InstallNextCloudMedia.md b/content/TruenasApps/StableApps/InstallNextCloudMedia.md
@@ -26,9 +26,9 @@ The instructions in this article apply to TrueNAS 22.10.0 and later.
 ## Before You Begin
 Before you install the Nextcloud app:
 
-{{< include file="/static/includes/apps/AppsStableBeforeYouBegin.md" >}}
+{{< include file="/static/includes/apps/BeforeYouBeginStableApps.md" >}}
 
-{{< include file="/static/includes/apps/AppsBeforeYouBeginCertificate.md" >}}
+{{< include file="/static/includes/apps/BeforeYouBeginAddAppCertificate.md" >}}
 
 <p style="margin-left: 33px">Adding a certificate is optional but if you want to use a certificate for this application, either create a new self-signed CA and certificate or import an existing CA and create the certificate for Nextcloud. A certificate is not required to deploy the application.</p>
 
@@ -75,7 +75,7 @@ Before you install the Nextcloud app:
   {{< /expand >}}
 
 
-{{< include file="/static/includes/apps/AppBeforeYouBeginNewUser.md" >}}
+{{< include file="/static/includes/apps/BeforeYouBeginAddNewAppUser.md" >}}
 
 * Set up a Nextcloud account.
   If you have an existing Nextcloud account, you enter the credentials for that users in the installation wizard.
@@ -87,13 +87,13 @@ This basic procedure covers the required Nextcloud app settings.
 For optional settings, see [Understanding App Installation Wizard Settings](#understanding-app-installation-wizard-settings).
 {{< /hint >}}
 
-{{< include file="/static/includes/apps/AddMultipleAppInstancesAndNaming.md" >}}
+{{< include file="/static/includes/apps/MultipleAppInstancesAndNaming.md" >}}
 
 {{< include file="/static/includes/apps/LocateAndOpenInstallWizard.md" >}}
 
 {{< trueimage src="/images/SCALE/Apps/InstallNextcloudScreen.png" alt="Install Nextcloud Screen" id="Install Nextcloud Screen" >}}
 
-{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}}
+{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}}
 
 Next, enter the **Nextcloud Configuration** settings.
 {{< expand "Entering Nextcloud Configuration Settings" "v" >}}
@@ -174,7 +174,7 @@ The following section provides more detailed explanations of the settings in eac
 
 ### Application Name Settings
 
-{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}}
+{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}}
 
 ### Nextcloud Configuration Settings
 Nextcloud configuration settings include setting up credentials, APT packages (previously referred to as the commands), the host IP and port, data directory path, upload limits, execution times, memory limits and cache memory consumption, adding a cron job with schedule, and adding additional environment variables.
@@ -226,9 +226,9 @@ Refer to Nextcloud documentation for more information on environment variables.
 ### Network Configuration
 The default web port for Nextcloud is **30027**.
 
-{{< include file="/static/includes/apps/AppsInstallWizardDefaultPorts.md" >}}
-{{< include file="/static/includes/apps/AppsInstallWizardAdvancedDNSSettings.md" >}}
-{{< include file="/static/includes/apps/AppInstallWizardCertificateSettings.md" >}}
+{{< include file="/static/includes/apps/InstallWizardDefaultPorts.md" >}}
+{{< include file="/static/includes/apps/InstallWizardAdvancedDNSSettings.md" >}}
+{{< include file="/static/includes/apps/InstallWizardCertificateSettings.md" >}}
 
 **Nginx Configuration** setting, **Proxy Timeout**, applies the time out (in seconds) to proxy connection, and proxy send and receive.
 The default value is **60** with a minimum of 30 seconds.
@@ -289,19 +289,19 @@ When finished you should have the **nextcloud** parent dataset with three child
 
 #### ACL and ACE Settings
 
-{{< include file="/static/includes/apps/AppInstallWizardACLConfiguration.md" >}}
+{{< include file="/static/includes/apps/InstallWizardStorageACLConfig.md" >}}
 
 #### Mounting an SMB Share
 TrueNAS **Additional Storage** options include the ability to mount an SMB share inside the container pod.
 
-{{< include file="/static/includes/apps/AppWizardStorageSMBOption.md" >}}
+{{< include file="/static/includes/apps/InstallWizardStorageSMBOption.md" >}}
 
 ### Resource Configuration
 
 {{< trueimage src="/images/SCALE/Apps/InstallNextcloudResourcesConfig.png" alt="Resources Configuration Settings" id="Resources Configuration Settings" >}}
 
-{{< include file="/static/includes/apps/AppInstallWizardResourceConfig.md" >}}
-{{< include file="/static/includes/apps/AppsInstallWizardGPUPassthrough.md" >}}
+{{< include file="/static/includes/apps/InstallWizardResourceConfig.md" >}}
+{{< include file="/static/includes/apps/InstallWizardGPUPassthrough.md" >}}
 
 ## Troubleshooting Tips
 

diff --git a/content/TruenasApps/StableApps/InstallWGEasyApp.md b/content/TruenasApps/StableApps/InstallWGEasyApp.md
@@ -53,7 +53,7 @@ The following sections provide more detail explanations of the settings found in
 
 ### Application Name Settings
 
-{{< include file="/static/includes/AppsWizardAppNameAndVersion.md" >}}
+{{< include file="/static/includes/InstallWizardAppNameAndVersion.md" >}}
 
 ### Configuration Settings
 You can accept the defaults in the **Configuration** settings, or enter the configuration settings you want to use.

diff --git a/content/TruenasApps/StableApps/MinIOApp/MinIOClustering.md b/content/TruenasApps/StableApps/MinIOApp/MinIOClustering.md
@@ -57,7 +57,7 @@ Begin on the first node (system) in your cluster.
 
 {{< trueimage src="/images/SCALE/Apps/InstallMinioS3Screen.png" alt="MinIO Install Wizard Screen" id="MinIO Install Wizard Screen" >}}
 
-{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}}
+{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}}
 
 Next, enter the **MinIO Configuration** settings.