Skip to content

Commit c25bc9b

Browse files
authored
DOCSP-27767 Scriptable Compass IA Changes (Updated) (#464)
1 parent 0128e30 commit c25bc9b

13 files changed

+76
-44
lines changed

snooty.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ intersphinx = [
1010
toc_landing_pages = [
1111
"/install",
1212
"/connect",
13+
"/connect/connect-from-the-command-line",
14+
"/connect/advanced-connection-options",
1315
"/connect/favorite-connections",
14-
"/connect/favorite-connections/import-export/",
16+
"/connect/favorite-connections/import-export",
1517
"/instance",
1618
"/config-file",
17-
"/command-line-options",
1819
"/query/filter",
1920
"/query/queries",
2021
"/documents",

source/connect.txt

Lines changed: 7 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -84,43 +84,19 @@ on GitHub.
8484

8585
.. include:: /includes/steps/starting-compass-paste-string.rst
8686

87-
Connecting with Compass from the Command Line
88-
----------------------------------------------
89-
87+
Connect to Compass from the Command Line
88+
----------------------------------------
9089

9190
.. include:: /includes/intro-command-line-connection.rst
9291

9392
For details, see :ref:`comp-command-line-connect`.
9493

95-
.. _advanced-connection-options:
96-
9794
Advanced Connection Options
9895
---------------------------
9996

100-
The Advanced Connection Options provide additional forms of connecting
101-
|compass-short| to MongoDB.
102-
103-
:ref:`general-connection-tab`
104-
Learn how to select a Connection String Scheme for your deployment.
105-
106-
:ref:`authentication-connection-tab`
107-
Learn how to connect deployments that require authentication.
108-
109-
:ref:`tls-ssl-tab`
110-
Learn how to connect deployments using TLS/SSL.
111-
112-
:ref:`ssh-connection`
113-
Learn how to connect deployments using an SSH tunnel.
97+
.. include:: /includes/intro-advanced-connection-options.rst
11498

115-
:ref:`in-use-encryption-tab`
116-
Learn how to connect deployments using In-Use Encryption.
117-
118-
:ref:`advanced-connection-tab`
119-
Learn about additional advanced connection options for your deployments.
120-
121-
:ref:`comp-command-line-connect`
122-
Learn how to open |compass-short| and connect to MongoDB from the
123-
command line.
99+
For details, see :ref:`advanced-connection-options`.
124100

125101
.. seealso::
126102

@@ -129,13 +105,8 @@ The Advanced Connection Options provide additional forms of connecting
129105
.. toctree::
130106
:titlesonly:
131107

132-
/connect/general-connection
133-
/connect/authentication-connection
134-
/connect/tls-ssl-connection
135-
/connect/ssh-connection
136-
/connect/in-use-encryption
137-
/connect/advanced-connection
138-
/connect/required-access
139-
/connect/favorite-connections
140108
/connect/connect-from-the-command-line
109+
/connect/advanced-connection-options
110+
/connect/favorite-connections
111+
/connect/required-access
141112
/connect/disconnect
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
.. _advanced-connection-options:
2+
3+
===========================
4+
Advanced Connection Options
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+
.. include:: /includes/intro-advanced-connection-options.rst
16+
17+
Options
18+
-------
19+
20+
:ref:`general-connection-tab`
21+
Learn how to select a connection string scheme for your deployment.
22+
23+
:ref:`authentication-connection-tab`
24+
Learn how to connect your deployments that require authentication.
25+
26+
:ref:`tls-ssl-tab`
27+
Learn how to connect your deployments with TLS/SSL.
28+
29+
:ref:`ssh-connection`
30+
Learn how to connect your deployments with a proxy method or SSH tunnel.
31+
32+
:ref:`in-use-encryption-tab`
33+
Learn how to connect your deployments with Queryable Encryption.
34+
35+
:ref:`advanced-connection-tab`
36+
Learn about additional advanced connection options for your deployments.
37+
38+
.. toctree::
39+
:titlesonly:
40+
41+
/connect/advanced-connection-options/general-connection
42+
/connect/advanced-connection-options/authentication-connection
43+
/connect/advanced-connection-options/tls-ssl-connection
44+
/connect/advanced-connection-options/ssh-connection
45+
/connect/advanced-connection-options/in-use-encryption
46+
/connect/advanced-connection-options/advanced-connection

source/connect/general-connection.txt renamed to source/connect/advanced-connection-options/general-connection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Procedure
3333
.. procedure::
3434
:style: connected
3535

36-
.. step:: Select a Connection String Scheme.
36+
.. step:: Select a connection string scheme.
3737

3838
You can select one of the following options:
3939

source/connect/in-use-encryption.txt renamed to source/connect/advanced-connection-options/in-use-encryption.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ replica set or sharded cluster to use this connection option. Your replica set
1717
can be a single node or larger.
1818

1919
The :guilabel:`In-Use Encryption` connection tab allows you to connect your
20-
deployments using :v6.0:`Queryable Encryption </core/queryable-encryption/>`.
20+
deployments with :v6.0:`Queryable Encryption </core/queryable-encryption/>`.
2121

2222
Procedure
2323
---------

source/connect/ssh-connection.txt renamed to source/connect/advanced-connection-options/ssh-connection.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Proxy / SSH Tunnel Connection Tab
1212
:depth: 1
1313
:class: singlecol
1414

15-
The :guilabel:`Proxy / SSH Tunnel` tab allows you to connect to your deployment using
16-
a Proxy method or SSH Tunnel.
15+
The :guilabel:`Proxy / SSH Tunnel` tab allows you to connect to your deployment
16+
with a Proxy method or SSH tunnel.
1717

1818
Procedure
1919
---------

source/connect/tls-ssl-connection.txt renamed to source/connect/advanced-connection-options/tls-ssl-connection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ TLS / SSL Connection Tab
1212
:depth: 1
1313
:class: singlecol
1414

15-
The :guilabel:`TLS / SSL` tab allows you to connect deployments using TLS / SSL.
15+
The :guilabel:`TLS / SSL` tab allows you to connect deployments with TLS / SSL.
1616
For more information on :guilabel:`TLS / SSL`, see :manual:`TLS Options
1717
</reference/connection-string/#tls-options>`
1818

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,3 +134,7 @@ configuration file to specify which connection to use:
134134
--passphrase=superSecret \
135135
27ba0eda-c27e-46f5-a74a-2c041b1b58c4
136136

137+
.. toctree::
138+
:titlesonly:
139+
140+
/connect/connect-from-the-command-line/command-line-options

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@
66
Compass Command Line Options
77
----------------------------
88

9+
.. default-domain:: mongodb
10+
11+
.. contents:: On this page
12+
:local:
13+
:backlinks: none
14+
:depth: 1
15+
:class: singlecol
16+
917
The following page provides an overview on how to set command line options for
1018
|compass|. For more detailed guidance on how to set a specific command line
1119
option, see the task page for the specific option.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
The advanced connection options provide additional ways to connect Compass
2+
to MongoDB. Advanced connection options allow you to specify authentication,
3+
TLS/SSL, and SSH to securely connect to your deployment.

source/index.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,6 @@ Expand your knowledge of MongoDB by using Compass with other MongoDB products.
155155
/instance
156156
/manage-data
157157
/config-file
158-
/command-line-options
159158
/import-export
160159
/embedded-shell
161160
/aggregation-pipeline-builder

0 commit comments

Comments
 (0)