DOCSP-44124-ToC-Refactor (#1927)

ltran-mdb2 · jwilliams-mongo · commit 084563d3fa5d · 2025-04-14T17:11:24.000-05:00
* DOCSP-44124-ToC-Refactor * DOCSP-44124-ToC-Refactor * DOCSP-44124-ToC-Refactor * DOCSP-44124-ToC-Refactor * DOCSP-44124-ToC-Refactor * DOCSP-44124 copy edits * DOCSP-44124 adding ampersand
diff --git a/source/configure-k8s-operator-for-mdb-resources.txt b/source/configure-k8s-operator-for-mdb-resources.txt
@@ -30,6 +30,6 @@ Configure the |k8s-op-short| for MongoDB Database Resources
    :titlesonly:
    :hidden:
 
-   /tutorial/create-operator-credentials
-   /tutorial/create-project-using-configmap
-   /tutorial/create-x509-client-certs
+   Create Credentials </tutorial/create-operator-credentials>
+   Create One Project </tutorial/create-project-using-configmap>
+   Generate X.509 Certificates </tutorial/create-x509-client-certs>
diff --git a/source/connect.txt b/source/connect.txt
@@ -24,5 +24,5 @@ database resource that is deployed to |k8s|:
    :titlesonly:
    :hidden:
 
-   /tutorial/connect-from-inside-k8s
-   /tutorial/connect-from-outside-k8s
+   Inside Kubernetes </tutorial/connect-from-inside-k8s>
+   Outside Kubernetes </tutorial/connect-from-outside-k8s>
diff --git a/source/deploy.txt b/source/deploy.txt
@@ -31,7 +31,7 @@ Deploy a MongoDB Database Resource
    :titlesonly:
    :hidden:
 
-   /tutorial/deploy-standalone
-   /tutorial/deploy-replica-set
-   /tutorial/deploy-sharded-cluster
-   /tutorial/deploy-prometheus
+   Standalone Instance </tutorial/deploy-standalone>
+   Replica Set </tutorial/deploy-replica-set>
+   Sharded Cluster </tutorial/deploy-sharded-cluster>
+   Use with Prometheus </tutorial/deploy-prometheus>
diff --git a/source/index.txt b/source/index.txt
@@ -55,17 +55,17 @@ optimal performance.
 
    Quick Start </kind-quick-start>
    OpenShift Tutorials </openshift-tutorials>
-   Kubernetes Operator Architecture </tutorial/plan-k8s-op-architecture>
+   Architecture </tutorial/plan-k8s-op-architecture>
    Security </security>
-   Install the Operator </installation>
-   Deploy Ops Manager Resources </om-resources>
-   Deploy MongoDB Database Resources </mdb-resources>
-   Deploy MongoDB Resources on Multiple Kubernetes Clusters </multi-cluster>
-   /tutorial/modify-resource-image
-   /gdc-hosted
-   /reference
+   Install </installation>
+   Deploy Ops Manager </om-resources>
+   Deploy Database Resources </mdb-resources>
+   Deploy on Multiple Kubernetes Clusters </multi-cluster>
+   Modify Containers </tutorial/modify-resource-image>
+   Host on GDC </gdc-hosted>
+   Reference </reference>
    FAQ </faq.txt>
    Release Notes </release-notes>
-   /reference/troubleshooting
+   Troubleshoot </reference/troubleshooting>
    Known Issues </reference/known-issues>
    MongoDB Community Kubernetes Operator <https://github.com/mongodb/mongodb-kubernetes-operator>
diff --git a/source/installation.txt b/source/installation.txt
@@ -32,7 +32,7 @@ Install and Configure the |k8s-op-short|
    :titlesonly:
    :hidden:
 
-   /tutorial/plan-k8s-operator-install
-   /tutorial/install-k8s-operator
-   /tutorial/verify-mongodb-packages
-   /upgrade
+   Plan Installation </tutorial/plan-k8s-operator-install>
+   Install </tutorial/install-k8s-operator>
+   Verify Package Integrity </tutorial/verify-mongodb-packages>
+   Upgrade </upgrade>
diff --git a/source/manage-users.txt b/source/manage-users.txt
@@ -30,6 +30,6 @@ Manage Database Users
    :titlesonly:
    :hidden:
 
-   /tutorial/manage-database-users-ldap
-   /tutorial/manage-database-users-scram
-   /tutorial/manage-database-users-x509
+   Use LDAP </tutorial/manage-database-users-ldap>
+   Use SCRAM </tutorial/manage-database-users-scram>
+   Use X.509 </tutorial/manage-database-users-x509>
diff --git a/source/mdb-resources.txt b/source/mdb-resources.txt
@@ -42,14 +42,14 @@ from the |k8s| |api|, without having to configure them in
    :titlesonly:
    :hidden:
 
-   /tutorial/mdb-resources-arch
-   /configure-k8s-operator-for-mdb-resources
-   /deploy
-   /tutorial/edit-deployment
-   /tutorial/secure-client-connections
-   /tutorial/back-up-mdb-resources
-   /tutorial/configure-mongodb-cluster-topology
-   /tutorial/configure-mongodb-specific-storage
-   /manage-users
-   /connect
+   Database Architecture </tutorial/mdb-resources-arch>
+   Configure </configure-k8s-operator-for-mdb-resources>
+   Deploy </deploy>
+   Edit </tutorial/edit-deployment>
+   Secure Client Connections </tutorial/secure-client-connections>
+   Configure Backups </tutorial/back-up-mdb-resources>
+   Configure Topology </tutorial/configure-mongodb-cluster-topology>
+   Configure Storage Options </tutorial/configure-mongodb-specific-storage>
+   Manage Users </manage-users>
+   Connect </connect>
  
diff --git a/source/multi-cluster-connect.txt b/source/multi-cluster-connect.txt
@@ -28,4 +28,4 @@ is deployed to |k8s|:
    :titlesonly:
    :hidden:
 
-   /tutorial/multi-cluster-connect-from-outside-k8s
+   Connect from Outside Kubernetes </tutorial/multi-cluster-connect-from-outside-k8s>
diff --git a/source/multi-cluster.txt b/source/multi-cluster.txt
@@ -67,16 +67,16 @@ Deploy MongoDB Resources on Multiple Kubernetes Clusters
    :hidden:
 
    Overview <multi-cluster-overview>
-   Architecture and Limitations </multi-cluster-arch>
-   Services and Tools </multi-cluster-services-tools>
+   Architecture & Limitations </multi-cluster-arch>
+   Services & Tools </multi-cluster-services-tools>
    Prerequisites </multi-cluster-prerequisites>
    Quick Start </multi-cluster-quick-start>
-   Deploy a MongoDBMultiCluster Resource </multi-cluster-deploy-replica-set>
-   Deploy a MongoDBMultiCluster Resource without a Service Mesh <multi-cluster-no-service-mesh-deploy-rs>
-   Edit a MongoDBMultiCluster Resource </tutorial/multi-cluster-edit-deployment>
+   Deploy a Resource </multi-cluster-deploy-replica-set>
+   Deploy Without a Service Mesh <multi-cluster-no-service-mesh-deploy-rs>
+   Edit a Resource </tutorial/multi-cluster-edit-deployment>
    Secure Connections </tutorial/multi-cluster-secure-client-connections>
    Access Resources </multi-cluster-connect>
    Sharded Cluster </multi-cluster-sharded-cluster>
    Disaster Recovery </multi-cluster-disaster-recovery>
-   MongoDB Plugin Reference </plugin-reference>
-   Troubleshoot Deployments </multi-cluster-troubleshooting>
+   Plugin Reference </plugin-reference>
+   Troubleshoot </multi-cluster-troubleshooting>
diff --git a/source/om-resources.txt b/source/om-resources.txt
@@ -58,15 +58,15 @@ Deploy Ops Manager Resources on Kubernetes Clusters
 .. toctree::
    :titlesonly:
 
-   /tutorial/om-arch
-   /tutorial/plan-om-resource
-   /tutorial/deploy-om-multi-cluster
-   /tutorial/deploy-om-container
-   /tutorial/deploy-om-container-remote-mode
-   /tutorial/deploy-om-container-local-mode
-   /tutorial/upgrade-om-version
-   /tutorial/configure-om-queryable-backups
-   /tutorial/configure-kmip-backup-encryption
-   /tutorial/configure-file-store
-   /tutorial/cert-manager-integration
-   /tutorial/disaster-recovery-om-appdb
+   Ops Manager Architecture </tutorial/om-arch>
+   Plan Resource </tutorial/plan-om-resource>
+   Deploy on Multiple Clusters </tutorial/deploy-om-multi-cluster>
+   Deploy Resource </tutorial/deploy-om-container>
+   Use Remote Mode </tutorial/deploy-om-container-remote-mode>
+   Use Local Mode </tutorial/deploy-om-container-local-mode>
+   Upgrade </tutorial/upgrade-om-version>
+   Configure Queryable Backups </tutorial/configure-om-queryable-backups>
+   Configure KMIP Backup Encryption </tutorial/configure-kmip-backup-encryption>
+   Configure File System Backup </tutorial/configure-file-store>
+   Configure cert-manager </tutorial/cert-manager-integration>
+   Disaster Recovery </tutorial/disaster-recovery-om-appdb>
diff --git a/source/openshift-tutorials.txt b/source/openshift-tutorials.txt
@@ -18,4 +18,4 @@ This section contains the following:
    :hidden:
 
    Quick Start </openshift-quick-start>
-   Deploy in Restricted Network Environment </tutorial/restricted-network-tutorial>
+   Deploy in Restricted Network </tutorial/restricted-network-tutorial>
diff --git a/source/reference.txt b/source/reference.txt
@@ -46,13 +46,13 @@ Reference
    :titlesonly:
    :hidden:
 
-   /reference/k8s-operator-om-specification
-   /reference/k8s-operator-mongodbuser-specification
-   /reference/k8s-operator-specification
-   /reference/k8s-operator-multi-cluster-specification
-   /reference/operator-settings
-   /reference/k8s-op-exclusive-settings
-   /reference/support-lifecycle
-   /reference/k8s-operator-crd-logging-specification
-   /third-party-integrations
-   /third-party-licenses
+   Ops Manager </reference/k8s-operator-om-specification>
+   MongoDB User </reference/k8s-operator-mongodbuser-specification>
+   Databases </reference/k8s-operator-specification>
+   Multi-Kubernetes-Clusters</reference/k8s-operator-multi-cluster-specification>
+   Enterprise Installation Settings </reference/operator-settings>
+   Exclusive Settings </reference/k8s-op-exclusive-settings>
+   Support Lifestyle </reference/support-lifecycle>
+   CRD Log Rotation Settings </reference/k8s-operator-crd-logging-specification>
+   Third-Party Integrations </third-party-integrations>
+   Third-Party Licenses </third-party-licenses>
diff --git a/source/reference/operator-settings.txt b/source/reference/operator-settings.txt
@@ -22,5 +22,5 @@ the environment to which you deploy the |k8s-op-short|.
    :titlesonly:
    :hidden:
 
-   Operator `kubectl` and `oc` Installation Settings </reference/kubectl-operator-settings>
-   Operator Helm Installation Settings </reference/helm-operator-settings>
+   Operator `kubectl` & `oc` </reference/kubectl-operator-settings>
+   Operator Helm </reference/helm-operator-settings>
diff --git a/source/security.txt b/source/security.txt
@@ -39,10 +39,10 @@ to secure your MongoDB deployments.
    :titlesonly:
    :hidden:
 
-   /permissions
-   /verify-signatures
-   /opa-gatekeeper
-   /encryption
+   Verify Permissions </permissions>
+   Verify Signatures </verify-signatures>
+   Use Gatekeeper OPA </opa-gatekeeper>
+   Configure Encryption </encryption>
    Configure Encryption at Rest </encryption-at-rest>
-   /authentication
-   /tutorial/secret-storage
+   Enable Authentication </authentication>
+   Configure Secret Storage </tutorial/secret-storage>
diff --git a/source/tutorial/disaster-recovery-om-appdb.txt b/source/tutorial/disaster-recovery-om-appdb.txt
@@ -27,6 +27,6 @@ Disaster Recovery for |onprem| and AppDB Resources
    :titlesonly:
    :hidden:
 
-   /tutorial/recover-om-appdb-yes-k8sop-cluster
-   /tutorial/recover-om-appdb-no-k8sop-cluster
-   /tutorial/recover-appdb-forced-reconfig
+   Recover Available Cluster </tutorial/recover-om-appdb-yes-k8sop-cluster>
+   Recover Failed Cluster </tutorial/recover-om-appdb-no-k8sop-cluster>
+   Recover Lost Majority Replica Set </tutorial/recover-appdb-forced-reconfig>
diff --git a/source/tutorial/edit-deployment.txt b/source/tutorial/edit-deployment.txt
@@ -53,6 +53,6 @@ Procedure
    :titlesonly:
    :hidden:
 
-   /tutorial/upgrade-mdb-version
-   /tutorial/scale-resources
-   /tutorial/resize-pv-storage
+   Upgrade MongoDB </tutorial/upgrade-mdb-version>
+   Scale Deployment </tutorial/scale-resources>
+   Increase Storage </tutorial/resize-pv-storage>
diff --git a/source/tutorial/multi-cluster-secure-client-connections.txt b/source/tutorial/multi-cluster-secure-client-connections.txt
@@ -28,7 +28,7 @@ Secure Client Connections
    :titlesonly:
    :hidden:
 
-   /tutorial/multi-cluster-secure-ldap-auth
-   /tutorial/multi-cluster-secure-x509
-   /tutorial/multi-cluster-secure-internal-auth
+   Use LDAP </tutorial/multi-cluster-secure-ldap-auth>
+   Use X.509 </tutorial/multi-cluster-secure-x509>
+   Use X.509 for Internal Authentication </tutorial/multi-cluster-secure-internal-auth>
 
diff --git a/source/tutorial/om-arch.txt b/source/tutorial/om-arch.txt
@@ -43,6 +43,6 @@ and the {+appdb+} using their |k8s-crds| in the |k8s-op-short|:
 .. toctree::
    :titlesonly:
 
-   MongoDBOpsManager Resource Definition </tutorial/om-resource-crd-parts>
+   MongoDBOpsManager Resource </tutorial/om-resource-crd-parts>
    Reconciliation </tutorial/om-arch-reconciliation>
-   Deployments on Multiple Kubernetes Clusters </tutorial/om-arch-multi-cluster>
+   Multi-Cluster Deployments </tutorial/om-arch-multi-cluster>
diff --git a/source/tutorial/plan-k8s-operator-install.txt b/source/tutorial/plan-k8s-operator-install.txt
@@ -60,7 +60,7 @@ resources.
    Architecture </tutorial/plan-k8s-op-architecture>
    Compatibility </tutorial/plan-k8s-op-compatibility>
    Container Images </tutorial/plan-k8s-op-container-images>
-   Single- or Multi-Kubernetes Clusters </tutorial/plan-k8s-install-single-or-multi-clusters>
+   Single or Multi-Kubernetes Clusters </tutorial/plan-k8s-install-single-or-multi-clusters>
    Set Deployment Scope </tutorial/set-scope-k8s-operator>
-   /tutorial/plan-k8s-op-considerations
-   /tutorial/plan-k8s-op-prerequisites
+   Considerations </tutorial/plan-k8s-op-considerations>
+   Prerequisites </tutorial/plan-k8s-op-prerequisites>
diff --git a/source/tutorial/secret-storage.txt b/source/tutorial/secret-storage.txt
@@ -124,4 +124,4 @@ After you configure the |secret-store| for the |k8s-op-full|, you can:
    :titlesonly:
    :hidden:
 
-   /tutorial/create-vault-secret
+   Create Secrets in Vault </tutorial/create-vault-secret>
diff --git a/source/tutorial/secure-client-connections.txt b/source/tutorial/secure-client-connections.txt
@@ -28,7 +28,7 @@ Secure Client Connections
    :titlesonly:
    :hidden:
 
-   /tutorial/secure-ldap-auth
-   /tutorial/secure-x509-auth
-   /tutorial/secure-internal-auth
+   Use LDAP </tutorial/secure-ldap-auth>
+   Use X.509 </tutorial/secure-x509-auth>
+   Use X.509 with Internal Authentication </tutorial/secure-internal-auth>
 
diff --git a/source/upgrade.txt b/source/upgrade.txt
@@ -32,5 +32,5 @@ Upgrade the |k8s-op-short| from Prior Versions
    :titlesonly:
    :hidden:
 
-   /tutorial/upgrade-k8s-operator
-   /tutorial/migrate-k8s-images
+   Upgrade Enterprise </tutorial/upgrade-k8s-operator>
+   Migrate from Ubuntu to UBI </tutorial/migrate-k8s-images>
