(DOCSP-13673, DOCSP-13899, DOCSP-13900) Added edit doc feature (mongodb#40)

Co-authored-by: Anthony Sansone <[email protected]>
Co-authored-by: Anthony Sansone <[email protected]>

Author: 3 people

snooty.toml

@@ -36,6 +36,7 @@ data-lakes = "Data Lakes"
 data-lake = "Data Lake"
 datadog = "`Datadog <https://www.datadoghq.com/>`__"
 dns = ":abbr:`DNS (Domain Name System)`"
+ejson = ":abbr:`EJSON (Extended Javascript Object Notation)`"
 Epoch-time-ms = "Timestamp in the number of milliseconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
 epoch-time-ms = "timestamp in the number of milliseconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
 Epoch-time = "Timestamp in the number of seconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"

source/databases-collections.txt

@@ -17,7 +17,7 @@ Navigate Your Data
 Once you :ref:`connect to your deployment <vsce-connect>` using |vsce|,
 use the left navigation to:
 
-- Explore your databases, collections, read-only views, and documents. 
+- Explore your databases, collections, read-only views, and documents.
 
 - Create new databases and collections.
 
@@ -31,40 +31,39 @@ use the left navigation to:
 
    .. include:: /includes/fact-required-roles.rst
 
-Databases and Collections
--------------------------
+View Databases and Collections
+------------------------------
 
-When you expand an active connection, |vsce| shows the databases in that
-deployment. Click a database to view the collections it contains.
+When you expand an active connection, |vsce| shows the databases in
+that deployment.
 
-Click a collection to view its documents, schema, and indexes.
+- Click the name of a database to view the collections it contains.
+- Click the name of a collection to view its documents, schema, and
+  indexes.
+
+.. include:: /includes/admonitions/close-all-docs-on-exit.rst
 
 View Collection Documents and Schema
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+When you expand a collection, |vsce| displays the number of documents
+next to the :guilabel:Documents label in the navigation panel.
+
 Documents
 ``````````
 
-When you expand a collection, |vsce| displays that collection's 
-document count next to the :guilabel:`Documents` label in the 
-navigation panel.
-
 When you expand a collection's documents, |vsce| lists the ``_id`` of
 each document in the collection. Click an ``_id`` value to open that
-document in VS Code and view its contents.
+document in |vscode-short| and view its contents.
 
-.. note::
+You may edit this single document:
 
-   You cannot open a single document within a read-only view.
+.. include:: /includes/seq-edit-document.rst
 
-Alternatively, right-click a collection and click
-:guilabel:`View Documents` to view all of the collection's documents
-in an array.
+To view all of the collection's documents in an array, you can:
 
-Opening collection documents provides a **read-only** view of your data.
-To modify your data using |vsce|, use a :ref:`JavaScript Playground
-<vsce-crud>` or launch a shell by right-clicking your active deployment
-in the MongoDB view in the Activity Bar.
+1. Right-click a collection.
+2. Click :guilabel:`View Documents`.
 
 .. include:: /includes/admonitions/document-search-template.rst
 
@@ -87,8 +86,8 @@ field name for a text description of the field's data type.
 Manage Indexes
 ~~~~~~~~~~~~~~
 
-Your collections's indexes are listed under the :guilabel:`Indexes` 
-heading. When you expand an index, each index key appears with an icon 
+Your collections's indexes are listed under the :guilabel:`Indexes`
+heading. When you expand an index, each index key appears with an icon
 designating its type. Index key types include:
 
 - Ascending
@@ -99,15 +98,15 @@ designating its type. Index key types include:
 
 .. note::
 
-   You can open a :ref:`MongoDB Playground <vsce-crud>` 
-   pre-configured to create an index by hovering over the 
-   :guilabel:`Indexes` label in the navigation panel and clicking the 
-   :icon-fa4:`plus` icon that appears.
+   You can open a :ref:`MongoDB Playground <vsce-crud>` pre-configured
+   to create an index by hovering over the :guilabel:`Indexes` label
+   in the navigation panel and clicking the :icon-fa4:`plus` icon that
+   appears.
 
 .. seealso::
 
-   For more information about MongoDB indexes, see the documentation in
-   the :manual:`server manual </indexes>`.
+   To learn more about MongoDB indexes, see the
+   :manual:`server manual </indexes>`.
 
 Create a New Database
 ~~~~~~~~~~~~~~~~~~~~~

source/includes/admonitions/close-all-docs-on-exit.rst

@@ -0,0 +1,3 @@
+.. note::
+
+   |vsce| closes all documents when you close |vscode-short|.

source/includes/seq-edit-document.rst

@@ -0,0 +1,9 @@
+1. At the top of this document, click :guilabel:`Edit Document`.
+   |vsce| opens it as an editable |ejson| document titled ``<database>.<collection>:"<_id>".json``.
+#. Make any edits you require.
+#. Press :kbd:`Ctrl + S` (Windows/Linux) or :kbd:`Cmd + S` to save the
+   edited document to the MongoDB database.
+
+   - If the update succeeds, |vsce| confirms that the database has
+     stored the change.
+   - If the update results in an error, |vsce| displays it.

source/read-document-playground.txt

@@ -12,15 +12,15 @@ Read Documents
    :depth: 1
    :class: singlecol
 
-You can read documents in a collection using the 
+.. |findOne| replace:: :manual:`findOne() </reference/method/db.collection.findOne>`
+.. |findAny| replace:: :manual:`find() </reference/method/db.collection.find>`
+
+
+You can read documents in a collection using the
 :manual:`MongoDB CRUD Operators </crud>` in a MongoDB Playground:
 
-- Use the :manual:`findOne() 
-  </reference/method/db.collection.findOne>` method to read one
-  document.
-- Use the :manual:`find() 
-  </reference/method/db.collection.find>` method to read more 
-  than one document.
+- Use the |findOne| method to read one document.
+- Use the |findAny| method to read more than one document.
 
 .. include:: /includes/admonitions/document-search-template.rst
 
@@ -30,10 +30,8 @@ Prerequisites
 If you have not done so already, you must complete the following 
 prerequisites before you can read documents with a MongoDB Playground:
 
-- :ref:`Create a connection to a MongoDB deployment 
-  <vsce-connect-task>`.
-- :ref:`Activate the connection to the MongoDB deployment 
-  <vsce-activate-connection>`.
+- :ref:`Create a connection to a MongoDB deployment <vsce-connect-task>`.
+- :ref:`Activate the connection to the MongoDB deployment <vsce-activate-connection>`.
 - :ref:`Open a MongoDB Playground <open-playground-for-crud-vsce>`.
 - :ref:`vsce-create-doc-playground` or create documents in a collection
   using a different method.
@@ -55,12 +53,16 @@ document according to the
 :manual:`natural order </reference/glossary/#term-natural-order>` which
 reflects the order of documents on the disk.
 
-For a detailed description of this method's parameters,
-see :manual:`findOne() </reference/method/db.collection.findOne>`
-in the MongoDB Manual.
+To learn more about this method's parameters, see |findOne| in the
+MongoDB Manual.
 
 .. include:: /includes/run-playground.rst
 
+You may edit any |json| document returned from a |findOne| or |findAny|
+operation.
+
+.. include:: /includes/seq-edit-document.rst
+
 Example
 ~~~~~~~