Skip to content

Commit 1197375

Browse files
committed
DOCSP-45448-compass-constants
1 parent 66a648b commit 1197375

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+169
-169
lines changed

source/collections.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
.. _compass-collection-tab:
22
.. _compass-collections:
33

4-
=============================
5-
Manage Collections in Compass
6-
=============================
4+
=====================================
5+
Manage Collections in |compass-short|
6+
=====================================
77

88
.. default-domain:: mongodb
99

source/connect.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Connect
5858
-------
5959

6060
If your connection name is already in the :guilabel:`Connections
61-
Sidebar` of your Compass window, click on the connection name to
61+
Sidebar` of your |compass-short| window, click on the connection name to
6262
connect.
6363

6464
Otherwise, you can connect your deployments by either:
@@ -103,8 +103,8 @@ Use Advanced Connection Options
103103

104104
For details, see :ref:`advanced-connection-options`.
105105

106-
Connect to Compass from the Command Line
107-
----------------------------------------
106+
Connect to |compass-short| from the Command Line
107+
------------------------------------------------
108108

109109
.. include:: /includes/intro-command-line-connection.rst
110110

source/connect/connect-from-the-command-line.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _comp-command-line-connect:
22

3-
===================================
4-
Start Compass from the Command Line
5-
===================================
3+
===========================================
4+
Start |compass-short| from the Command Line
5+
===========================================
66

77
.. default-domain:: mongodb
88

@@ -27,8 +27,8 @@ the command line.
2727

2828
.. _compass-executable-location:
2929

30-
Compass Executable Location
31-
---------------------------
30+
|compass-short| Executable Location
31+
-----------------------------------
3232

3333
.. include:: /includes/compass-executable.rst
3434

@@ -51,7 +51,7 @@ the configuration file. The format is:
5151

5252
.. note::
5353

54-
If the username and password arguments are not provided, Compass uses
54+
If the username and password arguments are not provided, |compass-short| uses
5555
the credentials in the connection string.
5656

5757

@@ -71,7 +71,7 @@ Username and Password Parameters
7171
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7272

7373
This example uses the ``username`` and ``password`` parameters to
74-
authenticate Compass to the MongoDB deployment provided in the
74+
authenticate |compass-short| to the MongoDB deployment provided in the
7575
connection string:
7676

7777
.. code-block:: shell
@@ -106,7 +106,7 @@ The components of the command invocation are:
106106

107107
To create the connection configuration file, follow the steps to
108108
:ref:`export the connection details <compass-export-connections-cli>`
109-
from your Compass instance. The export process creates a file that
109+
from your |compass-short| instance. The export process creates a file that
110110
includes all of your favorite connections.
111111

112112
.. important::

source/connect/connections.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Connections Sidebar
1717
.. include:: /includes/multiple-connections.rst
1818

1919

20-
The :guilabel:`Connections Sidebar` on the left of the Compass window
20+
The :guilabel:`Connections Sidebar` on the left of the |compass-short| window
2121
contains the following options:
2222

2323
- :icon-lg:`Plus` icon to add new connections
@@ -42,15 +42,15 @@ Connect to MongoDB
4242

4343
To connect to a saved or favorite deployment, click the name of the
4444
connection in the :guilabel:`Connections` list. Once you connect,
45-
Compass shows a success toast and displays a green dot next to the
45+
|compass-short| shows a success toast and displays a green dot next to the
4646
connection name.
4747

48-
If a connection error occurs, Compass shows a toast with error
48+
If a connection error occurs, |compass-short| shows a toast with error
4949
information and displays a red triangle next to the connection name. To
5050
see additional error information, click :guilabel:`Review` in the error
5151
toast.
5252

53-
To add a new connection to Compass, click the :icon-lg:`Plus` button at
53+
To add a new connection to |compass-short|, click the :icon-lg:`Plus` button at
5454
the top of the :guilabel:`Connections Sidebar` to open the
5555
:guilabel:`New Connection` modal. For more information, see
5656
:ref:`connect-run-compass`.

source/connect/disconnect.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Disconnect from MongoDB
66

77
.. default-domain:: mongodb
88

9-
Disconnecting from a MongoDB deployment closes the Compass connection to
10-
the active deployment and returns the Compass view to the initial
9+
Disconnecting from a MongoDB deployment closes the |compass-short| connection to
10+
the active deployment and returns the |compass-short| view to the initial
1111
connection dialog.
1212

1313
Steps

source/connect/favorite-connections/import-export-cli/export.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ This example exports saved |compass-short| connections to a file with
6060
the path ``/tmp/compass-connections/favorites-encrypted.json``. The exported file
6161
is encrypted with the passphrase ``abc123``.
6262

63-
Run the following command in the folder containing your MongoDB Compass
63+
Run the following command in the folder containing your |compass|
6464
executable:
6565

6666
.. code-block:: sh
@@ -167,7 +167,7 @@ Example
167167
This example exports saved |compass-short| connections to a file with
168168
the path ``/tmp/compass-connections/favorites.json``.
169169

170-
Run the following command in the folder containing your MongoDB Compass
170+
Run the following command in the folder containing your |compass|
171171
executable:
172172

173173
.. code-block:: sh

source/connect/favorite-connections/import-export-cli/import.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ a file with the path
6262
``/tmp/compass-connections/favorites-encrypted.json`` that is encrypted
6363
with the passphrase ``abc123``.
6464

65-
Run the following command in the folder containing your MongoDB Compass
65+
Run the following command in the folder containing your |compass|
6666
executable:
6767

6868
.. code-block:: sh
@@ -86,7 +86,7 @@ After you run the import command, you will see this output:
8686

8787
Importing connections from "/tmp/compass-connections/favorites-encrypted.json" (with passphrase)
8888

89-
MongoDB Compass starts and you will see the imported connections under
89+
|compass| starts and you will see the imported connections under
9090
:guilabel:`Saved Connections` on the Connect screen.
9191

9292
Errors
@@ -141,7 +141,7 @@ Example
141141
The following example imports saved |compass-short| connections from
142142
a file with the path ``/tmp/compass-connections/favorites.json``.
143143

144-
Run the following command in the folder containing your MongoDB Compass
144+
Run the following command in the folder containing your |compass|
145145
executable:
146146

147147
.. code-block:: sh
@@ -163,5 +163,5 @@ After you run the import command, you will see this output:
163163

164164
Importing connections from "/tmp/compass-connections/favorites.json" (without passphrase)
165165

166-
MongoDB Compass starts and you will see the imported connections under
166+
|compass| starts and you will see the imported connections under
167167
:guilabel:`Saved Connections` on the Connect screen.

source/connect/required-access.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ privileges:
1818
:header-rows: 1
1919
:widths: 25 30 25 20
2020

21-
* - Compass View
21+
* - |compass-short| View
2222
- Capability
2323
- Privilege(s)
2424
- MongoDB Built-In Role

source/databases.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
.. _compass-database-tab:
22
.. _compass-dbs:
33

4-
===========================
5-
Manage Databases in Compass
6-
===========================
4+
===================================
5+
Manage Databases in |compass-short|
6+
===================================
77

88
.. default-domain:: mongodb
99

source/documents.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
.. _compass-documents:
22
.. _compass-docs:
33

4-
===========================
5-
Manage Documents in Compass
6-
===========================
4+
===================================
5+
Manage Documents in |compass-short|
6+
===================================
77

88
.. default-domain:: mongodb
99

@@ -25,7 +25,7 @@ documents in your selected collection or view.
2525

2626
.. note::
2727

28-
For query result sets larger than 20 documents, Compass shows
28+
For query result sets larger than 20 documents, |compass-short| shows
2929
paginated results. By default, pages display 20 documents at a time.
3030

3131
.. END-COMPASS-ONLY

0 commit comments

Comments
 (0)