Merge pull request #160 from jillian-maroket/fix-issues-4

Fix xref issues + revert to old start file name
rancher · Sep 30, 2024 · b76ed53 · b76ed53
2 parents a8ab58c + ec4c6ad
commit b76ed53
Show file tree

Hide file tree

Showing 11 changed files with 12 additions and 12 deletions.
diff --git a/docs/version-1.7.0/antora.yml b/docs/version-1.7.0/antora.yml
@@ -2,6 +2,6 @@ name: storage
 title: SUSE® Storage
 version: 1.7.0
 display_version: 1.7.0 (latest)
-start_page: en:overview.adoc
+start_page: en:longhorn-documentation.adoc
 nav:
 - modules/en/nav.adoc
diff --git a/docs/version-1.7.0/modules/en/nav.adoc b/docs/version-1.7.0/modules/en/nav.adoc
@@ -1,12 +1,12 @@
-* xref:overview.adoc[]
+* xref:longhorn-documentation.adoc[]
 * xref:introduction/introduction.adoc[]
 ** xref:introduction/concepts.adoc[]
 ** xref:introduction/terminology.adoc[]
 ** xref:introduction/contributing.adoc[]
-* xref:introduction/important-notes.adoc[]
+* xref:important-notes.adoc[]
 * Installation and Setup
 ** xref:installation-setup/requirements.adoc[]
-** xref:introduction/best-practices.adoc[]
+** xref:installation-setup/best-practices.adoc[]
 ** xref:installation-setup/installation/installation.adoc[]
 *** xref:installation-setup/installation/install-using-argocd.adoc[]
 *** xref:installation-setup/installation/install-using-fleet.adoc[]

diff --git a/...ersion-1.7.0/modules/en/pages/installation-setup/installation/installation.adoc b/...ersion-1.7.0/modules/en/pages/installation-setup/installation/installation.adoc
@@ -4,7 +4,7 @@
 :current-version: {page-component-version}
 
 NOTE: This quick installation guide uses some configurations which are not for production usage.
-Please see xref:introduction/best-practices.adoc[] for how to configure SUSE® Storage for production usage.
+Please see xref:installation-setup/best-practices.adoc[] for how to configure SUSE® Storage for production usage.
 
 SUSE® Storage can be installed on a Kubernetes cluster in several ways:
 

diff --git a/docs/version-1.7.0/modules/en/pages/installation-setup/os-distro/talos-linux.adoc b/docs/version-1.7.0/modules/en/pages/installation-setup/os-distro/talos-linux.adoc
@@ -31,7 +31,7 @@ Longhorn requires pod security `enforce: "privileged"`.
 
 By default, Talos Linux applies a `baseline` pod security profile across namespaces, except for the kube-system namespace. This default setting restricts Longhorn's ability to manage and access system resources. For more information, see xref:installation-setup/requirements.adoc#_root_and_privileged_permission[Root and Privileged Permission].
 
-For detailed instructions, see xref:introduction/important-notes.adoc#_pod_security_policies_disabled__pod_security_admission_introduction[Pod Security Policies Disabled & Pod Security Admission Introduction] and the Talos documentation on https://www.talos.dev/v1.6/kubernetes-guides/configuration/pod-security/[Pod Security].
+For detailed instructions, see xref:important-notes.adoc#_pod_security_policies_disabled__pod_security_admission_introduction[Pod Security Policies Disabled & Pod Security Admission Introduction] and the Talos documentation on https://www.talos.dev/v1.6/kubernetes-guides/configuration/pod-security/[Pod Security].
 
 === Data Path Mounts
 

diff --git a/docs/version-1.7.0/modules/en/pages/installation-setup/requirements.adoc b/docs/version-1.7.0/modules/en/pages/installation-setup/requirements.adoc
@@ -18,7 +18,7 @@ The Longhorn workloads must be able to run as root in order for Longhorn to be d
 
 <<_using_the_environment_check_script,This script>> can be used to check the Longhorn environment for potential issues.
 
-For the minimum recommended hardware, refer to the xref:introduction/best-practices.adoc#_minimum_recommended_hardware[best practices guide.]
+For the minimum recommended hardware, refer to the xref:installation-setup/best-practices.adoc#_minimum_recommended_hardware[best practices guide.]
 
 [discrete]
 == OS/Distro Specific Configuration

diff --git a/...sion-1.7.0/modules/en/pages/overview.adoc → ...ules/en/pages/longhorn-documentation.adoc b/...sion-1.7.0/modules/en/pages/overview.adoc → ...ules/en/pages/longhorn-documentation.adoc
diff --git a/.../version-1.7.0/modules/en/pages/longhorn-system/networking/storage-network.adoc b/.../version-1.7.0/modules/en/pages/longhorn-system/networking/storage-network.adoc
@@ -59,7 +59,7 @@ Configure the setting xref:longhorn-system/settings.adoc#_storage_network_for_rw
 
 When an RWX volume is created with the storage network, the NFS mount point connection must be re-established when the CSI plugin pod restarts. Longhorn provides the xref:longhorn-system/settings.adoc#_automatically_delete_workload_pod_when_the_volume_is_detached_unexpectedly[Automatically Delete Workload Pod when The Volume Is Detached Unexpectedly] setting, which automatically deletes RWX volume workload pods when the CSI plugin pod restarts. However, the workload pod's NFS mount point could become unresponsive when the setting is disabled or the pod is not managed by a controller. In such cases, you must manually restart the CSI plugin pod.
 
-For more information, see xref:introduction/important-notes.adoc#_storage_network_support_for_read_write_many_rwx_volumes[Storage Network Support for Read-Write-Many (RWX) Volume] in Important Notes.
+For more information, see xref:important-notes.adoc#_storage_network_support_for_read_write_many_rwx_volumes[Storage Network Support for Read-Write-Many (RWX) Volume] in Important Notes.
 
 == History
 

diff --git a/docs/version-1.7.0/modules/en/pages/longhorn-system/settings.adoc b/docs/version-1.7.0/modules/en/pages/longhorn-system/settings.adoc
@@ -723,7 +723,7 @@ ____
 
 This setting allows user to create and attach a volume that doesn't have all the replicas scheduled at the time of creation.
 
-NOTE: It's recommended to disable this setting when using Longhorn in the production environment. See xref:introduction/best-practices.adoc[Best Practices] for details.
+NOTE: It's recommended to disable this setting when using Longhorn in the production environment. See xref:installation-setup/best-practices.adoc[Best Practices] for details.
 
 === Disable Scheduling On Cordoned Node
 

diff --git a/docs/version-1.7.0/modules/en/pages/volumes/storageclass-parameters.adoc b/docs/version-1.7.0/modules/en/pages/volumes/storageclass-parameters.adoc
@@ -311,7 +311,7 @@ ____
 
 ____
 Global setting: xref:longhorn-system/settings.adoc#_replica_node_level_soft_anti_affinity[Replica Node Level Soft Anti-Affinity].
-More details in xref:nodes/scheduling.adoc[Scheduling] and xref:introduction/best-practices.adoc#_replica_node_level_soft_anti_affinity[Best Practices].
+More details in xref:nodes/scheduling.adoc[Scheduling] and xref:installation-setup/best-practices.adoc#_replica_node_level_soft_anti_affinity[Best Practices].
 ____
 
 [discrete]

diff --git a/lh-local-playbook.yml b/lh-local-playbook.yml
@@ -1,6 +1,6 @@
 site:
   title: SUSE® Storage
-  start_page: 1.7.0@storage:en:overview.adoc
+  start_page: 1.7.0@storage:en:longhorn-documentation.adoc
 
 content:
   sources:

diff --git a/lh-remote-playbook.yml b/lh-remote-playbook.yml
@@ -1,6 +1,6 @@
 site:
   title: Longhorn
-  start_page: 1.7.0@storage:en:overview.adoc
+  start_page: 1.7.0@storage::index.adoc
 
 content:
   sources: