DOCSP-11017 doc for config describe command (#130)

* DOCSP-11017 doc for config describe command

DOCSP-11017 self-review

DOCSP-11017 self-review changes

* Update source/reference/config/config-describe.txt

Co-authored-by: Melissa Mahoney <[email protected]>

* Update source/reference/config/config-describe.txt

Co-authored-by: Melissa Mahoney <[email protected]>

* Update source/reference/config/config-describe.txt

Co-authored-by: Melissa Mahoney <[email protected]>

* DOCSP-11017 updates for copy review feedback

* DOCSP-11017 doc update for review feedback

Co-authored-by: Melissa Mahoney <[email protected]>

Author: kanchana-mongodb

source/includes/steps-configure-mcli.yaml

@@ -72,8 +72,8 @@ level: 4
 ref: verify-profile
 content: |
 
-  View the :ref:`configuration file <mcli-config-file>` to verify your
-  profile.
+  View the :ref:`configuration file <mcli-config-file>` or run the 
+  :ref:`mcli-config-describe-command` command to verify your profile.
 
   .. include:: /includes/admonitions/secure-config-file.rst
 
@@ -85,55 +85,50 @@ content: |
 
         .. example::
 
-           In this example, the configuration file is stored in the
-           ``/.config`` folder of the home directory. View the file
-           using the ``cat`` command:
+           In this example, the following command returns the settings 
+           in the {+default-profile+}:
 
            .. code-block:: sh
               :copyable: false
 
-              cat ~/.config/mongocli.toml
+              mongocli config describe default
           
-           The command returns the contents of the configuration file,
-           which contains the {+default-profile+}. The
-           {+default-profile+} has a |svc-api-key| and project ID for an
-           {{service}} deployment.
+           The command returns the following settings. The {+default-profile+} 
+           has a |svc-api-key|, which is redacted in the command output for 
+           security purposes, and project ID for an {{service}} deployment. 
 
            .. code-block:: sh
               :copyable: false
               
-              [default]
-              private_api_key = "abcdef"
-              public_api_key = "d5199648-abcd-1234-efgh-3ed4396a3096"
-              project_id = "7ehf04abc10defb66c7d1234c"
-              service = "{{serviceName}}"
+              private_api_key = redacted
+              public_api_key = redacted
+              project_id = 7ehf04abc10defb66c7d1234c
+              service = {{serviceName}}
 
      .. tab:: Named Profile
         :tabid: named-profile
         
         .. example::
 
-           In this example, the configuration file is stored in the
-           ``/.config`` folder of your home directory. View the file
-           using the ``cat`` command:
+           In this example, the following command returns the settings 
+           in the profile named ``myMongoDB``:
 
            .. code-block:: sh
               :copyable: false
 
-              cat ~/.config/mongocli.toml
+              mongocli config describe myMongoDB
           
-           The command returns the contents of the configuration file,
-           which contains a profile named ``myMongoDB``. The
-           ``myMongoDB`` profile has a |svc-api-key| and project ID for
-           an {{service}} deployment.
+           The command returns following settings. The ``myMongoDB`` profile 
+           has a |svc-api-key|, which is redacted in the command output for 
+           security purposes, and project ID for an {{service}} deployment.
 
            .. code-block:: sh
               :copyable: false
               
-              [myMongoDB]
-              private_api_key = "abcdef"
-              public_api_key = "d5199648-abcd-1234-efgh-3ed4396a3096"
-              project_id = "7ehf04abc10defb66c7d1234c"
-              service = "{{serviceName}}"
+              private_api_key = redacted
+              public_api_key = redacted
+              project_id = 7ehf04abc10defb66c7d1234c
+              service = {{serviceName}}
+
 
 ...

source/reference/config/config-describe.txt

@@ -0,0 +1,92 @@
+.. _mcli-config-describe-command:
+
+========================
+mongocli config describe
+========================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+The ``config describe`` command retrieves details about the 
+specified profile from the :ref:`mcli-config-file`. 
+
+.. seealso:: :ref:`mcli-configure`
+
+.. _mcli-config-describe-syntax:
+
+Syntax 
+------
+
+.. code-block:: sh 
+
+   mongocli config describe <profile-name>
+
+.. _mcli-config-describe-options:
+
+Arguments  
+---------
+
+.. list-table:: 
+   :header-rows: 1
+   :widths: 20 10 60 10 
+
+   * - Argument 
+     - Type 
+     - Description 
+     - Required? 
+
+   * - ``<profile-name>``
+     - string
+     - Name of the profile to retrieve. Specify ``default`` to 
+       retrieve the {+default-profile+}.
+     - yes
+
+.. _mcli-config-describe-output:
+
+Output 
+------
+
+The command output looks similar to the following if the command 
+succeeds. If the command prints errors, see :ref:`troubleshooting` 
+for recommended solutions.
+
+.. code-block:: sh 
+   :copyable: false
+
+   public_api_key = redacted
+   service = <service-name>
+   ops_manager_url = <OM-URL>
+   private_api_key = redacted
+   project_id = <project-ID>
+
+.. note:: 
+
+   The |svc-api-key|\s are redacted for security purposes.
+
+.. _mcli-config-describe-egs:
+
+Example 
+-------
+
+The following example uses the ``mongocli config describe`` command 
+to retrieve a profile named ``egOmProfile``  from the configuration file.
+
+.. code-block:: sh
+
+   mongocli config describe egOmProfile 
+
+The preceding command prints the following output to the terminal: 
+
+.. code-block:: sh
+   :copyable: false 
+
+   public_api_key = redacted
+   service = ops-manager
+   ops_manager_url = http://localhost:30700
+   private_api_key = redacted
+   project_id = 5e84b2edf949e9007a7beac3

source/reference/configuration.txt

@@ -20,6 +20,7 @@ including |service-fullname|, |cloud|, and |mms-full|.
 
 - :ref:`Create a configuration file <mcli-config-command>`
 - :ref:`Update a configuration file <mcli-config-set-command>`
+- :ref:`Retrieve a profile from the configuration file <mcli-config-describe-command>`
 
 .. class:: hidden
 
@@ -28,3 +29,4 @@ including |service-fullname|, |cloud|, and |mms-full|.
 
       Create a Configuration File </reference/config>
       Update a Configuration File </reference/mcli-config-set>
+      Retrieve a Profile </reference/config/config-describe>