Skip to content

Commit 7a95438

Browse files
authored
(DOCSP-35766) Replaces deprecated class directive (#1591)
1 parent b9e1fb0 commit 7a95438

19 files changed

+163
-183
lines changed

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

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,10 @@ Configure the |k8s-op-short| for MongoDB Database Resources
2626
Create an X.509 certificate to connect to an X.509-enabled
2727
MongoDB deployment.
2828

29-
.. class:: hidden
29+
.. toctree::
30+
:titlesonly:
31+
:hidden:
3032

31-
.. toctree::
32-
:titlesonly:
33-
34-
/tutorial/create-operator-credentials
35-
/tutorial/create-project-using-configmap
36-
/tutorial/create-x509-client-certs
33+
/tutorial/create-operator-credentials
34+
/tutorial/create-project-using-configmap
35+
/tutorial/create-x509-client-certs

source/connect.txt

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,9 @@ database resource that is deployed to |k8s|:
2020
of the |k8s| cluster.
2121

2222

23-
.. class:: hidden
23+
.. toctree::
24+
:titlesonly:
25+
:hidden:
2426

25-
.. toctree::
26-
:titlesonly:
27-
28-
/tutorial/connect-from-inside-k8s
29-
/tutorial/connect-from-outside-k8s
27+
/tutorial/connect-from-inside-k8s
28+
/tutorial/connect-from-outside-k8s

source/deploy.txt

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,11 @@ Deploy a MongoDB Database Resource
2727
Use |k8s-op-short| to deploy a MongoDB resource to use with
2828
Prometheus monitoring enabled.
2929

30-
.. class:: hidden
31-
32-
.. toctree::
33-
:titlesonly:
34-
35-
/tutorial/deploy-standalone
36-
/tutorial/deploy-replica-set
37-
/tutorial/deploy-sharded-cluster
38-
/tutorial/deploy-prometheus
30+
.. toctree::
31+
:titlesonly:
32+
:hidden:
33+
34+
/tutorial/deploy-standalone
35+
/tutorial/deploy-replica-set
36+
/tutorial/deploy-sharded-cluster
37+
/tutorial/deploy-prometheus

source/index.txt

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -44,23 +44,22 @@ You can then deploy MongoDB databases as you deploy them now after the
4444
cluster is created. You can use the |com| console to run MongoDB at
4545
optimal performance.
4646

47-
.. class:: hidden
47+
.. toctree::
48+
:titlesonly:
49+
:hidden:
4850

49-
.. toctree::
50-
:titlesonly:
51-
52-
Quick Start </kind-quick-start>
53-
OpenShift Tutorials </openshift-tutorials>
54-
Kubernetes Operator Architecture </tutorial/plan-k8s-op-architecture>
55-
Security </security>
56-
Install the Operator </installation>
57-
Deploy Ops Manager Resources </om-resources>
58-
Deploy MongoDB Database Resources </mdb-resources>
59-
Deploy MongoDB Resources on Multiple Kubernetes Clusters </multi-cluster>
60-
/tutorial/modify-resource-image
61-
/reference
62-
FAQ </faq.txt>
63-
Release Notes </release-notes>
64-
/reference/troubleshooting
65-
Known Issues </reference/known-issues>
66-
MongoDB Community Kubernetes Operator <https://github.com/mongodb/mongodb-kubernetes-operator>
51+
Quick Start </kind-quick-start>
52+
OpenShift Tutorials </openshift-tutorials>
53+
Kubernetes Operator Architecture </tutorial/plan-k8s-op-architecture>
54+
Security </security>
55+
Install the Operator </installation>
56+
Deploy Ops Manager Resources </om-resources>
57+
Deploy MongoDB Database Resources </mdb-resources>
58+
Deploy MongoDB Resources on Multiple Kubernetes Clusters </multi-cluster>
59+
/tutorial/modify-resource-image
60+
/reference
61+
FAQ </faq.txt>
62+
Release Notes </release-notes>
63+
/reference/troubleshooting
64+
Known Issues </reference/known-issues>
65+
MongoDB Community Kubernetes Operator <https://github.com/mongodb/mongodb-kubernetes-operator>

source/installation.txt

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,10 @@ Install and Configure the |k8s-op-short|
2424
:ref:`upgrade`
2525
Upgrade from earlier versions of |k8s-op-short|.
2626

27-
.. class:: hidden
27+
.. toctree::
28+
:titlesonly:
29+
:hidden:
2830

29-
.. toctree::
30-
:titlesonly:
31-
32-
/tutorial/plan-k8s-operator-install
33-
/tutorial/install-k8s-operator
34-
/upgrade
31+
/tutorial/plan-k8s-operator-install
32+
/tutorial/install-k8s-operator
33+
/upgrade

source/manage-users.txt

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,10 @@ Manage Database Users
2626
Manage database users for deployments running with TLS and X.509
2727
internal cluster authentication enabled.
2828

29-
.. class:: hidden
29+
.. toctree::
30+
:titlesonly:
31+
:hidden:
3032

31-
.. toctree::
32-
:titlesonly:
33-
34-
/tutorial/manage-database-users-ldap
35-
/tutorial/manage-database-users-scram
36-
/tutorial/manage-database-users-x509
33+
/tutorial/manage-database-users-ldap
34+
/tutorial/manage-database-users-scram
35+
/tutorial/manage-database-users-x509

source/mdb-resources.txt

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,16 @@ from the |k8s| |api|, without having to configure them in
3737

3838
:ref:`Remove a Database resource <remove-k8s-resource>`
3939
Delete a MongoDB database resource.
40-
41-
.. class:: hidden
42-
43-
.. toctree::
44-
:titlesonly:
45-
46-
/tutorial/mdb-resources-arch
47-
/configure-k8s-operator-for-mdb-resources
48-
/deploy
49-
/tutorial/edit-deployment
50-
/tutorial/secure-client-connections
51-
/tutorial/back-up-mdb-resources
52-
/manage-users
53-
/connect
40+
41+
.. toctree::
42+
:titlesonly:
43+
:hidden:
44+
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+
/manage-users
52+
/connect

source/multi-cluster-connect.txt

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,8 @@ is deployed to |k8s|:
2424
and select the tab :guilabel:`Using the Kubernetes Secret`. This procedure
2525
is the same as for single clusters deployed with the |k8s-op-short|.
2626

27+
.. toctree::
28+
:titlesonly:
29+
:hidden:
2730

28-
.. class:: hidden
29-
30-
.. toctree::
31-
:titlesonly:
32-
33-
/tutorial/multi-cluster-connect-from-outside-k8s
31+
/tutorial/multi-cluster-connect-from-outside-k8s

source/multi-cluster.txt

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -59,22 +59,21 @@ Deploy MongoDB Resources on Multiple Kubernetes Clusters
5959
:ref:`kubectl-plugin-ref`
6060
Review the |kubectl-mongodb| options.
6161

62-
.. class:: hidden
63-
64-
.. toctree::
65-
:titlesonly:
66-
67-
Overview <multi-cluster-overview>
68-
Architecture and Limitations </multi-cluster-arch>
69-
Services and Tools </multi-cluster-services-tools>
70-
Prerequisites </multi-cluster-prerequisites>
71-
Quick Start </multi-cluster-quick-start>
72-
Deploy a MongoDBMultiCluster Resource </multi-cluster-deploy-replica-set>
73-
Deploy a MongoDBMultiCluster Resource without a Service Mesh <multi-cluster-no-service-mesh-deploy-rs>
74-
Edit a MongoDBMultiCluster Resource </tutorial/multi-cluster-edit-deployment>
75-
Secure Connections </tutorial/multi-cluster-secure-client-connections>
76-
Access Resources </multi-cluster-connect>
77-
78-
Disaster Recovery </multi-cluster-disaster-recovery>
79-
MongoDB Plugin Reference </plugin-reference>
80-
Troubleshoot Deployments </multi-cluster-troubleshooting>
62+
.. toctree::
63+
:titlesonly:
64+
:hidden:
65+
66+
Overview <multi-cluster-overview>
67+
Architecture and Limitations </multi-cluster-arch>
68+
Services and Tools </multi-cluster-services-tools>
69+
Prerequisites </multi-cluster-prerequisites>
70+
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>
74+
Secure Connections </tutorial/multi-cluster-secure-client-connections>
75+
Access Resources </multi-cluster-connect>
76+
77+
Disaster Recovery </multi-cluster-disaster-recovery>
78+
MongoDB Plugin Reference </plugin-reference>
79+
Troubleshoot Deployments </multi-cluster-troubleshooting>

source/om-resources.txt

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -48,19 +48,18 @@ Deploy and Configure Ops Manager Resources
4848
Manually recover the |k8s-op-short| and |onprem| for an |onprem| resource with
4949
Multi-Cluster AppDB Deployments in the event that the |k8s| cluster fails.
5050

51-
.. class:: hidden
52-
53-
.. toctree::
54-
:titlesonly:
55-
56-
/tutorial/om-arch
57-
/tutorial/plan-om-resource
58-
/tutorial/deploy-om-container
59-
/tutorial/deploy-om-container-remote-mode
60-
/tutorial/deploy-om-container-local-mode
61-
/tutorial/upgrade-om-version
62-
/tutorial/configure-om-queryable-backups
63-
/tutorial/configure-kmip-backup-encryption
64-
/tutorial/configure-file-store
65-
/tutorial/cert-manager-integration
66-
/tutorial/recover-om-appdb-deployments
51+
.. toctree::
52+
:titlesonly:
53+
:hidden:
54+
55+
/tutorial/om-arch
56+
/tutorial/plan-om-resource
57+
/tutorial/deploy-om-container
58+
/tutorial/deploy-om-container-remote-mode
59+
/tutorial/deploy-om-container-local-mode
60+
/tutorial/upgrade-om-version
61+
/tutorial/configure-om-queryable-backups
62+
/tutorial/configure-kmip-backup-encryption
63+
/tutorial/configure-file-store
64+
/tutorial/cert-manager-integration
65+
/tutorial/recover-om-appdb-deployments

source/openshift-tutorials.txt

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,9 @@ This section contains the following:
1313
- :ref:`openshift-quick-start-ref`
1414
- :ref:`openshift-restricted-network-tutorial`
1515

16-
.. class:: hidden
16+
.. toctree::
17+
:titlesonly:
18+
:hidden:
1719

18-
.. toctree::
19-
:titlesonly:
20-
21-
Quick Start </openshift-quick-start>
22-
Deploy in Restricted Network Environment </tutorial/restricted-network-tutorial>
20+
Quick Start </openshift-quick-start>
21+
Deploy in Restricted Network Environment </tutorial/restricted-network-tutorial>

source/reference.txt

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,16 @@ Reference
3939
:ref:`third-party-licenses`
4040
Review the list of Open Source licenses that the |k8s-op-short| uses.
4141

42-
.. class:: hidden
43-
44-
.. toctree::
45-
:titlesonly:
46-
47-
/reference/k8s-operator-om-specification
48-
/reference/k8s-operator-mongodbuser-specification
49-
/reference/k8s-operator-specification
50-
/reference/k8s-operator-multi-cluster-specification
51-
/reference/operator-settings
52-
/reference/k8s-op-exclusive-settings
53-
/reference/support-lifecycle
54-
/third-party-integrations
55-
/third-party-licenses
42+
.. toctree::
43+
:titlesonly:
44+
:hidden:
45+
46+
/reference/k8s-operator-om-specification
47+
/reference/k8s-operator-mongodbuser-specification
48+
/reference/k8s-operator-specification
49+
/reference/k8s-operator-multi-cluster-specification
50+
/reference/operator-settings
51+
/reference/k8s-op-exclusive-settings
52+
/reference/support-lifecycle
53+
/third-party-integrations
54+
/third-party-licenses

source/reference/operator-settings.txt

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,9 @@ the environment to which you deploy the |k8s-op-short|.
1818
Review the settings that you can use when you install the
1919
|k8s-op-short| using Helm.
2020

21-
.. class:: hidden
21+
.. toctree::
22+
:titlesonly:
23+
:hidden:
2224

23-
.. toctree::
24-
:titlesonly:
25-
26-
Operator `kubectl` and `oc` Installation Settings </reference/kubectl-operator-settings>
27-
Operator Helm Installation Settings </reference/helm-operator-settings>
25+
Operator `kubectl` and `oc` Installation Settings </reference/kubectl-operator-settings>
26+
Operator Helm Installation Settings </reference/helm-operator-settings>

source/security.txt

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,12 @@ to secure your MongoDB deployments.
2929
:ref:`k8s-secret-storage`
3030
Use the secret storage tool to store sensitive information.
3131

32-
.. class:: hidden
33-
34-
.. toctree::
35-
:titlesonly:
36-
37-
/encryption
38-
/authentication
39-
/permissions
40-
/opa-gatekeeper
41-
/tutorial/secret-storage
32+
.. toctree::
33+
:titlesonly:
34+
:hidden:
35+
36+
/encryption
37+
/authentication
38+
/permissions
39+
/opa-gatekeeper
40+
/tutorial/secret-storage

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

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,11 @@ Secure Client Connections
2424
:ref:`multi-cluster-secure-internal-auth`
2525
Configure X.509 for internal authentication in |multi-clusters|.
2626

27-
.. class:: hidden
27+
.. toctree::
28+
:titlesonly:
29+
:hidden:
2830

29-
.. toctree::
30-
:titlesonly:
31-
32-
/tutorial/multi-cluster-secure-ldap-auth
33-
/tutorial/multi-cluster-secure-x509
34-
/tutorial/multi-cluster-secure-internal-auth
31+
/tutorial/multi-cluster-secure-ldap-auth
32+
/tutorial/multi-cluster-secure-x509
33+
/tutorial/multi-cluster-secure-internal-auth
3534

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

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,14 @@ resources.
5353
:ref:`k8s-prerequisites`
5454
Review the prerequisites before you install the |k8s-op-short|.
5555

56-
.. class:: hidden
57-
58-
.. toctree::
59-
:titlesonly:
60-
61-
Architecture </tutorial/plan-k8s-op-architecture>
62-
Compatibility </tutorial/plan-k8s-op-compatibility>
63-
Container Images </tutorial/plan-k8s-op-container-images>
64-
Single- or Multi-Kubernetes Clusters </tutorial/plan-k8s-install-single-or-multi-clusters>
65-
Set Deployment Scope </tutorial/set-scope-k8s-operator>
66-
/tutorial/plan-k8s-op-considerations
67-
/tutorial/plan-k8s-op-prerequisites
56+
.. toctree::
57+
:titlesonly:
58+
:hidden:
59+
60+
Architecture </tutorial/plan-k8s-op-architecture>
61+
Compatibility </tutorial/plan-k8s-op-compatibility>
62+
Container Images </tutorial/plan-k8s-op-container-images>
63+
Single- or Multi-Kubernetes Clusters </tutorial/plan-k8s-install-single-or-multi-clusters>
64+
Set Deployment Scope </tutorial/set-scope-k8s-operator>
65+
/tutorial/plan-k8s-op-considerations
66+
/tutorial/plan-k8s-op-prerequisites

0 commit comments

Comments
 (0)