Skip to content

Commit 77db11e

Browse files
zach-carrzach-carr
authored
(DOCSP-10235) Document VSCE Settings
1 parent 69b7136 commit 77db11e

File tree

7 files changed

+192
-23
lines changed

7 files changed

+192
-23
lines changed

‎source/commands.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. _vsce-commands:
2+
3+
===============
4+
|vsce| Commands
5+
===============
6+
7+
.. default-domain:: mongodb

‎source/connect.txt

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -72,24 +72,7 @@ Define how your connection is saved with the
7272
:guilabel:`Default Connection Saving Location`
7373
:ref:`setting <vsce-settings>`:
7474

75-
.. list-table::
76-
:header-rows: 1
77-
:widths: 20 40
78-
79-
* - Setting
80-
- Description
81-
82-
* - ``Global``
83-
- Save your connection globally in VS Code, so it can be accessed
84-
from any workspace.
85-
86-
* - ``Workspace``
87-
- Save your connection in your workspace. You cannot
88-
access the connection from a different workspace.
89-
90-
* - ``Session``
91-
- Save the connection for only this VS Code session. The connection
92-
is lost when you close VS Code.
75+
.. include:: includes/connection-location-table.rst
9376

9477
.. tabs::
9578

‎source/includes/connection-location-table.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:widths: 20 40
4+
5+
* - Setting
6+
- Description
7+
8+
* - ``Global``
9+
- Save your connection globally in VS Code, so it can be accessed
10+
from any workspace.
11+
12+
* - ``Workspace``
13+
- Save your connection in your workspace. You cannot
14+
access the connection from a different workspace.
15+
16+
* - ``Session``
17+
- Save the connection for only this VS Code session. The connection
18+
is lost when you close VS Code.

‎source/includes/steps-configure-settings.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
title: Open the Settings View.
2+
level: 4
3+
ref: open-settings
4+
content: |
5+
.. list-table::
6+
:header-rows: 1
7+
8+
* - Operating System
9+
- Method
10+
- Actions
11+
12+
* - Any
13+
- Visual Studio Code Menu
14+
- :guilabel:`File` / :guilabel:`Code` >
15+
:guilabel:`Preferences` >
16+
:guilabel:`Settings`
17+
18+
* - MacOS
19+
- Keyboard Shortcut
20+
- Press ``Command`` + ``,``
21+
22+
* - Windows and Linux
23+
- Keyboard Shortcut
24+
- Press ``Ctrl`` + ``,``
25+
---
26+
title: Search "MongoDB" in the :guilabel:`Settings` search bar.
27+
level: 4
28+
ref: search-mongodb-in-settings
29+
content: |
30+
|vsce| extension settings are displayed. Changes you
31+
make are saved automatically.
32+
...

‎source/index.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ To learn how to install MongoDB for |vscode-short|, see :ref:`vsce-install`.
5656
/connect
5757
/databases-collections
5858
/playgrounds
59-
/settings
59+
/reference

‎source/reference.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. _vsce-reference:
2+
3+
=========
4+
Reference
5+
=========
6+
7+
.. default-domain:: mongodb
8+
9+
.. class:: hidden
10+
11+
.. toctree::
12+
:titlesonly:
13+
14+
/settings
15+
/commands

‎source/settings.txt

Lines changed: 118 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,121 @@
11
.. _vsce-settings:
22

3-
============================
4-
MongoDB for VS Code Settings
5-
============================
3+
===============
4+
|vsce| Settings
5+
===============
66

7-
.. include:: /includes/fact-vsce-preview.rst
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/fact-vsce-preview.rst
16+
17+
Configure Settings
18+
------------------
19+
20+
To configure |vsce| settings:
21+
22+
.. include:: /includes/steps/configure-settings.rst
23+
24+
Settings
25+
--------
26+
27+
The following table lists the available settings for
28+
|vsce|:
29+
30+
.. list-table::
31+
:widths: 25 50 25
32+
:header-rows: 1
33+
34+
* - Setting
35+
- Description
36+
- Default
37+
38+
* - :guilabel:`Shell`
39+
- MongoDB shell to use. Choose either:
40+
41+
- ``mongo`` (the legacy MongoDB shell), or
42+
43+
- ``mongosh`` (the new MongoDB shell)
44+
45+
- ``mongo``
46+
47+
* - :guilabel:`Show`
48+
- If enabled, shows the MongoDB view in the Visual Studio Code
49+
left navigation panel.
50+
- Enabled
51+
52+
* - :guilabel:`Max Number of Problems`
53+
- The maximum number of problems |vsce| will generate
54+
in the Visual Studio Code :guilabel:`Problems` view.
55+
- ``100``
56+
57+
* - :guilabel:`Trace: Server`
58+
- MongoDB language server logging settings.
59+
60+
Edit this setting through the
61+
``mongodbLanguageServer.trace.server`` property in your project's
62+
``settings.json`` file.
63+
64+
Within the ``mongodbLanguageServer.trace.server`` object, you
65+
can specify:
66+
67+
- ``format``, and
68+
69+
- ``verbosity``
70+
71+
Output logs are viewable by selecting
72+
:guilabel:`MongoDB Language Server` from the dropdown in the
73+
:guilabel:`Output` view, or with the
74+
`Language Server Protocol Inspector <https://github.com/Microsoft/language-server-protocol-inspector>`__.
75+
76+
- .. code-block:: json
77+
78+
{
79+
"format": "json",
80+
"verbosity": "verbose"
81+
}
82+
83+
* - :guilabel:`Confirm Run All`
84+
- If enabled, shows a confirmation message before running
85+
commands in a playground.
86+
- Enabled
87+
88+
* - :guilabel:`Default Connection Saving Location`
89+
- Sets if and where new connections are saved.
90+
91+
You can select:
92+
93+
.. include:: /includes/connection-location-table.rst
94+
95+
- ``Global``
96+
97+
* - :guilabel:`Hide Option To Choose Where To Save New Connections`
98+
- If disabled, you are prompted to choose where to save each new
99+
connection.
100+
101+
If enabled, new connections are automatically saved to the
102+
:guilabel:`Default Connection Saving Location` without prompt.
103+
- Enabled
104+
105+
* - :guilabel:`Default Limit`
106+
- Number of documents to fetch when viewing documents from a
107+
collection. Does not affect playground operations.
108+
- ``10``
109+
110+
* - :guilabel:`Send Telemetry`
111+
- If enabled, allows the collection of anonymous diagnostic and
112+
usage telemetry data to help improve |vsce|.
113+
- Enabled
114+
115+
* - :guilabel:`Use Default Template For Playground`
116+
- If enabled, playground files load with a template containing
117+
sample commands.
118+
119+
If disabled, playground files load with an empty playground
120+
editor.
121+
- Enabled

0 commit comments

Comments
 (0)