Merge pull request #57 from ianf-mongodb/DOCSP-28307

DOCSP-28307 Efficient Query Development

Author: sarah-olson-mongodb

source/commands.txt

@@ -12,8 +12,6 @@
    :depth: 1
    :class: singlecol
 
-.. include:: /includes/fact-vsce-preview.rst
-
 This document lists the VS Code commands available for
 |vsce|. To open the Command Palette and execute these commands:
 

source/connect.txt

@@ -12,8 +12,6 @@ Connect to Your MongoDB Deployment
    :depth: 1
    :class: singlecol
 
-.. include:: /includes/fact-vsce-preview.rst
-
 This page outlines how to use |vsce| to connect to a
 MongoDB host. You can connect to a standalone, replica set,
 or sharded cluster host.

source/create-cluster-terraform.txt

@@ -12,8 +12,6 @@ Create an |service| Cluster from a Template using Terraform
    :depth: 1
    :class: singlecol
 
-.. include:: /includes/fact-vsce-preview.rst
-
 This page outlines how to use the |service| template for Terraform files
 included with the MongoDB Extension for |vscode-short| to create 
 Shared Tier |service| clusters.

source/crud-ops.txt

@@ -12,8 +12,6 @@ Perform CRUD Operations
    :depth: 1
    :class: singlecol
 
-.. include:: /includes/fact-vsce-preview.rst
-
 Documents are individual records in a MongoDB collection and are the 
 basic unit of data in MongoDB.
 

source/databases-collections.txt

@@ -12,8 +12,6 @@ Navigate Your Data
    :depth: 2
    :class: singlecol
 
-.. include:: /includes/fact-vsce-preview.rst
-
 Once you :ref:`connect to your deployment <vsce-connect>` using |vsce|,
 use the left navigation to:
 

source/index.txt

@@ -12,8 +12,6 @@ MongoDB for VS Code
    :depth: 1
    :class: singlecol
 
-.. include:: /includes/fact-vsce-preview.rst
-
 MongoDB provides an extension for |vscode| which lets you work with
 MongoDB and your data directly within your coding environment.
 

source/install.txt

@@ -12,8 +12,6 @@ Install MongoDB for VS Code
    :depth: 1
    :class: singlecol
 
-.. include:: /includes/fact-vsce-preview.rst
-
 Prerequisites
 -------------
 

source/playground-databases.txt

@@ -11,8 +11,6 @@ Create Databases and Collections
    :depth: 1
    :class: singlecol
 
-.. include:: /includes/fact-vsce-preview.rst
-
 You can create 
 :manual:`databases and collections </core/databases-and-collections/>` 
 using a MongoDB Playground. 

source/playgrounds.txt

@@ -12,21 +12,25 @@ Explore Your Data with Playgrounds
    :depth: 1
    :class: singlecol
 
-.. include:: /includes/fact-vsce-preview.rst
-
 MongoDB Playgrounds are JavaScript environments where you can prototype
 queries, aggregations, and MongoDB commands with helpful syntax
 highlighting.
 
 MongoDB Playgrounds provide intelligent autocomplete for:
 
-- The Mongo Shell |api|,
-- MongoDB operators,
-- Database, collection, and field names.
+- The Mongo Shell |api|
+- MongoDB keywords, operators, aggregation stages, database, collection, 
+  and field names.
+- Any JavaScript variables or keywords.
 
 You can save playgrounds in your workspace and use them to
 document how your application interacts with MongoDB. |vsce| interprets
-files with the ``.mongodb`` extension as playgrounds.
+files with the ``.mongodb.js`` extension as playgrounds.
+
+Starting in version ``0.11.0`` the default file extension
+for MongoDB Playgrounds files is ``.mongodb.js``. Previous versions 
+of MongoDB Playgrounds use the default file extension 
+``.mongodb``. MongoDB Playgrounds support both file extensions.
 
 .. include:: /includes/admonitions/note-playgrounds.rst
 
@@ -120,11 +124,11 @@ panel, the |vsce| *Overview* page, or the |vscode| Command Pallette.
 Open a Saved Playground
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-If you have files in your |vscode-short| workspace with the ``.mongodb``
-extension, |vsce| displays these files in the :guilabel:`Playgrounds`
-panel.
+If you have files in your |vscode-short| workspace with the ``.mongodb.js`` 
+or ``.mongodb`` extension, |vsce| displays these files in the 
+:guilabel:`Playgrounds` panel.
 
-Double click a ``.mongodb`` file to open that playground.
+Double click a file to open that playground.
 
 Run a Playground
 ----------------
@@ -177,6 +181,26 @@ of your playground.
 immediately above your selected section. Click this link to test and
 troubleshoot specific lines or sections of your playground.
 
+Code Formatting and Linting Tools
+---------------------------------
+
+MongoDB Playgrounds are JavaScript files and can work with popular
+|vscode-short| formatting and linting extensions like
+`Prettier <https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode>`_ 
+and `ESLint <https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint>`_.
+
+If you use a code formatting extension, MongoDB Playgrounds 
+suggest autocompletion and liniting hints for:
+
+- System variables such as ``$$ROOT`` and ``$$NOW``
+- ``use`` and ``db`` commands
+- Collection names, in bracketed notation such as ``db["collection"].find({})``
+- Alternative commands for shell commands not supported in MongoDB Playgrounds 
+  such as ``show users``
+
+For a full list of autocompletion and linting improvements, see the 
+`v0.11.1 release notes <https://github.com/mongodb-js/vscode/releases/tag/v0.11.1>`_.
+
 Log to Console from a Playground
 --------------------------------
 
@@ -212,4 +236,4 @@ Consideration for Authentication
    /crud-ops
    /run-agg-pipelines
    /export-to-language
-   /require-modules
+   /require-modules

source/require-modules.txt

@@ -12,8 +12,6 @@ Use ``require()`` to Include External Modules
    :depth: 1
    :class: singlecol
 
-.. include:: /includes/fact-vsce-preview.rst
-
 .. important::
 
    A complete description of Node.js, modules, and the