Skip to content

Commit e6cdfb0

Browse files
authored
DOCSP-24994 Compass Settings UI (#474)
* DOCSP-24994 Compass Settings UI * fix refs + move around pages * toc fixes + add more information to settings concept page * settings page * fix ref * build errors * settings reference page * rename ref page * add ref to reference page * capitalization * edit column sizes + add task links * rename table section * AB edits * edits to reference page intro text * more copy cleanup * AB edits pt 2 * RH additions * cleanup copy * add figure + fix styling * JA edits * resize image
1 parent d015bd5 commit e6cdfb0

14 files changed

+204
-28
lines changed

snooty.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ intersphinx = [
1010
toc_landing_pages = [
1111
"/install",
1212
"/connect",
13-
"/connect/connect-from-the-command-line",
13+
"/settings",
14+
"/settings/config-file",
1415
"/connect/advanced-connection-options",
1516
"/connect/favorite-connections",
1617
"/connect/favorite-connections/import-export",

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,3 @@ configuration file to specify which connection to use:
133133
mongodb-compass --file=multipleConnectionFile \
134134
--passphrase=superSecret \
135135
27ba0eda-c27e-46f5-a74a-2c041b1b58c4
136-
137-
.. toctree::
138-
:titlesonly:
139-
140-
/connect/connect-from-the-command-line/command-line-options

source/embedded-shell.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ an :ref:`aggregation pipeline <aggregation-pipeline>`:
6666
{ $match: { "last_name": "Smith" } } // press Shift + Enter
6767
] ) // Press Enter
6868

69+
.. _disable-shell:
70+
6971
Disable the Embedded MongoDB Shell
7072
----------------------------------
7173

124 KB
Loading

source/index.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,9 +152,9 @@ Expand your knowledge of MongoDB by using Compass with other MongoDB products.
152152
Overview </index>
153153
/install
154154
/connect
155+
/settings
155156
/instance
156157
/manage-data
157-
/config-file
158158
/import-export
159159
/embedded-shell
160160
/aggregation-pipeline-builder

source/settings.txt

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
.. _compass-settings:
2+
3+
=========================
4+
Customize |compass-short|
5+
=========================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
To customize user access and privacy in |compass|, you can configure your
16+
|compass-short| settings on the :ref:`Compass interface
17+
<compass-settings-reference>`, the :ref:`command line <cli-options>`, or a
18+
:ref:`configuration file <config-file>`.
19+
20+
Use Cases
21+
---------
22+
23+
You can specify |compass-short| settings and behaviors to customize your
24+
|compass-short| experience. For administrators, you can modify the
25+
|compass-short| settings to restrict the actions users can take.
26+
27+
For example:
28+
29+
- If you need to hide credentials from users connecting to MongoDB, you can
30+
set the ``protectConnectionStrings`` option.
31+
32+
- If you want to automate the launch of |compass-short| without any input
33+
required from users, you can use the command line to launch |compass-short|
34+
with specified configuration options.
35+
36+
- If you have multiple team members using |compass-short|, you can use a common
37+
configuration file to ensure a consistent user experience.
38+
39+
Tasks
40+
-----
41+
42+
- :ref:`compass-configure-network-traffic`
43+
44+
- :ref:`compass-protect-connection-strings`
45+
46+
- :ref:`compass-force-connection-options`
47+
48+
Learn more
49+
----------
50+
51+
- :ref:`compass-interface-settings`
52+
53+
- :ref:`cli-options`
54+
55+
- :ref:`config-file`
56+
57+
.. toctree::
58+
:titlesonly:
59+
60+
/settings/settings-reference
61+
/settings/command-line-options
62+
/settings/config-file
63+
/settings/restrict-outgoing-connections
64+
/settings/protect-connection-strings
65+
/settings/specify-read-preference-tags

source/connect/connect-from-the-command-line/command-line-options.txt renamed to source/settings/command-line-options.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
.. _cli-options:
2-
31
.. program:: compass
2+
.. _cli-options:
43

54
----------------------------
65
Compass Command Line Options
@@ -144,3 +143,5 @@ Learn More
144143
- :ref:`<comp-command-line-connect>`
145144

146145
- :ref:`<config-file>`
146+
147+
- :ref:`compass-interface-settings`

source/config-file.txt renamed to source/settings/config-file.txt

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -54,23 +54,12 @@ When you configure settings with a configuration file:
5454

5555
<path-to-Compass-executable> --help
5656

57-
Tasks
58-
-----
59-
60-
- :ref:`compass-protect-connection-strings`
61-
62-
- :ref:`compass-configure-network-traffic`
63-
64-
- :ref:`specify-read-preference-tags`
65-
66-
.. seealso::
57+
Learn More
58+
----------
6759

68-
:ref:`<config-file-options>`
60+
:ref:`<config-file-options>`
6961

7062
.. toctree::
7163
:titlesonly:
7264

73-
/config-file/config-file-options
74-
/config-file/protect-connection-strings
75-
/config-file/restrict-outgoing-connections
76-
/config-file/specify-read-preference-tags
65+
/settings/config-file/config-file-options
File renamed without changes.

source/config-file/protect-connection-strings.txt renamed to source/settings/protect-connection-strings.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ To hide your your connection string credentials, enable the
3737

3838
You can set the ``protectConnectionStrings`` option in either:
3939

40-
- The |compass-short| :guilabel:`Settings` panel
40+
- The |compass-short| :ref:`Settings panel <compass-settings-reference>`
4141

4242
- The :ref:`command line <cli-options>`
4343

0 commit comments

Comments
 (0)