Skip to content

Commit 0678b3b

Browse files
Cleanup, replace more default profile source constants
1 parent a27cb2d commit 0678b3b

29 files changed

+37
-64
lines changed

source/configure/configuration-file.txt

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ the file. The {+mcli+} saves the configuration file to the folder where
2626
your system stores application configuration files, which is defined by
2727
the ``$XDG_CONFIG_HOME`` environment variable. By default, this location
2828
is the ``/.config`` folder of your home directory. If this folder
29-
doesn't exist, the {+mcli+} creates the folder and grants you read,
29+
doesn't exist, the {+mcli+} creates the folder and grants the user read,
3030
write, and execute permissions.
3131

3232
.. _mcli-profiles:
@@ -38,9 +38,7 @@ The {+mcli+} configuration file stores related settings and
3838
|api| keys in groups called *profiles*. You can create or define multiple profiles so that you can use the {+mcli+} to access different MongoDB services or projects from the same terminal.
3939

4040
The {+mcli+} uses the ``default`` profile by default. To run {+mcli+}
41-
commands without the ``--profile`` flag, you must use a profile named
42-
``default``. To use a profile with any other name, you must specify the
43-
``--profile`` flag for every command.
41+
commands without the ``--profile`` flag, you must configure a profile named ``default``. To use a profile with any other name, you must specify that profile with the ``--profile`` flag in every command.
4442

4543
Example
4644
-------

source/includes/steps-configure-mcli-atlas.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ source:
1010
file: steps-configure-mcli.yaml
1111
ref: enter-api-key
1212
replacement:
13+
apiKeys: ":atlas:`Programmatic API Key </configure-api-access>`"
1314
service: "|service|"
1415
---
1516
stepnum: 3

source/includes/steps-configure-mcli-cm.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ source:
1010
file: steps-configure-mcli.yaml
1111
ref: enter-api-key
1212
replacement:
13+
apiKeys: ":cloudmgr:`Cloud Manager API Access </tutorial/configure-public-api-access>`"
1314
service: "|cloud|"
1415
---
1516
stepnum: 3

source/includes/steps-configure-mcli-om.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ source:
1515
file: steps-configure-mcli.yaml
1616
ref: enter-api-key
1717
replacement:
18+
apiKeys: ":opsmgr:`Ops Manager API Acess </tutorial/configure-public-api-access>`"
1819
service: "|onprem|"
1920
---
2021
stepnum: 4

source/includes/steps-configure-mcli.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,8 @@ content: |
2323
:tabid: named-profile
2424
2525
This command creates a profile with a custom name in the
26-
:ref:`mcli-config-file`. To use this profile im subsequent
27-
{+mcli+} commands, you must run the commands with the
28-
``--profile`` flag.
26+
:ref:`mcli-config-file`. To use this profile, you must specify
27+
it with the ``--profile`` flag in every command.
2928
3029
Run the :ref:`mcli-config-command` command:
3130
@@ -47,7 +46,7 @@ content: |
4746
? Ops Manager Base URL: http://mms.example.com:8080
4847
4948
---
50-
title: "Enter your |svc-api-key| and Project ID."
49+
title: "Enter your {{apiKeys}} and Project ID."
5150
stepnum: 0
5251
level: 4
5352
ref: enter-api-key
@@ -73,7 +72,8 @@ level: 4
7372
ref: verify-profile
7473
content: |
7574
76-
View the ``mongocli.toml`` configuration file to verify your profile.
75+
View the :ref:`configuration file <mcli-config-file>` to verify your
76+
profile.
7777
7878
.. include:: /includes/admonitions/secure-config-file.rst
7979
@@ -86,7 +86,7 @@ content: |
8686
.. example::
8787
8888
In this example, the configuration file is stored in the
89-
``/.config`` folder of your home directory. View the file
89+
``/.config`` folder of the home directory. View the file
9090
using the ``cat`` command:
9191
9292
.. code-block:: sh

source/quick-start.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,8 +229,9 @@ To learn more about generating the |svc-api-key|, see:
229229

230230
.. include:: /includes/quick-start-summary.rst
231231

232-
You can use the |mongo| shell connect to your cluster with the
233-
``srvAddress`` and appropriate :manual:`connection string options
232+
You can also use the |mongo| shell connect to your cluster with
233+
the ``srvAddress`` and appropriate :manual:`connection string
234+
options
234235
</reference/connection-string/#connection-string-options>`.
235236

236237
.. tab:: Cloud Manager

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -259,8 +259,7 @@ Options
259259
* - ``--profile``, ``-P``
260260
- string
261261
- Name of the profile where the public and private
262-
keys for the project are saved. If omitted, uses the ``default``
263-
profile. To learn more about creating a
262+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
264263
profile, see :ref:`mcli-configure`.
265264
- no
266265

source/reference/atlas/alerts-configs-fields-type.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,7 @@ Options
4747
* - ``--profile``, ``-P``
4848
- string
4949
- Name of the profile where the public and private
50-
keys for the project are saved. If omitted, uses the ``default``
51-
profile. To learn more about creating a
50+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
5251
profile, see :ref:`mcli-configure`.
5352
- no
5453

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -264,8 +264,7 @@ Options
264264
* - ``--profile``, ``-P``
265265
- string
266266
- Name of the profile where the public and private
267-
keys for the project are saved. If omitted, uses the ``default``
268-
profile. To learn more about creating a
267+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
269268
profile, see :ref:`mcli-configure`.
270269
- no
271270

source/reference/atlas/cluster-delete.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,7 @@ Options
7070
* - ``--profile``, ``-P``
7171
- string
7272
- Name of the profile to use for accessing the
73-
|service| project. If omitted, uses the ``default``
74-
profile.
73+
|service| project. If omitted, uses the {+default-profile+}.
7574
- no
7675

7776
* - ``--projectId``

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,7 @@ Options
4848
* - ``--profile``, ``-P``
4949
- string
5050
- Name of the profile where the public and private
51-
keys for the project are saved. If omitted, uses the ``default``
52-
profile. To learn more about creating a
51+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
5352
profile, see :ref:`mcli-configure`.
5453
- no
5554

source/reference/atlas/logs-download.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,7 @@ Examples
135135

136136
The following example uses the ``mongocli atlas logs download`` command
137137
to download the ``mongodb`` logs from host
138-
``atlas-123abc-shard-00-00.111xx.mongodb.net``. It uses the ``default``
139-
profile to access the project.
138+
``atlas-123abc-shard-00-00.111xx.mongodb.net``. It uses the {+default-profile+} to access the project.
140139

141140
.. code-block:: text
142141
:copyable: false

source/reference/atlas/whitelist-delete.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,7 @@ Options
6363
* - ``--profile``, ``-P``
6464
- string
6565
- Name of the profile to use for accessing the
66-
|service| project. If omitted, uses the ``default``
67-
profile.
66+
|service| project. If omitted, uses the {+default-profile+}.
6867
- no
6968

7069
* - ``--projectId``

source/reference/cloud-manager/alerts-configs-create.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -259,8 +259,7 @@ Options
259259
* - ``--profile``, ``-P``
260260
- string
261261
- Name of the profile where the public and private
262-
keys for the project are saved. If omitted, uses the ``default``
263-
profile. To learn more about creating a
262+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
264263
profile, see :ref:`mcli-configure`.
265264
- no
266265

source/reference/cloud-manager/alerts-configs-fields-type.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,7 @@ Options
4747
* - ``--profile``, ``-P``
4848
- string
4949
- Name of the profile where the public and private
50-
keys for the project are saved. If omitted, uses the ``default``
51-
profile. To learn more about creating a
50+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
5251
profile, see :ref:`mcli-configure`.
5352
- no
5453

source/reference/cloud-manager/alerts-configs-list.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,7 @@ Options
4949
* - ``--profile``, ``-P``
5050
- string
5151
- Name of the profile where the public and private
52-
keys for the project are saved. If omitted, uses the ``default``
53-
profile. To learn more about creating a
52+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
5453
profile, see :ref:`mcli-configure`.
5554
- no
5655

source/reference/cloud-manager/alerts-configs-update.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -269,8 +269,7 @@ Options
269269
* - ``--profile``, ``-P``
270270
- string
271271
- Name of the profile where the public and private
272-
keys for the project are saved. If omitted, uses the ``default``
273-
profile. To learn more about creating a
272+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
274273
profile, see :ref:`mcli-configure`.
275274
- no
276275

source/reference/iam-project-delete.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,7 @@ Options
5959
* - ``--profile``, ``-P``
6060
- string
6161
- Name of the profile that contains the access information for
62-
the project you want to delete. If omitted, uses the ``default``
63-
profile.
62+
the project you want to delete. If omitted, uses the {+default-profile+}.
6463
- no
6564

6665
.. _mcli-iam-project-delete-output:

source/reference/iam-project-list.txt

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -161,14 +161,8 @@ Each **result** is one project.
161161
Examples
162162
--------
163163

164-
<<<<<<< HEAD
165164
Retrieve All Projects in One Organization
166165
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
167-
=======
168-
The following command retrives the list of
169-
projects in an |onprem| organization. It uses the {+default-profile+} to
170-
access |onprem|.
171-
>>>>>>> 33fc5c0... Create a default profile source constant
172166

173167
The following command retrieves the list of projects in an |onprem|
174168
organization. It uses the {+default-profile+} for accessing

source/reference/mcli-config-set.txt

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,7 @@ Set Organization ID
135135
~~~~~~~~~~~~~~~~~~~
136136

137137
The following example uses the ``mongocli config set`` command
138-
to set the organization ID for |service| in the ``default``
139-
profile.
138+
to set the organization ID for |service| in the {+default-profile+}.
140139

141140
.. code-block:: sh
142141

@@ -153,8 +152,7 @@ Set Project ID
153152
~~~~~~~~~~~~~~
154153

155154
The following example uses the ``mongocli config set`` command
156-
to set the project ID for |cloud-short| in the ``default``
157-
profile.
155+
to set the project ID for |cloud-short| in the {+default-profile+}.
158156

159157
.. code-block:: sh
160158

source/reference/ops-manager/alerts-configs-create.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,8 +262,7 @@ Options
262262
* - ``--profile``, ``-P``
263263
- string
264264
- Name of the profile where the public and private
265-
keys for the project are saved. If omitted, uses the ``default``
266-
profile. To learn more about creating a
265+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
267266
profile, see :ref:`mcli-configure`.
268267
- no
269268

source/reference/ops-manager/alerts-configs-fields-type.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,7 @@ Options
4747
* - ``--profile``, ``-P``
4848
- string
4949
- Name of the profile where the public and private
50-
keys for the project are saved. If omitted, uses the ``default``
51-
profile. To learn more about creating a
50+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
5251
profile, see :ref:`mcli-configure`.
5352
- no
5453

source/reference/ops-manager/alerts-configs-list.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,7 @@ Options
5050
* - ``--profile``, ``-P``
5151
- string
5252
- Name of the profile where the public and private
53-
keys for the project are saved. If omitted, uses the ``default``
54-
profile. To learn more about creating a
53+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
5554
profile, see :ref:`mcli-configure`.
5655
- no
5756

source/reference/ops-manager/alerts-configs-update.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,8 +274,7 @@ Options
274274
* - ``--profile``, ``-P``
275275
- string
276276
- Name of the profile where the public and private
277-
keys for the project are saved. If omitted, uses the ``default``
278-
profile. To learn more about creating a
277+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
279278
profile, see :ref:`mcli-configure`.
280279
- no
281280

source/reference/ops-manager/diagnose-archive-download.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,7 @@ Options
7272
* - ``--profile``, ``-P``
7373
- string
7474
- Name of the profile where the public and private
75-
keys for the project are saved. If omitted, uses the ``default``
76-
profile. To learn more about creating a
75+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
7776
profile, see :ref:`mcli-configure`.
7877
- no
7978

source/reference/ops-manager/logs-jobs-collect.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,7 @@ Options
8686
* - ``--profile``, ``-P``
8787
- string
8888
- Name of the profile where the public and private
89-
keys for the project are saved. If omitted, uses the ``default``
90-
profile. To learn more about creating a
89+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
9190
profile, see :ref:`mcli-configure`.
9291
- no
9392

source/reference/ops-manager/logs-jobs-delete.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,7 @@ Options
5353
* - ``--profile``, ``-P``
5454
- string
5555
- Name of the profile where the public and private
56-
keys for the project are saved. If omitted, uses the ``default``
57-
profile. To learn more about creating a
56+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
5857
profile, see :ref:`mcli-configure`.
5958
- no
6059

source/reference/ops-manager/logs-jobs-download.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,7 @@ Options
6565
* - ``--profile``, ``-P``
6666
- string
6767
- Name of the profile where the public and private
68-
keys for the project are saved. If omitted, uses the ``default``
69-
profile. To learn more about creating a
68+
keys for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a
7069
profile, see :ref:`mcli-configure`.
7170
- no
7271

source/reference/ops-manager/logs-jobs-list.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,7 @@ Options
4949
* - ``--profile``, ``-P``
5050
- string
5151
- Name of the profile where the project ID and the |svc-api-key|\s
52-
for the project are saved. If omitted, uses the ``default``
53-
profile. To learn more about creating a profile, see
52+
for the project are saved. If omitted, uses the {+default-profile+}. To learn more about creating a profile, see
5453
:ref:`mcli-configure`.
5554
- no
5655

0 commit comments

Comments
 (0)