(DOCSP-35988) Fixing RST for steps that should not be bolded (#58)

JuliaMongo · web-flow · commit 3f945a95e695 · 2024-01-30T09:57:25.000-05:00
[DOCSP-35988](https://jira.mongodb.org/browse/DOCSP-35988) [Staging](https://preview-mongodbjuliamongo.gatsbyjs.io/ops-manager/DOCSP-35988/tutorial/nav/k8s-config-for-mdb-resource/#navigate-to-the-k8s-setup-page-in-the-mms-ui) Added headings and reorganized the page to make the bolded step titles display normally. All other changes are incidental edits and cleanup and don't need to be reviewed. Latest [build](https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=65b90cfe6b2f17c95ad22afc)
diff --git a/source/includes/setting-fileConf-kubernetes.templates.credentialsFilePath.rst b/source/includes/setting-fileConf-kubernetes.templates.credentialsFilePath.rst
@@ -2,17 +2,14 @@
 
    *Type*: string
 
-   
    Path to the YAML file that contains your :ref:`Programmatic API Key 
-   <mms-prog-api-key>` as a Kubernetes secret to create or update 
-   Kubernetes `objects <https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/>`__ 
-   in your |mms| project.
-   
-   This file must be in YAML format and must be stored under 
-   ``/mongodb-ops-manager/`` directory. 
-   
+   <mms-prog-api-key>` as a |k8s| secret to create or update |k8s-objs|
+   in your |mms| project. This file must be in YAML format and must be
+   stored under the ``/mongodb-ops-manager/`` directory. This file
+   corresponds to :setting:`Kubernetes Secret Setup`.
+
    .. code-block:: yaml
-   
+
       apiVersion: v1
       kind: Secret
       metadata:
@@ -21,7 +18,3 @@
       stringData:
         user: ${publicKey}
         publicApiKey: ${privateKey}
-   
-   Corresponds to :setting:`Kubernetes Secret Setup`.
-   
-
diff --git a/source/includes/setting-fileConf-kubernetes.templates.projectFilePath.rst b/source/includes/setting-fileConf-kubernetes.templates.projectFilePath.rst
@@ -2,13 +2,8 @@
 
    *Type*: string
 
-   
-   Path to the YAML file that contains the ConfigMap to use to link to 
-   your |mms| project.
-   
-   This file must be in YAML format and must be stored under 
-   ``/mongodb-ops-manager/`` directory. 
-   
-   Corresponds to :setting:`Kubernetes ConfigMap Setup`.
-   
+   Path to the YAML file that contains the ConfigMap to use to link to your
+   |mms| project. This file must be in YAML format and must be stored under
+   the ``/mongodb-ops-manager/`` directory. This file corresponds to
+   :setting:`Kubernetes ConfigMap Setup`.
 
diff --git a/source/includes/steps-k8s-setup-custom-ca.yaml b/source/includes/steps-k8s-setup-custom-ca.yaml
@@ -23,10 +23,19 @@ content: |
   In your server's ``conf-mms.properties`` file, configure the 
   following settings:
 
-  - ``kubernetes.templates.credentialsFilePath``
-  - ``kubernetes.templates.projectFilePath``
+  - ``kubernetes.templates.credentialsFilePath``. Path to the YAML file
+    that contains the ConfigMap to use to link to your |mms| project.
+    This file must be in YAML format and must be stored under the
+    ``/mongodb-ops-manager/`` directory. The file corresponds to
+    :setting:`Kubernetes ConfigMap Setup`.
 
-  To learn more about these settings, see 
-  :ref:`conf-mms.properties-k8s`.
+  - ``kubernetes.templates.projectFilePath``. Path to the YAML file that
+    contains your :ref:`Programmatic API Key <mms-prog-api-key>` as a
+    |k8s| secret to create or update |k8s-objs| in your |mms| project.
+    This file must be in YAML format and must be stored under the
+    ``/mongodb-ops-manager/`` directory. The file corresponds to
+    :setting:`Kubernetes Secret Setup`.
+
+  To learn more, see :ref:`conf-mms.properties-k8s`.
 
 ...
diff --git a/source/includes/steps-k8s-setup-nav-global-org-owner.yaml b/source/includes/steps-k8s-setup-nav-global-org-owner.yaml
@@ -1,11 +1,15 @@
-title: "Log in to |mms| and select your desired organization from the 
+title: "Log in to |mms| and select your organization from the
        :icon-mms:`office` :guilabel:`Organizations` menu in the
        navigation bar."
 level: 4
+stepnum: 1
 ref: select-org-k8s-setup
+
 ---
-title: "Click :guilabel:`Kubernetes Setup` in the sidebar, or click
-       :guilabel:`Kubernetes Setup` in the navigation bar."
+
+title: "Click :guilabel:`Kubernetes Setup` in the sidebar or the
+       navigation bar."
 level: 4
+stepnum: 2
 ref: select-k8s-setup-org
 ...
diff --git a/source/includes/steps-k8s-setup-nav.yaml b/source/includes/steps-k8s-setup-nav.yaml
@@ -1,16 +1,21 @@
-title: "Log in to |mms| and select the organization that contains your 
-       desired project from the |ui-org-menu| in the navigation bar."
+title: "Log in to |mms| and select the organization that contains your
+       project from the |ui-org-menu| in the navigation bar."
 level: 4
+stepnum: 1
 ref: k8s-setup-login
 ---
-title: "Select your desired project from the :guilabel:`Project` menu 
-       in the navigation bar."
+
+title: "Select your project from the :guilabel:`Project` menu in the
+       navigation bar."
 level: 4
+stepnum: 2
 ref: select-project-k8s-setup
 ---
-title: "Click the :guilabel:`Add` dropdown and select 
-       :guilabel:`Prepare Kubernetes Configuration` to display the 
+
+title: "Click the :guilabel:`Add` dropdown and select
+       :guilabel:`Prepare Kubernetes Configuration` to display the
        :guilabel:`Kubernetes Setup` page."
 level: 4
+stepnum: 3
 ref: select-k8s-setup
 ...
diff --git a/source/includes/steps-k8s-setup.yaml b/source/includes/steps-k8s-setup.yaml
@@ -6,11 +6,12 @@ content: |
   - Click :guilabel:`Create New API Keys` to generate new API keys.
   - Click :guilabel:`Use Existing API Keys` to specify your existing 
     public and private keys.
+
 ---
 title: "Enter the IP addresses to add to your |mms| project's IP access 
        list to grant programmatic access from your Kubernetes 
        environment."
-level: 4 
+level: 4
 ref: k8s-setup-step2
 content: |
 
@@ -29,6 +30,7 @@ content: |
     API keys.
   - Click :guilabel:`Generate YAML` if you are using existing API keys.
 ---
+
 title: "Follow the steps in the :guilabel:`Generated ConfigMap and 
        Secret YAML file` modal to apply the generated ConfigMap and 
        Kubernetes secret YAML files to your Kubernetes environment."
diff --git a/source/tutorial/nav/k8s-config-for-mdb-resource.txt b/source/tutorial/nav/k8s-config-for-mdb-resource.txt
@@ -12,64 +12,45 @@ Configure Kubernetes for Deploying MongoDB Resource
    :depth: 1
    :class: singlecol
 
-You can use the Kubernetes Operator to deploy MongoDB resources such as 
+You can use the |k8s-op-full| to deploy MongoDB resources such as 
 :k8s:`a replica set </tutorial/deploy-replica-set>`, :k8s:`a sharded 
 cluster </tutorial/deploy-sharded-cluster>`, or :k8s:`a standalone 
-instance </tutorial/deploy-standalone>` using an `object 
-<https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/>`__. 
-|mms| can generate the YAML files you need to configure your Kubernetes 
-environment for deploying a MongoDB Database resource. 
+instance </tutorial/deploy-standalone>` using an |k8s-obj|. 
+|mms| can generate the YAML files you need to configure your |k8s|
+environment for deploying a MongoDB Database resource.
 
 To generate the YAML files:
 
 - :ref:`k8s-config-mdb-res-roles`
-- :ref:`k8s-config-mdb-res-nav`
+- :ref:`Learn about the MongoDB Resource in Kubernetes <k8s-config-mdb-res-nav>`
 - :ref:`k8s-config-mdb-res-create-procedure`
 
 .. _k8s-config-mdb-res-roles:
 
-Verify Permissions 
+Verify Permissions
 ------------------
 
 You must have one of the following roles to access the |mms| UI for 
-setting up Kubernetes: 
+setting up |k8s|:
 
 - :authrole:`Organization Owner`
 - :authrole:`Project Owner`
 - :authrole:`Project Data Access Admin`
 
-.. _k8s-config-mdb-res-nav:
-
-Navigate to the Kubernetes Setup Page in the |mms| UI 
------------------------------------------------------
-
-To access the :guilabel:`Kubernetes Setup` page in the |mms| UI: 
-
-.. include:: /includes/steps/k8s-setup-nav.rst 
-
-If you are a :authrole:`Global Owner` or :authrole:`Organization 
-Owner`, you can access the Kubernetes Setup page in the |mms| UI 
-by doing the following also: 
-
-.. include:: /includes/steps/k8s-setup-nav-global-org-owner.rst 
-
 .. _k8s-config-mdb-res-create-procedure:
 
-Set Up Kubernetes for a MongoDB Resource
+Overview of MongoDB Resource in |k8s|
 ----------------------------------------
 
-The |k8s-op-full| requires a Kubernetes ConfigMap to create or link 
-your |mms| project. 
+To create or link your |mms| project, the |k8s-op-full| requires that you
+configure a |k8s| ConfigMap. Using the |k8s| ConfigMap, you can:
 
-.. cond::  onprem
+- Connect to a HTTPS-enabled |mms| that is using a custom |certauth|, or
+- Link to a |mms| project that isn't using a custom |certauth|.
 
-   Using the Kubernetes ConfigMap, you can either connect to a 
-   HTTPS-enabled |mms| that is using a custom CA or link to a |mms| 
-   project that isn't using a custom CA. 
-
-You can use the |mms| :guilabel:`Kubernetes Setup` page to 
-automatically generate the ConfigMap. The generated YAML file for the 
-ConfigMap looks similar to the following: 
+You can use the |mms| :guilabel:`Kubernetes Setup` page to automatically
+generate the ConfigMap. The generated YAML file for the ConfigMap looks
+similar to the following: 
 
 .. tabs:: 
 
@@ -92,7 +73,7 @@ ConfigMap looks similar to the following:
            orgId: <your-org-id>
 
            sslMMSCAConfigMap: <root-ca-configmap-name>
-           sslRequireValidMMSServerCertificates: ‘true’
+           sslRequireValidMMSServerCertificates: 'true'
 
    .. tab:: Not Using a Custom CA 
       :tabid: link 
@@ -112,25 +93,51 @@ ConfigMap looks similar to the following:
 
            orgId: <your-org-id>
 
-You need to store your :ref:`Programmatic API Key <mms-prog-api-key>` 
-as a Kubernetes secret to create or update Kubernetes `objects 
-<https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/>`__ 
-in your |mms| project. A Kubernetes secret stores authentication 
-credentials so only Kubernetes can access them. 
+To create or update |k8s-objs| in your |mms| project, configure your
+:ref:`Programmatic API Key <mms-prog-api-key>` as a |k8s| secret.
+The secret stores authentication credentials so only |k8s| can access them.
+
+The following procedures provide the detailed steps.
+
+.. _k8s-config-mdb-res-procedure:
+
+Procedures
+------------
+
+- :ref:`k8s-config-mdb-res-nav`
+- :ref:`k8s-setup-custom-ca-configmap-om-settings`
+- :ref:`k8s-generate-yaml`
+
+.. _k8s-config-mdb-res-nav:
+
+Navigate to the |k8s| Setup Page in the |mms| UI
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To access the :guilabel:`Kubernetes Setup` page in the |mms| UI: 
+
+.. include:: /includes/steps/k8s-setup-nav.rst 
+
+If you are a :authrole:`Global Owner` or :authrole:`Organization 
+Owner`, you can also access the :guilabel:`Kubernetes Setup` page in
+the |mms| UI by following these steps:
+
+.. include:: /includes/steps/k8s-setup-nav-global-org-owner.rst 
+
+.. _k8s-setup-custom-ca-configmap-om-settings:
 
-Setting up Template files and Configuration Parameters
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Create a Secret, a ConfigMap, and |onprem| Settings for |k8s|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To generate the YAML files, you must do the following: 
+To create a secret, a ConfigMap file, and |onprem| settings for |k8s|:
 
 .. include:: /includes/steps/k8s-setup-custom-ca.rst
 
-.. _k8s-config-mdb-res-procedure:
+.. _k8s-generate-yaml:
 
-Generating the YAML Files  
-~~~~~~~~~~~~~~~~~~~~~~~~~
+Generate the ConfigMap YAML Files
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To setup Kubernetes for a MongoDB resource:
+To generate the |k8s| configuration files for a MongoDB resource:
 
 .. tabs:: 
 
