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``

0 commit comments

Comments
 (0)