Skip to content

Commit 6483cb6

Browse files
ltran-mdb2ltran-mdb2
authored
DOCSP-44124-ToC-Refactor (#1927) (#1939)
* 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 (cherry picked from commit fb446a6) # Conflicts: # source/mdb-resources.txt
1 parent d39e878 commit 6483cb6

22 files changed

+95
-94
lines changed

‎source/configure-k8s-operator-for-mdb-resources.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@ Configure the |k8s-op-short| for MongoDB Database Resources
3030
:titlesonly:
3131
:hidden:
3232

33-
/tutorial/create-operator-credentials
34-
/tutorial/create-project-using-configmap
35-
/tutorial/create-x509-client-certs
33+
Create Credentials </tutorial/create-operator-credentials>
34+
Create One Project </tutorial/create-project-using-configmap>
35+
Generate X.509 Certificates </tutorial/create-x509-client-certs>

‎source/connect.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ database resource that is deployed to |k8s|:
2424
:titlesonly:
2525
:hidden:
2626

27-
/tutorial/connect-from-inside-k8s
28-
/tutorial/connect-from-outside-k8s
27+
Inside Kubernetes </tutorial/connect-from-inside-k8s>
28+
Outside Kubernetes </tutorial/connect-from-outside-k8s>

‎source/deploy.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Deploy a MongoDB Database Resource
3131
:titlesonly:
3232
:hidden:
3333

34-
/tutorial/deploy-standalone
35-
/tutorial/deploy-replica-set
36-
/tutorial/deploy-sharded-cluster
37-
/tutorial/deploy-prometheus
34+
Standalone Instance </tutorial/deploy-standalone>
35+
Replica Set </tutorial/deploy-replica-set>
36+
Sharded Cluster </tutorial/deploy-sharded-cluster>
37+
Use with Prometheus </tutorial/deploy-prometheus>

‎source/index.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,17 @@ optimal performance.
5555

5656
Quick Start </kind-quick-start>
5757
OpenShift Tutorials </openshift-tutorials>
58-
Kubernetes Operator Architecture </tutorial/plan-k8s-op-architecture>
58+
Architecture </tutorial/plan-k8s-op-architecture>
5959
Security </security>
60-
Install the Operator </installation>
61-
Deploy Ops Manager Resources </om-resources>
62-
Deploy MongoDB Database Resources </mdb-resources>
63-
Deploy MongoDB Resources on Multiple Kubernetes Clusters </multi-cluster>
64-
/tutorial/modify-resource-image
65-
/gdc-hosted
66-
/reference
60+
Install </installation>
61+
Deploy Ops Manager </om-resources>
62+
Deploy Database Resources </mdb-resources>
63+
Deploy on Multiple Kubernetes Clusters </multi-cluster>
64+
Modify Containers </tutorial/modify-resource-image>
65+
Host on GDC </gdc-hosted>
66+
Reference </reference>
6767
FAQ </faq.txt>
6868
Release Notes </release-notes>
69-
/reference/troubleshooting
69+
Troubleshoot </reference/troubleshooting>
7070
Known Issues </reference/known-issues>
7171
MongoDB Community Kubernetes Operator <https://github.com/mongodb/mongodb-kubernetes-operator>

‎source/installation.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Install and Configure the |k8s-op-short|
3232
:titlesonly:
3333
:hidden:
3434

35-
/tutorial/plan-k8s-operator-install
36-
/tutorial/install-k8s-operator
37-
/tutorial/verify-mongodb-packages
38-
/upgrade
35+
Plan Installation </tutorial/plan-k8s-operator-install>
36+
Install </tutorial/install-k8s-operator>
37+
Verify Package Integrity </tutorial/verify-mongodb-packages>
38+
Upgrade </upgrade>

‎source/manage-users.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@ Manage Database Users
3030
:titlesonly:
3131
:hidden:
3232

33-
/tutorial/manage-database-users-ldap
34-
/tutorial/manage-database-users-scram
35-
/tutorial/manage-database-users-x509
33+
Use LDAP </tutorial/manage-database-users-ldap>
34+
Use SCRAM </tutorial/manage-database-users-scram>
35+
Use X.509 </tutorial/manage-database-users-x509>

‎source/mdb-resources.txt

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,14 @@ from the |k8s| |api|, without having to configure them in
4242
:titlesonly:
4343
:hidden:
4444

45-
/tutorial/mdb-resources-arch
46-
/configure-k8s-operator-for-mdb-resources
47-
/deploy
48-
/tutorial/edit-deployment
49-
/tutorial/secure-client-connections
50-
/tutorial/back-up-mdb-resources
51-
/tutorial/configure-mongodb-cluster-topology
52-
/tutorial/configure-mongodb-specific-storage
53-
/manage-users
54-
/connect
45+
Database Architecture </tutorial/mdb-resources-arch>
46+
Configure </configure-k8s-operator-for-mdb-resources>
47+
Deploy </deploy>
48+
Edit </tutorial/edit-deployment>
49+
Secure Client Connections </tutorial/secure-client-connections>
50+
Configure Backups </tutorial/back-up-mdb-resources>
51+
Configure Topology </tutorial/configure-mongodb-cluster-topology>
52+
Configure Storage Options </tutorial/configure-mongodb-specific-storage>
53+
Manage Users </manage-users>
54+
Connect </connect>
55+

‎source/multi-cluster-connect.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ is deployed to |k8s|:
2828
:titlesonly:
2929
:hidden:
3030

31-
/tutorial/multi-cluster-connect-from-outside-k8s
31+
Connect from Outside Kubernetes </tutorial/multi-cluster-connect-from-outside-k8s>

‎source/multi-cluster.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,16 @@ Deploy MongoDB Resources on Multiple Kubernetes Clusters
6464
:hidden:
6565

6666
Overview <multi-cluster-overview>
67-
Architecture and Limitations </multi-cluster-arch>
68-
Services and Tools </multi-cluster-services-tools>
67+
Architecture & Limitations </multi-cluster-arch>
68+
Services & Tools </multi-cluster-services-tools>
6969
Prerequisites </multi-cluster-prerequisites>
7070
Quick Start </multi-cluster-quick-start>
71-
Deploy a MongoDBMultiCluster Resource </multi-cluster-deploy-replica-set>
72-
Deploy a MongoDBMultiCluster Resource without a Service Mesh <multi-cluster-no-service-mesh-deploy-rs>
73-
Edit a MongoDBMultiCluster Resource </tutorial/multi-cluster-edit-deployment>
71+
Deploy a Resource </multi-cluster-deploy-replica-set>
72+
Deploy Without a Service Mesh <multi-cluster-no-service-mesh-deploy-rs>
73+
Edit a Resource </tutorial/multi-cluster-edit-deployment>
7474
Secure Connections </tutorial/multi-cluster-secure-client-connections>
7575
Access Resources </multi-cluster-connect>
7676

7777
Disaster Recovery </multi-cluster-disaster-recovery>
78-
MongoDB Plugin Reference </plugin-reference>
79-
Troubleshoot Deployments </multi-cluster-troubleshooting>
78+
Plugin Reference </plugin-reference>
79+
Troubleshoot </multi-cluster-troubleshooting>

‎source/om-resources.txt

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -58,15 +58,15 @@ Deploy Ops Manager Resources on Kubernetes Clusters
5858
.. toctree::
5959
:titlesonly:
6060

61-
/tutorial/om-arch
62-
/tutorial/plan-om-resource
63-
/tutorial/deploy-om-multi-cluster
64-
/tutorial/deploy-om-container
65-
/tutorial/deploy-om-container-remote-mode
66-
/tutorial/deploy-om-container-local-mode
67-
/tutorial/upgrade-om-version
68-
/tutorial/configure-om-queryable-backups
69-
/tutorial/configure-kmip-backup-encryption
70-
/tutorial/configure-file-store
71-
/tutorial/cert-manager-integration
72-
/tutorial/disaster-recovery-om-appdb
61+
Ops Manager Architecture </tutorial/om-arch>
62+
Plan Resource </tutorial/plan-om-resource>
63+
Deploy on Multiple Clusters </tutorial/deploy-om-multi-cluster>
64+
Deploy Resource </tutorial/deploy-om-container>
65+
Use Remote Mode </tutorial/deploy-om-container-remote-mode>
66+
Use Local Mode </tutorial/deploy-om-container-local-mode>
67+
Upgrade </tutorial/upgrade-om-version>
68+
Configure Queryable Backups </tutorial/configure-om-queryable-backups>
69+
Configure KMIP Backup Encryption </tutorial/configure-kmip-backup-encryption>
70+
Configure File System Backup </tutorial/configure-file-store>
71+
Configure cert-manager </tutorial/cert-manager-integration>
72+
Disaster Recovery </tutorial/disaster-recovery-om-appdb>

‎source/openshift-tutorials.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ This section contains the following:
1818
:hidden:
1919

2020
Quick Start </openshift-quick-start>
21-
Deploy in Restricted Network Environment </tutorial/restricted-network-tutorial>
21+
Deploy in Restricted Network </tutorial/restricted-network-tutorial>

‎source/reference.txt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ Reference
4646
:titlesonly:
4747
:hidden:
4848

49-
/reference/k8s-operator-om-specification
50-
/reference/k8s-operator-mongodbuser-specification
51-
/reference/k8s-operator-specification
52-
/reference/k8s-operator-multi-cluster-specification
53-
/reference/operator-settings
54-
/reference/k8s-op-exclusive-settings
55-
/reference/support-lifecycle
56-
/reference/k8s-operator-crd-logging-specification
57-
/third-party-integrations
58-
/third-party-licenses
49+
Ops Manager </reference/k8s-operator-om-specification>
50+
MongoDB User </reference/k8s-operator-mongodbuser-specification>
51+
Databases </reference/k8s-operator-specification>
52+
Multi-Kubernetes-Clusters</reference/k8s-operator-multi-cluster-specification>
53+
Enterprise Installation Settings </reference/operator-settings>
54+
Exclusive Settings </reference/k8s-op-exclusive-settings>
55+
Support Lifestyle </reference/support-lifecycle>
56+
CRD Log Rotation Settings </reference/k8s-operator-crd-logging-specification>
57+
Third-Party Integrations </third-party-integrations>
58+
Third-Party Licenses </third-party-licenses>

‎source/reference/operator-settings.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ the environment to which you deploy the |k8s-op-short|.
2222
:titlesonly:
2323
:hidden:
2424

25-
Operator `kubectl` and `oc` Installation Settings </reference/kubectl-operator-settings>
26-
Operator Helm Installation Settings </reference/helm-operator-settings>
25+
Operator `kubectl` & `oc` </reference/kubectl-operator-settings>
26+
Operator Helm </reference/helm-operator-settings>

‎source/security.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ to secure your MongoDB deployments.
3939
:titlesonly:
4040
:hidden:
4141

42-
/permissions
43-
/verify-signatures
44-
/opa-gatekeeper
45-
/encryption
42+
Verify Permissions </permissions>
43+
Verify Signatures </verify-signatures>
44+
Use Gatekeeper OPA </opa-gatekeeper>
45+
Configure Encryption </encryption>
4646
Configure Encryption at Rest </encryption-at-rest>
47-
/authentication
48-
/tutorial/secret-storage
47+
Enable Authentication </authentication>
48+
Configure Secret Storage </tutorial/secret-storage>

‎source/tutorial/disaster-recovery-om-appdb.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ Disaster Recovery for |onprem| and AppDB Resources
2727
:titlesonly:
2828
:hidden:
2929

30-
/tutorial/recover-om-appdb-yes-k8sop-cluster
31-
/tutorial/recover-om-appdb-no-k8sop-cluster
32-
/tutorial/recover-appdb-forced-reconfig
30+
Recover Available Cluster </tutorial/recover-om-appdb-yes-k8sop-cluster>
31+
Recover Failed Cluster </tutorial/recover-om-appdb-no-k8sop-cluster>
32+
Recover Lost Majority Replica Set </tutorial/recover-appdb-forced-reconfig>

‎source/tutorial/edit-deployment.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,6 @@ Procedure
5353
:titlesonly:
5454
:hidden:
5555

56-
/tutorial/upgrade-mdb-version
57-
/tutorial/scale-resources
58-
/tutorial/resize-pv-storage
56+
Upgrade MongoDB </tutorial/upgrade-mdb-version>
57+
Scale Deployment </tutorial/scale-resources>
58+
Increase Storage </tutorial/resize-pv-storage>

‎source/tutorial/multi-cluster-secure-client-connections.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Secure Client Connections
2828
:titlesonly:
2929
:hidden:
3030

31-
/tutorial/multi-cluster-secure-ldap-auth
32-
/tutorial/multi-cluster-secure-x509
33-
/tutorial/multi-cluster-secure-internal-auth
31+
Use LDAP </tutorial/multi-cluster-secure-ldap-auth>
32+
Use X.509 </tutorial/multi-cluster-secure-x509>
33+
Use X.509 for Internal Authentication </tutorial/multi-cluster-secure-internal-auth>
3434

‎source/tutorial/om-arch.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,6 @@ and the {+appdb+} using their |k8s-crds| in the |k8s-op-short|:
4343
.. toctree::
4444
:titlesonly:
4545

46-
MongoDBOpsManager Resource Definition </tutorial/om-resource-crd-parts>
46+
MongoDBOpsManager Resource </tutorial/om-resource-crd-parts>
4747
Reconciliation </tutorial/om-arch-reconciliation>
48-
Deployments on Multiple Kubernetes Clusters </tutorial/om-arch-multi-cluster>
48+
Multi-Cluster Deployments </tutorial/om-arch-multi-cluster>

‎source/tutorial/plan-k8s-operator-install.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ resources.
6060
Architecture </tutorial/plan-k8s-op-architecture>
6161
Compatibility </tutorial/plan-k8s-op-compatibility>
6262
Container Images </tutorial/plan-k8s-op-container-images>
63-
Single- or Multi-Kubernetes Clusters </tutorial/plan-k8s-install-single-or-multi-clusters>
63+
Single or Multi-Kubernetes Clusters </tutorial/plan-k8s-install-single-or-multi-clusters>
6464
Set Deployment Scope </tutorial/set-scope-k8s-operator>
65-
/tutorial/plan-k8s-op-considerations
66-
/tutorial/plan-k8s-op-prerequisites
65+
Considerations </tutorial/plan-k8s-op-considerations>
66+
Prerequisites </tutorial/plan-k8s-op-prerequisites>

‎source/tutorial/secret-storage.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,4 +124,4 @@ After you configure the |secret-store| for the |k8s-op-full|, you can:
124124
:titlesonly:
125125
:hidden:
126126

127-
/tutorial/create-vault-secret
127+
Create Secrets in Vault </tutorial/create-vault-secret>

‎source/tutorial/secure-client-connections.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Secure Client Connections
2828
:titlesonly:
2929
:hidden:
3030

31-
/tutorial/secure-ldap-auth
32-
/tutorial/secure-x509-auth
33-
/tutorial/secure-internal-auth
31+
Use LDAP </tutorial/secure-ldap-auth>
32+
Use X.509 </tutorial/secure-x509-auth>
33+
Use X.509 with Internal Authentication </tutorial/secure-internal-auth>
3434

‎source/upgrade.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,5 @@ Upgrade the |k8s-op-short| from Prior Versions
3232
:titlesonly:
3333
:hidden:
3434

35-
/tutorial/upgrade-k8s-operator
36-
/tutorial/migrate-k8s-images
35+
Upgrade Enterprise </tutorial/upgrade-k8s-operator>
36+
Migrate from Ubuntu to UBI </tutorial/migrate-k8s-images>

0 commit comments

Comments
 (0)