Skip to content

Commit 95f679b

Browse files
kanchana-mongodbkanchana-mongodb
authored
Merge pull request mongodb#37 from kanchana-mongodb/DOCSP-13277
DOCSP-13277 Entry points for overview page
2 parents 4e1278a + b76869a commit 95f679b

File tree

4 files changed

+160
-76
lines changed

4 files changed

+160
-76
lines changed

‎source/connect.txt

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,18 @@ This page outlines how to use |vsce| to connect to a
1818
MongoDB host. You can connect to a standalone, replica set,
1919
or sharded cluster host.
2020

21-
.. admonition:: MongoDB Atlas
22-
:class: note
21+
.. note:: MongoDB Atlas
2322

2423
If you need to create a MongoDB host, consider using
2524
`MongoDB Atlas <https://www.mongodb.com/cloud/atlas?tck=docs_vsce>`__.
26-
Atlas is a cloud-hosted database-as-a-service which requires no
25+
|service| is a cloud-hosted database-as-a-service which requires no
2726
installation, offers a free tier to get started, and provides a
2827
copyable URI to easily connect |vsce| to your deployment.
2928

29+
To create a cluster on the |service| free tier, run the command
30+
``MongoDB: Open Overview Page`` in the |vscode-short| Command
31+
Palette and then click :guilabel:`Create free cluster`.
32+
3033
To create an |service| cluster using a Terraform template included
3134
with |vsce|, see :ref:`vsce-create-cluster-terraform`.
3235

‎source/includes/steps-starting-vsce-individual-fields.yaml

Lines changed: 86 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,42 @@ source:
44
file: steps-open-mongodb-view.yaml
55
ref: open-mongodb-view
66
---
7-
title: Create a connection to a deployment.
7+
title: Open the |vsce| *Overview* page from the Command Palette or from
8+
the :guilabel:`MongoDB` view in the :guilabel:`Activity Bar` .
89
level: 4
910
ref: create-connection
1011
content: |
1112
12-
a. Click the :guilabel:`Plus` icon.
13+
.. tabs::
1314
14-
#. Expand the :guilabel:`More Actions` menu (:guilabel:`...`), then
15-
click :guilabel:`Add MongoDB Connection`.
15+
.. tab:: Open from Command Palette
16+
:tabid: mdboverview
1617
18+
a. Perform the action described in the following table for your
19+
operating system and method:
20+
21+
.. include:: /includes/list-tables/command-palette-options.rst
22+
23+
#. From the Command Palette, select :guilabel:`MongoDB: Open
24+
Overview Page`.
25+
26+
.. include:: /includes/admonitions/tip-mongodb-command-palette.rst
27+
28+
.. tab:: Open from MongoDB View
29+
:tabid: mdbview
30+
31+
a. Expand the :guilabel:`Connections` pane in the left
32+
navigation if it's collapsed.
33+
34+
#. Click the :guilabel:`More Actions` menu (:guilabel:`...`),
35+
then click :guilabel:`Add MongoDB Connection` to open the
36+
|vsce| *Overview* page.
37+
38+
---
39+
title: In the *Overview* page, click :guilabel:`Open form` under
40+
:guilabel:`Advanced Connection Settings` to create a connection to a deployment.
41+
level: 4
42+
ref: vsce-advanced-connection-settings
1743
---
1844
title: Enter your connection information.
1945
ref: vsce-enter-connection-info
@@ -28,7 +54,7 @@ content: |
2854
For more information, see the **Paste Connection String** tab in
2955
:ref:`vsce-connect-task`.
3056
31-
The :guilabel:`Hostname` dialog contains the following connection
57+
The :guilabel:`General` tab contains the following connection
3258
field options:
3359
3460
.. list-table::
@@ -174,61 +200,6 @@ content: |
174200
For example, the username "X509User" must be
175201
provided as "CN=X509User".
176202
177-
---
178-
title: "Specify replica set and security connection options."
179-
level: 4
180-
optional: true
181-
ref: connect-additional-options
182-
content: |
183-
You can specify the following security connection options:
184-
185-
.. list-table::
186-
:header-rows: 1
187-
188-
* - Option
189-
- Description
190-
191-
* - :guilabel:`Replica Set Name`
192-
- If your MongoDB deployment is a replica set, specify the
193-
replica set name. Not required if you specify your replica
194-
set :guilabel:`Hostname` as an :guilabel:`SRV Record`.
195-
196-
* - :guilabel:`Read Preference`
197-
- Specifies how |vsce| directs read operations. Options are:
198-
199-
.. list-table::
200-
:header-rows: 1
201-
:widths: 20 50
202-
203-
* - Read Preference Mode
204-
- Description
205-
206-
* - ``primary``
207-
- Default mode. All operations read from the current
208-
replica set primary.
209-
210-
* - ``primaryPreferred``
211-
- In most situations, operations read from the primary but
212-
if it is unavailable, operations read from secondary
213-
members.
214-
215-
* - ``secondary``
216-
- All operations read from the secondary members of the
217-
replica set.
218-
219-
* - ``secondaryPreferred``
220-
- In most situations, operations read from secondary
221-
members but if no secondary members are available,
222-
operations read from the primary.
223-
224-
* - ``nearest``
225-
- Operations read from member of the replica
226-
set with the least network latency, irrespective of the
227-
member's type.
228-
229-
To learn more about read preferences, see
230-
:manual:`Read Preference </core/read-preference/>`.
231-
232203
If you are connecting to your deployment using TLS/SSL or an SSH
233204
tunnel, refer to the following tabs for specific instructions:
234205
@@ -411,6 +382,61 @@ content: |
411382
tunnel. |vsce| cannot establish a connection
412383
to multiple servers across the same SSH tunnel.
413384
---
385+
title: "Specify replica set and security connection options."
386+
level: 4
387+
optional: true
388+
ref: connect-additional-options
389+
content: |
390+
You can specify the following security connection options:
391+
392+
.. list-table::
393+
:header-rows: 1
394+
395+
* - Option
396+
- Description
397+
398+
* - :guilabel:`Replica Set Name`
399+
- If your MongoDB deployment is a replica set, specify the
400+
replica set name. Not required if you specify your replica
401+
set :guilabel:`Hostname` as an :guilabel:`SRV Record`.
402+
403+
* - :guilabel:`Read Preference`
404+
- Specifies how |vsce| directs read operations. Options are:
405+
406+
.. list-table::
407+
:header-rows: 1
408+
:widths: 20 50
409+
410+
* - Read Preference Mode
411+
- Description
412+
413+
* - ``primary``
414+
- Default mode. All operations read from the current
415+
replica set primary.
416+
417+
* - ``primaryPreferred``
418+
- In most situations, operations read from the primary but
419+
if it is unavailable, operations read from secondary
420+
members.
421+
422+
* - ``secondary``
423+
- All operations read from the secondary members of the
424+
replica set.
425+
426+
* - ``secondaryPreferred``
427+
- In most situations, operations read from secondary
428+
members but if no secondary members are available,
429+
operations read from the primary.
430+
431+
* - ``nearest``
432+
- Operations read from member of the replica
433+
set with the least network latency, irrespective of the
434+
member's type.
435+
436+
To learn more about read preferences, see
437+
:manual:`Read Preference </core/read-preference/>`.
438+
439+
---
414440
ref: vsce-click-connect
415441
level: 4
416442
title: "Click :guilabel:`Connect`."

‎source/includes/steps-starting-vsce-paste-string.yaml

Lines changed: 47 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,21 +24,57 @@ content: |
2424
:manual:`Connection String URI Format
2525
</reference/connection-string>`.
2626
---
27-
source:
28-
file: steps-source-command-palette.yaml
29-
ref: vsce-command-palette
30-
ref: vsce-connect-command-palette
31-
---
32-
title: "From the Command Palette, select
33-
:guilabel:`MongoDB: Connect with Connection String...`."
27+
title: "Open the |vscode-short| Command Palette."
3428
level: 4
35-
ref: vsce-connect-connect
36-
content: |
29+
ref: vsce-open-overview-page
30+
content: |
3731
38-
.. include:: /includes/admonitions/tip-mongodb-command-palette.rst
32+
Open the |vscode-short| Command Palette to paste your connection
33+
string and connect to your cluster. You can open the Command
34+
Palette in one of the following ways:
3935
40-
---
36+
.. tabs::
37+
38+
.. tab:: Open from Overview Page
39+
:tabid: mdboverview
40+
41+
a. Perform the action described in the following table for your
42+
operating system and method:
43+
44+
.. include:: /includes/list-tables/command-palette-options.rst
45+
46+
#. From the Command Palette, select :guilabel:`MongoDB: Open
47+
Overview Page`.
48+
49+
.. include:: /includes/admonitions/tip-mongodb-command-palette.rst
50+
51+
#. In the *Overview* page, click :guilabel:`Connect` under the
52+
:guilabel:`Connect with Connection String`.
4153
54+
.. tab:: Open from MongoDB View
55+
:tabid: mdbview
56+
57+
a. Expand the :guilabel:`Connections` pane in the left
58+
navigation if it is collapsed.
59+
60+
#. Click the :guilabel:`More Actions` menu (:guilabel:`...`)
61+
and select :guilabel:`Add MongoDB Connection with Connection
62+
String...`.
63+
64+
.. tab:: Open Directly
65+
:tabid: cmdpalette
66+
67+
a. Perform the action described in the following table for your
68+
operating system and method:
69+
70+
.. include:: /includes/list-tables/command-palette-options.rst
71+
72+
#. From the Command Palette, select :guilabel:`MongoDB: Connect
73+
with Connection String...`.
74+
75+
.. include:: /includes/admonitions/tip-mongodb-command-palette.rst
76+
77+
---
4278
title: "Paste your connection string into the Command Palette."
4379
level: 4
4480
ref: vsce-connect-paste

‎source/playgrounds.txt

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ Open a Playground
5353
Create a New Playground
5454
~~~~~~~~~~~~~~~~~~~~~~~
5555

56-
You can create a new playground from either the :guilabel:`Playgrounds`
57-
panel, or the |vscode| Command Pallette.
56+
You can create a new playground from the :guilabel:`Playgrounds`
57+
panel, the |vsce| *Overview* page, or the |vscode| Command Pallette.
5858

5959
.. tabs::
6060

@@ -73,6 +73,25 @@ panel, or the |vscode| Command Pallette.
7373
the :guilabel:`...` menu icon of the :guilabel:`Playgrounds` panel
7474
and select :guilabel:`Create MongoDB Playground`.
7575

76+
.. tab:: Overview Page
77+
:tabid: mdboverview
78+
79+
1. In |vscode-short|, press one of the following key combinations:
80+
81+
- :guilabel:`Control + Shift + P` on Windows or Linux.
82+
- :guilabel:`Command + Shift + P` on macOS.
83+
84+
The :guilabel:`Command Palette` provides quick access to
85+
commands and keyboard shortcuts.
86+
87+
#. Find and run the :guilabel:`MongoDB: Open Overview Page`
88+
command.
89+
90+
.. include:: /includes/admonitions/tip-mongodb-command-palette.rst
91+
92+
#. Click :guilabel:`Create Playground` to open a |vsce|
93+
playground pre-configured with a few commands.
94+
7695
.. tab:: VSCode Command Palette
7796
:tabid: command-palette
7897

0 commit comments

Comments
 (0)