Create a default profile source constant

Author: melissamahoney-mongodb

conf.py

@@ -57,6 +57,7 @@
 pygments_style = 'sphinx'
 
 source_constants = {
+    'default-profile': ':ref:`default profile <mcli-config-file>`',
     'version': version,
     'mcli': 'MongoDB CLI',
     'mcli-long': 'MongoDB Command Line Interface (``mongocli``)',

snooty.toml

@@ -1,6 +1,7 @@
 name = "mongocli"
 
 [constants]
+default-profile = ":ref:`default profile <mcli-config-file>`"
 mcli = "MongoDB CLI"
 mcli-long = "MongoDB Command Line Interface (``mongocli``)"
 mcli-version = "0.5.0"

source/includes/alert-describe-options.rst

@@ -16,7 +16,7 @@
      - string
      - Name of the profile where the public and private 
        keys for the project are saved. If omitted, uses the 
-       ``default`` profile. To learn more about creating a 
+       {+default-profile+}. To learn more about creating a 
        profile, see :ref:`mcli-configure`.
      - no
 
@@ -25,4 +25,4 @@
      - Unique identifier of the project that contains the 
        alert to describe. If omitted, uses the project ID in 
        the profile or :ref:`environment variable <mcli-env-var>`.
-     - yes
+     - yes

source/includes/alert-list-options.rst

@@ -22,7 +22,7 @@
      - string
      - Name of the profile where the public and private 
        keys for the project are saved. If omitted, uses the 
-       ``default`` profile. To learn more about creating a 
+       {+default-profile+}. To learn more about creating a 
        profile, see :ref:`mcli-configure`.
      - no
 
@@ -53,4 +53,4 @@
           * - ``CLOSED``
             - Alert is closed.
 
-     - no
+     - no

source/includes/alerts-ack-options.rst

@@ -37,10 +37,10 @@
 
    * - ``--profile``, ``-P``
      - string
-     - Name of the profile where the project ID and the |svc-api-key|\s
-       for the project are saved. If omitted, uses the ``default``
-       profile.
-
+     - Name of the profile where the project ID and the |svc-api-key|\s 
+       for the project are saved. If omitted, uses the
+       {+default-profile+}.
+       
        .. seealso::
 
           To learn more about creating a profile, see

source/includes/backup-checkpoints-options.rst

@@ -15,7 +15,7 @@
    * - ``--profile``, ``-P``
      - string
      - Name of the profile where the project ID and the |svc-api-key|\s 
-       for the project are saved. If omitted, uses the ``default`` profile. 
+       for the project are saved. If omitted, uses the {+default-profile+}. 
        To learn more about creating a profile, see :ref:`mcli-configure`.
      - no
 

source/includes/basic-options.rst

@@ -16,7 +16,7 @@
      - string
      - Name of the profile where the public and private 
        keys for the project are saved. If omitted, uses the 
-       ``default`` profile. To learn more about creating a 
+       {+default-profile+}. To learn more about creating a 
        profile, see :ref:`mcli-configure`.
      - no
 

source/includes/list-table-events-list-options.rst

@@ -10,7 +10,7 @@
    * - ``--profile``, ``-P``
      - string
      - Name of the profile where the project ID and the |svc-api-key|\s 
-       for the project are saved. If omitted, uses the ``default`` profile. 
+       for the project are saved. If omitted, uses the {+default-profile+}. 
        To learn more about creating a profile, see :ref:`mcli-configure`.
      - no
 

source/includes/measurements-disks-describe-options.rst

@@ -107,7 +107,7 @@
    * - ``--profile``, ``-P``
      - string
      - Name of the profile where the project ID and the |svc-api-key|\s 
-       for the project are saved. If omitted, uses the ``default`` profile. 
+       for the project are saved. If omitted, uses the {+default-profile+}. 
        To learn more about creating a profile, see :ref:`mcli-configure`.
      - no
 

source/includes/mms-backup-restore-start-options.rst

@@ -83,7 +83,7 @@
    * - ``--profile``, ``-P``
      - string
      - Name of the profile where the project ID and the |svc-api-key|\s 
-       for the project are saved. If omitted, uses the ``default`` profile. 
+       for the project are saved. If omitted, uses the {+default-profile+}. 
        To learn more about creating a profile, see :ref:`mcli-configure`.
      - no
 

source/includes/quick-start-intro.rst

@@ -2,7 +2,7 @@ You can configure {+mcli+} access to your MongoDB service using
 the :ref:`mcli-config-command` and :ref:`mcli-config-set-command`
 commands. In the following steps, the commands:
 
-- Create the ``default`` profile in the
+- Create the {+default-profile+} in the
   :ref:`configuration file <mcli-config-file>`.
 - Set your programmatic |api| access keys and project ID in the
   profile.

source/includes/steps-configure-mcli.yaml

@@ -96,7 +96,7 @@ content: |
               cat ~/.config/mongocli.toml
           
            The command returns the contents of the configuration file,
-           which contains the ``default`` profile. The ``default``
+           which contains the {+default-profile+}. The ``default``
            profile has a |svc-api-key| and project ID for an {{service}}
            deployment.
 

source/reference/atlas/alerts-configs-create.txt

@@ -289,7 +289,7 @@ Examples
 
 The following example uses the ``mongocli atlas alerts configs create``
 command to create one alert configuration the specified
-project. It uses the default profile to access the
+project. It uses the {+default-profile+} to access the
 |service| project.
 
 .. code-block:: text

source/reference/atlas/alerts-configs-delete.txt

@@ -64,7 +64,7 @@ Options
      - string
      - Name of the profile where the public and private 
        keys for the project are saved. If omitted, uses the 
-       ``default`` profile. To learn more about creating a 
+       {+default-profile+}. To learn more about creating a 
        profile, see :ref:`mcli-configure`.
      - no
 
@@ -109,7 +109,7 @@ Basic Example
 
 The following ``alerts configs delete`` command deletes 
 an alert configuration with the ID ``5ec4518ce4a7ba70e03dbf13`` after
-prompting for a confirmation. The command uses the default profile.
+prompting for a confirmation. The command uses the {+default-profile+}.
 
 .. code-block:: text
    :copyable: false
@@ -129,7 +129,7 @@ Force Example
 
 The following ``alerts configs delete`` command deletes 
 an alert configuration with the ID ``5ec4518ce4a7ba70e03dbf13`` without
-requiring confirmation. The command uses the default profile.
+requiring confirmation. The command uses the {+default-profile+}.
 
 .. code-block:: text
    :copyable: false

source/reference/atlas/alerts-configs-update.txt

@@ -294,7 +294,7 @@ Examples
 
 The following example uses the ``mongocli atlas alerts configs update``
 command to update one alert configuration the specified
-project. It uses the default profile to access the
+project. It uses the {+default-profile+} to access the
 |service| project.
 
 .. code-block:: text

source/reference/atlas/alerts-describe.txt

@@ -52,7 +52,7 @@ Example
 
 The following example uses the ``mongocli atlas describe`` command 
 to describe one alert that occurred for the specified project. It uses 
-the default profile to access |service|.
+the {+default-profile+} to access |service|.
 
 .. code-block:: text
 

source/reference/atlas/backup-checkpoints-list.txt

@@ -52,7 +52,7 @@ Options
    * - ``--profile``, ``-P``
      - string
      - Name of the profile where the project ID and the |svc-api-key|\s 
-       for the project are saved. If omitted, uses the ``default`` profile. 
+       for the project are saved. If omitted, uses the {+default-profile+}. 
        To learn more about creating a profile, see :ref:`mcli-configure`.
      - no
 
@@ -81,7 +81,7 @@ Example
 
 The following example uses the ``mongocli atlas backup checkpoints
 list`` command to retrieve the list of snapshots for the cluster named
-``myDemo``. The command uses the default profile where the project ID and the |svc-api-key|\s are stored.
+``myDemo``. The command uses the {+default-profile+} where the project ID and the |svc-api-key|\s are stored.
 
 .. code-block:: json
 

source/reference/atlas/backup-restore-list.txt

@@ -62,7 +62,7 @@ Options
    * - ``--profile``, ``-P``
      - string
      - Name of the profile where the project ID and the |svc-api-key|\s 
-       for the project are saved. If omitted, uses the ``default`` profile. 
+       for the project are saved. If omitted, uses the {+default-profile+}. 
        To learn more about creating a profile, see :ref:`mcli-configure`.
      - no
 
@@ -135,7 +135,7 @@ Automated Restore Example
 
 The following example uses the ``mongocli atlas backup restore list``
 command to retrieve the Coninuous Backup restore jobs for the cluster
-``Cluster0``. The command uses the default profile.
+``Cluster0``. The command uses the {+default-profile+}.
 
 .. code-block:: json 
 

source/reference/atlas/backup-restore-start.txt

@@ -137,7 +137,7 @@ Options
    * - ``--profile``, ``-P``
      - string
      - Name of the profile where the project ID and the |svc-api-key|\s 
-       for the project are saved. If omitted, uses the ``default`` profile. 
+       for the project are saved. If omitted, uses the {+default-profile+}. 
        To learn more about creating a profile, see :ref:`mcli-configure`.
      - no
 
@@ -205,7 +205,7 @@ Automated Restore Example
 The following example uses the ``mongocli atlas backup restore start 
 AUTOMATED_RESTORE`` command to restore a deployment, which is specified using 
 the ``targetProjectId`` and ``targetClusterId`` fields. The command uses the 
-default profile where the project ID and the |svc-api-key|\s 
+{+default-profile+} where the project ID and the |svc-api-key|\s 
 for the source cluster are stored.
 
 .. code-block:: json 

source/reference/atlas/backup-snapshots-list.txt

@@ -55,7 +55,7 @@ Options
    * - ``--profile``, ``-P``
      - string
      - Name of the profile where the project ID and the |svc-api-key|\s 
-       for the project are saved. If omitted, uses the ``default`` profile. 
+       for the project are saved. If omitted, uses the {+default-profile+}. 
        To learn more about creating a profile, see :ref:`mcli-configure`.
      - no
 
@@ -84,7 +84,7 @@ Example
 
 The following example uses the ``mongocli atlas backup snapshots list`` command 
 to retrieve the list of snapshots for the cluster named ``myDemo``. The 
-command uses the default profile, where the project ID and the 
+command uses the {+default-profile+}, where the project ID and the 
 |svc-api-key|\s are stored.
 
 .. code-block:: json 

source/reference/atlas/cluster-create.txt

@@ -147,9 +147,9 @@ Options
 
    * - ``--profile``, ``-P``
      - string
-     - Name of the profile where the public and private
-       keys for the project are set. If omitted, uses the
-       ``default`` profile. To learn more about creating a
+     - Name of the profile where the public and private 
+       keys for the project are set. If omitted, uses the 
+       {+default-profile+}. To learn more about creating a 
        profile, see :ref:`mcli-configure`.
      - no
 

source/reference/atlas/cluster-delete.txt

@@ -129,7 +129,7 @@ Example 2
 
 The following ``mongocli atlas cluster delete`` command deletes 
 a cluster named ``myCluster`` without requiring confirmation. 
-It uses the ``default`` profile for accessing the |service| 
+It uses the {+default-profile+} for accessing the |service| 
 project.
 
 .. code-block:: text

source/reference/atlas/cluster-describe.txt

@@ -55,7 +55,7 @@ Options
      - string
      - Name of the profile where the public and private 
        keys for the project are set. If omitted, uses the 
-       ``default`` profile. To learn more about creating a 
+       {+default-profile+}. To learn more about creating a 
        profile, see :ref:`mcli-configure`.
      - no
 
@@ -84,7 +84,7 @@ Examples
 
 The following example uses the ``mongocli atlas cluster describe`` 
 command to retrieve details about a cluster named ``myCluster``. 
-It uses the ``default`` profile to access the |service| project 
+It uses the {+default-profile+} to access the |service| project 
 that contains the cluster.
 
 .. code-block:: text

source/reference/atlas/cluster-list.txt

@@ -50,7 +50,7 @@ Options
      - string
      - Name of the profile where the public and private 
        keys for the project are saved. If omitted, uses the 
-       ``default`` profile. To learn more about creating a 
+       {+default-profile+}. To learn more about creating a 
        profile, see :ref:`mcli-configure`.
      - no
 
@@ -80,7 +80,7 @@ Examples
 
 The following example uses the ``mongocli atlas cluster list`` command 
 to retrieve the list of clusters in the specified project. It 
-uses the ``default`` profile to access the project.
+uses the {+default-profile+} to access the project.
 
 .. code-block:: text
    :copyable: false

source/reference/atlas/cluster-pause.txt

@@ -54,7 +54,7 @@ Options
      - string
      - Name of the profile where the public and private 
        keys for the project are set. If omitted, uses the 
-       ``default`` profile. To learn more about creating a 
+       {+default-profile+}. To learn more about creating a 
        profile, see :ref:`mcli-configure`.
      - no
 
@@ -80,7 +80,7 @@ Example
 -------
 
 The following ``mongocli atlas cluster pause`` command pauses a sample
-cluster named ``myCluster``. The command uses the default profile. 
+cluster named ``myCluster``. The command uses the {+default-profile+}. 
 
 .. code-block:: text
    :copyable: false

source/reference/atlas/cluster-start.txt

@@ -54,7 +54,7 @@ Options
      - string
      - Name of the profile where the public and private 
        keys for the project are set. If omitted, uses the 
-       ``default`` profile. To learn more about creating a 
+       {+default-profile+}. To learn more about creating a 
        profile, see :ref:`mcli-configure`.
      - no
 
@@ -80,7 +80,7 @@ Example
 -------
 
 The following ``mongocli atlas cluster start`` command starts a sample
-cluster named ``myCluster``. The command uses the default profile. 
+cluster named ``myCluster``. The command uses the {+default-profile+}. 
 
 .. code-block:: text
    :copyable: false

source/reference/atlas/cluster-update.txt

@@ -94,8 +94,8 @@ Options
 
    * - ``--profile``, ``-P``
      - string
-     - Name of the profile to use for accessing the |service| project.
-       If omitted, uses the ``default`` profile.
+     - Name of the profile to use for accessing the |service| 
+       project. If omitted, uses the {+default-profile+}.
      - no
 
    * - ``--projectId``
@@ -124,7 +124,7 @@ Example 1
 
 The following ``mongocli atlas cluster update`` command migrates the
 cluster named ``sbxCluster`` in the specified project from ``M10`` to
-``M20``. It uses the default profile to access the project.
+``M20``. It uses the {+default-profile+} to access the project.
 
 .. code-block:: sh
    :copyable: false

source/reference/atlas/clusters-indexes-create.txt

@@ -93,7 +93,7 @@ Options
      - string
      - Name of the profile where the public and private 
        keys for the project are set. If omitted, uses the 
-       ``default`` profile. To learn more about creating a 
+       {+default-profile+}. To learn more about creating a 
        profile, see :ref:`mcli-configure`.
      - no
 
@@ -171,7 +171,7 @@ Example 1
 
 The following ``mongocli atlas clusters indexes create`` command creates
 an index named ``bedrooms_1`` on the ``listings`` collection
-of the ``realestate`` database. The command uses the default profile.
+of the ``realestate`` database. The command uses the {+default-profile+}.
 
 .. code-block:: text
    :copyable: false
@@ -191,7 +191,7 @@ Example 2
 The following ``mongocli atlas clusters indexes create`` command creates
 a compound index named ``property_room_bedrooms`` on the
 ``listings`` collection of the ``realestate`` database. The
-command uses the default profile.
+command uses the {+default-profile+}.
 
 .. code-block:: text
    :copyable: false