Merge pull request #84 from ianf-mongodb/DOCSP-28802

DOCSP-28802 Add Enable Autocomplete Task Page

Author: jmd-mongo

source/enable-autocomplete-for-string-literals.txt

@@ -0,0 +1,102 @@
+.. _vs-code-enable-autocomplete:
+
+=======================================
+Enable Autocomplete for String Literals
+=======================================
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+You can optionally enable autocomplete for string literals 
+inside VSCode. Enabling autocomplete for string literals lets you 
+automatically populate database and collection names when using 
+``use("")`` or ``db.getCollection("")`` syntax within a MongoDB 
+playground.
+
+About this Task
+---------------
+
+- Enabling autocomplete for string literals is a global
+  VSCode setting. Changing this setting may affect the behavior and 
+  performance of other extensions and of VSCode itself. 
+
+- If you do not want to enable autocomplete for string literals inside 
+  VSCode, you can use the keyboard shortcut :kbd:`Ctrl` + :kbd:`Space`. 
+  This shortcut prompts autocomplete for string literals in your 
+  MongoDB playground.
+
+Before you Begin
+----------------
+
+Install the :ref:`MongoDB VSCode extension <vsce-install>`.
+
+Steps
+-----
+
+.. procedure::
+   :style: connected
+
+   .. step:: Open Settings.json
+     
+      In VSCode, open the command palette:
+
+      .. list-table::
+         :header-rows: 1
+         :widths: 30 70
+
+         * - Operating System
+           - Keyboard Command
+
+         * - Windows
+           - :kbd:`CTRL` + :kbd:`SHIFT` + :kbd:`P`
+
+         * - MacOS
+           - :kbd:`CMD` + :kbd:`SHIFT` + :kbd:`P`
+
+      Enter :guilabel:`Open User Settings (JSON)` and select the option 
+      from the autocompleted list:
+
+      .. figure:: /images/vsce-command-palette-json-settings.png
+         :figwidth: 700px
+         :alt: Image of a stream connection
+
+   .. step:: Add the autocomplete snippet to the Settings.json file
+     
+      Copy the following code snippet:
+
+      .. code-block::
+
+         "editor.quickSuggestions": {
+            "other": true,
+            "comments": false,
+            "strings": true
+         }
+
+      Paste the code into the ``Settings.json`` file:
+
+      .. figure:: /images/vsce-add-snippet-json-settings.png
+         :figwidth: 700px
+         :alt: Image of a stream connection
+
+   .. step:: Test the autocompletion feature
+
+      In a new playground file connected to your deployment, 
+      type the first character of a collection name between  
+      ``db.getCollection("")`` and click the full name to populate 
+      the collection name:
+
+      .. figure:: /images/vsce-get-collection-auto-complete.png
+         :figwidth: 700px
+         :alt: Get collection autocomplete
+
+      You can also autocomplete database names by typing the first 
+      character of a database name in-between the ``use("")`` statement.
+
+Learn More
+----------
+
+- :ref:`vsce-playground-databases`
+- :ref:`vsce-aggregation`

source/images/vsce-add-snippet-json-settings.png

@@ -264,5 +264,6 @@ Consideration for Authentication
    /playground-databases
    /crud-ops
    /run-agg-pipelines
+   /enable-autocomplete-for-string-literals
    /export-to-language
    /require-modules