(DOCSP-6532): Insert documents in JSON Mode

Author: jeff-allen-mongo

Makefile

@@ -18,15 +18,15 @@ help: ## Show this help message
 	@echo 'Variables'
 	@printf "  \033[36m%-18s\033[0m %s\n" 'ARGS' 'Arguments to pass to mut-publish'
 
-html:  migrate-assets ## Builds this branch's HTML under build/<branch>/html
+html: ## Builds this branch's HTML under build/<branch>/html
 	giza make html
 
 ## Builds this branch's HTML under build/<branch>/html
-clean-html: migrate-assets
+clean-html: 
 	rm -rf build/${GIT_BRANCH}
 	giza make html
 
-publish: migrate-assets ## Builds this branch's publishable HTML and other artifacts under build/public
+publish: ## Builds this branch's publishable HTML and other artifacts under build/public
 	giza make publish
 	if [ ${GIT_BRANCH} = master ]; then mut-redirects config/redirects -o build/public/.htaccess; fi
 

source/documents/insert.txt

@@ -12,45 +12,46 @@ Insert Documents
    :depth: 1
    :class: singlecol
 
-Click the :guilabel:`Insert Document` button to insert a new document:
+.. important::
 
-.. figure:: /images/compass/insert-button.png
-  :figwidth: 816px
+   Inserting documents is not permitted in
+   :guilabel:`MongoDB Compass Readonly Edition`.
 
-The insert dialog appears:
+|compass-short| provides two ways to insert documents into your
+collections: JSON Mode and a Field-by-Field Editor.
 
-.. figure:: /images/compass/insert-document.png
-  :figwidth: 598px
+JSON Mode
+  Allows you to write or paste JSON documents in the editor. Use
+  this mode to insert multiple documents at once as an array.
 
-For each field in the document, select field type and fill in the
-field name and value.
+Field-by-Field Editor
+  Provides a more interactive experience to create documents, allowing
+  you to select individual field values and types. This mode only
+  supports inserting one document at a time.
 
-.. figure:: /images/compass/insert-document2.png
-  :figwidth: 627px
+Procedure
+---------
 
-.. tip::
+To insert documents into your collection:
 
-   For the field values, you can paste valid JSON that can be parsed by
-   JavaScript's ``JSON.parse``.
+1. Click the :guilabel:`Add Data` dropdown and select
+   :guilabel:`Insert Document`.
 
-   - If the pasted JSON is an Array, the first character must be a left
-     bracket ``[`` and the last character must be a right bracket ``]``:
+   .. figure:: /images/compass/insert-button.png
+     :figwidth: 590px
 
-     .. code-block:: javascript
+2. Select the appropriate view based on how you would like to
+   insert documents.
 
-        [ "first", "second", 3 ]
+   - Click the ``{ }`` brackets for JSON view. This is the default
+     view.
 
-   - If the pasted JSON is an Object (i.e. a document), the keys must
-     be quoted in double quotes and are permitted to be escaped. The
-     first character must be left curly brace ``{`` and the last must
-     be right curly brace ``}``:
+   - Click the list icon for Field-by-Field mode.
 
-     .. code-block:: javascript
+   |
 
-        {
-          "email": "[email protected]",
-          "phone": "555-555-1212"
-        }
+   .. figure:: /images/compass/insert-document-view-select.png
+     :figwidth: 590px
 
 Limitation
 ----------
@@ -61,35 +62,74 @@ to a :atlas:`Data Lake </data-lake>`.
 Add New Fields
 --------------
 
-To add a new field for the document, hover over the row number in the
-dialog (the row number is not part of the document but the dialog
-display) and click on the plus sign add a new field after the field.
+   .. tabs::
 
-.. figure:: /images/compass/insert-document-new-field.svg
-  :figwidth: 621px
+      .. tab:: JSON View
+         :tabid: json
 
-You can also add a new field at the end by clicking the Tab from the
-value of the last field.
+         |
 
-.. tip::
+         3. In JSON format, type or paste the document(s) you want to
+            insert into the collection. To insert multiple documents,
+            enter a comma-separated array of JSON documents.
 
-   To add a new field after an array or a document field, hover over
-   the row number in the dialog (the row number is not part of the
-   document but the dialog display) and click on the plus sign add a
-   new field after the field.
+            .. example::
 
-Change Field Type
------------------
+               The following array inserts 5 documents into
+               the collection:
 
-You can change the data type of a field by using the data type
-selectors on the right of the field.
+               .. code-block:: json
 
-.. figure:: /images/compass/insert-document3.png
-  :figwidth: 644px
+                  [
+                    { "_id" : 8752, "title" : "Divine Comedy", "author" : "Dante", "copies" : 1 },
+                    { "_id" : 7000, "title" : "The Odyssey", "author" : "Homer", "copies" : 10 },
+                    { "_id" : 7020, "title" : "Iliad", "author" : "Homer", "copies" : 10 },
+                    { "_id" : 8645, "title" : "Eclogues", "author" : "Dante", "copies" : 2 },
+                    { "_id" : 8751, "title" : "The Banquet", "author" : "Dante", "copies" : 2 }
+                  ]
 
-To change the ``_id`` field to use a custom value, change
-the data type from ``ObjectID`` to ``string`` and then overwrite the
-``_id`` value:
+         4. Click :guilabel:`Insert`.
 
-.. figure:: /images/compass/insert-document4.png
-  :figwidth: 626px
+      .. tab:: Field-by-Field Editor
+         :tabid: field-by-field
+
+         |
+
+         3. For each field in the document, select field type and fill
+            in the field name and value.
+
+            .. figure:: /images/compass/insert-document2.png
+              :figwidth: 590px
+
+         Add New Fields
+         ~~~~~~~~~~~~~~
+
+         To add a new field in the document, hover over the row number
+         in the dialog (the row number is not part of the document but
+         the dialog display) and click the :icon-fa5:`plus` icon to
+         add a new field after the selected row.
+
+         You can also add a new field at the end of the document by
+         pressing the tab key when your text cursor is in the value of
+         the last document field.
+
+         .. figure:: /images/compass/insert-document-new-field.png
+           :figwidth: 590px
+
+         Change Field Type
+         ~~~~~~~~~~~~~~~~~
+
+         You can change the data type of a field by using the data
+         type selectors on the right of the field.
+
+         .. figure:: /images/compass/insert-document3.png
+           :figwidth: 590px
+
+         To change the ``_id`` field to use a custom value, change the
+         data type from ``ObjectID`` to ``string`` and then overwrite
+         the ``_id`` value:
+
+         .. figure:: /images/compass/insert-document4.png
+           :figwidth: 590px
+
+         4. Click :guilabel:`Insert`.

source/documents/modify.txt

@@ -6,6 +6,11 @@ Modify Documents
 
 .. default-domain:: mongodb
 
+You can edit existing documents in your collection. When you edit
+a document, |compass-short| performs a
+:manual:`findAndModify </reference/method/db.collection.findAndModify/>`
+operation to update the document.
+
 Select the appropriate tab based on whether you are viewing your
 documents in List, JSON, or Table view:
 
@@ -72,9 +77,11 @@ documents in List, JSON, or Table view:
       .. figure:: /images/compass/update-field.png
         :figwidth: 740px
 
+      Save Changes
+      ------------
+
       When you are finished editing the document, click the ``Update``
-      button to commit your changes. Compass performs a
-      ``findAndModify`` operation to update the document.
+      button to commit your changes.
 
       Revert a Change
       ---------------
@@ -98,6 +105,10 @@ documents in List, JSON, or Table view:
       You can now add, remove, and edit field values by modifying
       the JSON document.
 
+      By default, embedded objects and arrays are hidden. To expand
+      these values, click the field arrow.
+      
+
    .. tab:: Table View
       :tabid: table-view
 
@@ -134,6 +145,10 @@ documents in List, JSON, or Table view:
 
       #. Click :guilabel:`Add Field after <Field Name>`.
 
+      #. Populate your newly created field.
+
+      #. Click :guilabel:`Update` to confirm your changes.
+
       Revert a Change
       ---------------