DOCSP-45692-intellij-final-cleanup (#15)

ajhuh-mdb · web-flow · commit d65d1f881b17 · 2024-12-03T11:44:40.000-05:00
* DOCSP-45692-intellij-final-cleanup * * * * * * * edit learn more links * * * * * SO feedback * * * image sizing * image sizing * *
diff --git a/snooty.toml b/snooty.toml
@@ -2,7 +2,8 @@ name = "intellij"
 title = "MongoDB for IntelliJ Plugin"
 
 intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv",
-                "https://www.mongodb.com/docs/atlas/objects.inv"
+                "https://www.mongodb.com/docs/atlas/objects.inv",
+                "https://www.mongodb.com/docs/mongodb-shell/objects.inv"
               ]
 
 toc_landing_pages = [
diff --git a/source/autocomplete.txt b/source/autocomplete.txt
@@ -26,7 +26,7 @@ Autocomplete
 
 The {+intellij-full+} provides autocomplete suggestions for database, 
 collection, or field names based on the connected data source. For example, 
-when you type a field name in a query, the plugin analyzes the MongoDB 
+when you start typing a field name in a query, the plugin analyzes the MongoDB 
 collection and document schema to automatically suggest valid field names. 
 
 To use the autocomplete feature, start typing in a document field, collection, 
@@ -42,7 +42,7 @@ method of a ``MongoClient`` instance.
 
 The {+intellij-short+} displays a drop-down list of available database names, 
 denoted by the ``MongoDB Database`` text and the database icon, as shown in 
-the image below: 
+the following image: 
 
 .. image:: /images/database-autocomplete.png
    :alt: Autocomplete database names in the IntelliJ Plugin.
@@ -56,7 +56,7 @@ method of a ``MongoClient`` instance.
 
 The {+intellij-short+} displays a drop-down list of available collection names, 
 denoted by the ``MongoDB Collection`` text and the collection icon, as shown in 
-the image below: 
+the following image: 
 
 .. image:: /images/collection-autocomplete.png
    :alt: Autocomplete collections names in the IntelliJ Plugin.
@@ -88,8 +88,8 @@ methods:
 - ``updateOne``
 
 The {+intellij-short+} displays a drop-down list of available field names, 
-denoted by their data type and the document icon. For example, the image 
-below shows autocomplete suggestions for fields that start with ``rat`` in the 
+denoted by their data type and the document icon. For example, the following 
+image shows autocomplete suggestions for fields that start with ``rat`` in the 
 ``sample_mflix.movies`` collection: 
 
 .. image:: /images/document-autocomplete.png
diff --git a/source/connect.txt b/source/connect.txt
@@ -20,7 +20,7 @@ Connect to Your MongoDB Deployment
    :depth: 1
    :class: singlecol
 
-This task page shows you how to connect to your MongoDB deployment using
+On this page, you'll learn how to connect to your MongoDB deployment using
 the {+intellij-full+}.
 
 .. note:: MongoDB Atlas
@@ -32,11 +32,11 @@ the {+intellij-full+}.
    copyable URI to easily connect the {+intellij-short+} to your 
    deployment.
 
-Prerequisites
--------------
+Before You Begin
+----------------
 
 Ensure that an instance of MongoDB is running and the {+intellij-short+}
-is installed.
+is :ref:`installed <intellij-install>`.
 
 Steps
 -----
@@ -51,6 +51,7 @@ Steps
       
       .. image:: /images/connect/intellij-database-explorer.png 
          :alt: Click the Database Explorer icon.
+         :width: 600px
 
    .. step:: Select MongoDB as the data source.
 
@@ -59,6 +60,7 @@ Steps
 
       .. image:: /images/connect/intellij-select-data-source.png
          :alt: Click the + button > Data Source > MongoDB.
+         :width: 600px
 
    .. step:: Enter your connection string.
 
@@ -74,14 +76,14 @@ Steps
 
    .. step:: (*Optional*) Select databases to load.
 
-      You should see the connected MongoDB data source in Database 
-      Explorer. 
+      Find the connected MongoDB data source in Database Explorer. 
 
       You can load as many databases as you’d like by clicking on 
-      ``1 of 11`` text as shown below:
+      ``1 of 11`` text as shown in the following image.
 
       .. image:: /images/connect/intellij-select-databases-to-load.png
          :alt: Select the databases to load.
+         :width: 600px
 
    .. step:: Select a data source using the Connections Toolbar.
 
@@ -90,12 +92,12 @@ Steps
       from within the editor window.
       
       When you open a file that contains MongoDB code, a toolbar appears at 
-      the top of the file as shown in the image below.
+      the top of the file as shown in the following image.
       
       .. image:: /images/connect/intellij-connections-toolbar.png
          :alt: The Connections Toolbar appears at the top of the file.
       
-      This toolbar has a drop-down that allows you to select a data source 
+      This toolbar has a drop-down menu that allows you to select a data source 
       associated with your application. 
       
       For the best experience, the data source you select should 
@@ -112,11 +114,16 @@ Steps
 
       .. image:: /images/connect/intellij-launch-playgrounds.png
          :alt: To launch the Playgrounds, click the highlighted button in Database Explorer.
-
+         :width: 600px
 
 Next Steps 
 ----------
 
-- :ref:`<intellij-type-validation>`
 - :ref:`<intellij-autocomplete>`
+- :ref:`<intellij-type-validation>`
 - :ref:`<intellij-index-warning>`
+
+Learn More 
+----------
+
+- :ref:`mongodb-uri`
diff --git a/source/db-reference-validation.txt b/source/db-reference-validation.txt
@@ -100,8 +100,11 @@ The sample code attempts to call a ``restaurant_name`` collection:
 Because the collection doesn't exist in the ``sample_mflix`` database, the 
 {+intellij-short+} raises a warning that the collection cannot be resolved:
 
-``Cannot resolve "restaurant_name" collection in "sample_mflix" database in the 
-connected data source.``
+.. code-block:: none
+   :copyable: false 
+   
+   Cannot resolve "restaurant_name" collection in "sample_mflix" database in the 
+   connected data source.``
 
 To resolve the warning, reference a collection that exists in the 
 ``sample_mflix`` database: 
@@ -122,3 +125,4 @@ Learn More
 
 - :ref:`intellij-connect`
 - :ref:`intellij-autocomplete`
+- :ref:`intellij-type-validation`
diff --git a/source/images/connect/intellij-database-explorer.png b/source/images/connect/intellij-database-explorer.png
diff --git a/source/images/connect/intellij-select-data-source.png b/source/images/connect/intellij-select-data-source.png
diff --git a/source/index-warning.txt b/source/index-warning.txt
@@ -115,6 +115,5 @@ To disable the index warning in the plugin:
 Learn More
 ----------
 
-- :ref:`intellij-connect`
-- :ref:`intellij-autocomplete`
-- :ref:`intellij-type-validation`
+- :ref:`indexes`
+- :ref:`Operational Factors and Data Models <data-model-indexes>`
diff --git a/source/index.txt b/source/index.txt
@@ -40,7 +40,7 @@ The {+intellij-short+} currently supports the following features:
 - :ref:`Database reference validation <intellij-db-reference-validation>`.
 - :ref:`Type validation <intellij-type-validation>` of document fields.
 - :ref:`Missing index warnings <intellij-index-warning>` for Java queries.
-- :ref:`Run Java Queries <intellij-run-java-queries>` directly in the
+- :ref:`Running Java queries <intellij-run-java-queries>` directly in the
   Database Explorer Playgrounds.
 
 Get Started 
@@ -55,10 +55,10 @@ Get Started
 Submit Feedback 
 ---------------
 
-To report a bugs, request a feature, or submit general feedback, open a 
+To report bugs, request a feature, or submit general feedback, open a 
 ticket in the `MongoDB for IntelliJ Plugin JIRA project <https://jira.mongodb.org/projects/INTELLIJ/issues/>`__.
 
-To learn more about submitting feedback, see :ref:`intellij-submit-feedback`.
+To learn more, see :ref:`intellij-submit-feedback`.
 
 .. toctree::
    :titlesonly:
diff --git a/source/install.txt b/source/install.txt
@@ -23,11 +23,10 @@ Install the MongoDB for IntelliJ Plugin
 To install the {+intellij-full+} from the JetBrains Marketplace, follow the 
 steps on this page. 
 
-Prerequisites
--------------
+Before You Begin
+----------------
 
-To install the {+intellij-short+}, ensure that you install IntelliJ IDEA 
-Ultimate 2024.1.1 or later.
+Ensure that you install IntelliJ IDEA Ultimate 2024.1.1 or later.
 
 To check your current version of IntelliJ IDEA, open the 
 :guilabel:`IntelliJ IDEA` system menu and click :guilabel:`About IntelliJ IDEA`.
@@ -43,17 +42,18 @@ Steps
       Open the :guilabel:`IntelliJ IDEA` system menu and click 
       :guilabel:`Settings`.
 
-      Alternatively, you can press :kbd:`Cmd` + :kbd:`,` on macOS or 
-      :kbd:`Ctrl` + :kbd:`Alt` + :kbd:`S` on Windows and Linux.
+      Alternatively, press :kbd:`Cmd` + :kbd:`,` on macOS or :kbd:`Ctrl` + 
+      :kbd:`Alt` + :kbd:`S` on Windows and Linux.
 
-   .. step:: Show the Plugins tab. 
+   .. step:: Show the Plugins settings. 
 
       In the left-hand navigation column, click :guilabel:`Plugins`.
 
    .. step:: Open the Custom Plugin Repositories modal. 
 
       Click the gear icon next to the :guilabel:`Installed` tab to open a 
-      drop-down menu and select :guilabel:`Manage Plugin Repositories`.
+      drop-down menu. In the drop-down menu, select 
+      :guilabel:`Manage Plugin Repositories`.
 
       .. image:: /images/intellij-plugin-settings.png
          :alt: Click the gear icon to open the plugin settings.
@@ -71,13 +71,13 @@ Steps
 
    .. step:: Click OK and Restart the IDE. 
 
-      After you restart the IDE, open the :guilabel:`Settings` and 
-      navigate to the :guilabel:`Plugins` menu again.
+      After you restart the IDE, open the :guilabel:`Settings` menu and 
+      click :guilabel:`Plugins` again.
 
    .. step:: Search for the MongoDB Plugin. 
 
-      In the :guilabel:`Marketplace` tab of the :guilabel:`Plugins` menu, search 
-      for ``MongoDB``. 
+      In the :guilabel:`Marketplace` tab of the :guilabel:`Plugins` settings, 
+      search for ``MongoDB``. 
 
       .. important:: 
 
@@ -90,8 +90,7 @@ Steps
 
    .. step:: Click the Install button.
 
-      After you install the {+intellij-short+}, click :guilabel:`OK` in the 
-      bottom right-hand corner of the :guilabel:`Settings` menu.
+      After you install the {+intellij-short+}, click :guilabel:`OK`.
 
 
 Next Steps 
diff --git a/source/logs.txt b/source/logs.txt
@@ -27,30 +27,37 @@ About This Task
 ---------------
 
 Log files help the MongoDB development team diagnose bugs in the 
-{+intellij-short+}. When you retrieve log files, IntelliJ generates a zip with 
+{+intellij-short+}. When you retrieve logs, IntelliJ generates a zip file with 
 the following contents:
 
 - General information about the IDE installation such as version, host OS, host 
-  CPU, available memory, other plugins that might affect current functionality.
+  CPU, available memory, and other plugins that might affect current 
+  functionality.
 - Thread dumps of the current state of IntelliJ. 
 - Internal state of the UI.
 - OpenTelemetry metrics from IntelliJ.
-- Logs of all the plugins, including the {+intellij-full+}.
+- Logs of all plugins, including the {+intellij-full+}.
 
 Steps
 -----
 
 .. procedure:: 
    :style: normal
 
-   .. step:: In the IntelliJ top menu bar, click Help.
+   .. step:: Open the Help menu. 
+      
+      In the IntelliJ top menu bar, click :guilabel:`Help`.
+
+   .. step:: Click Collect Logs and Diagnostic Data. 
 
-   .. step:: In the Help menu, click Collect Logs and Diagnostic Data. 
-     
+      In the drop-down menu, click :guilabel:`Collect Logs and Diagnostic Data`.
+      
       A pop-up warning appears, mentioning that the collected information might 
       contain sensitive data. 
       
-   .. step:: Click Show in Finder.
+   .. step:: Download the log files.
+      
+      Click Show in Finder.
 
 Learn More 
 ----------
diff --git a/source/run-java-queries.txt b/source/run-java-queries.txt
@@ -30,15 +30,15 @@ Definition
 The {+intellij-full+} enables you to run queries written in Java directly 
 in the Database Explorer Playgrounds. 
 
-The Run button appears next to your MongoDB queries.
+The Run icon appears next to your MongoDB queries.
 
 .. image:: /images/run-queries/intellij-run-icon.png
-   :alt: Click the Run button to convert your Java query to mongosh syntax.
+   :alt: Click the Run icon to convert your Java query to mongosh syntax.
 
 Behavior
 --------
 
-When you click the Run button, the plugin automatically converts your 
+When you click the Run icon, the plugin automatically converts your 
 Java query to ``mongosh`` syntax and opens a Playground file with the 
 populated query.
 
@@ -62,8 +62,8 @@ resembles the following:
       )).into(new ArrayList<>());
    }
 
-The code example below shows the converted query from the Java code 
-above.
+The following code example shows the converted query from the Java code 
+above:
 
 .. code:: javascript
    :copyable: true
@@ -89,4 +89,4 @@ Once you are satisfied with the query, you can run it in the Playground
 and view the query results.
 
 .. image:: /images/run-queries/intellij-pg-icon-converted-query.png
-   :alt: Click the Run button to run your query and view the results.
+   :alt: Click Run to run your query and view the results.
diff --git a/source/submit-feedback.txt b/source/submit-feedback.txt
@@ -20,7 +20,7 @@ Submit Feedback
    :depth: 1
    :class: singlecol
 
-To report a bugs, request a feature, or submit general feedback, follow the 
+To report a bug, request a feature, or submit general feedback, follow the 
 procedures on this page to open a ticket in the 
 `MongoDB for IntelliJ Plugin JIRA project <https://jira.mongodb.org/projects/INTELLIJ/issues/>`__.
 
diff --git a/source/type-validation.txt b/source/type-validation.txt
@@ -28,11 +28,11 @@ Definition
 ----------
 
 The {+intellij-full+} examines the document fields in queries to ensure
-the data types are valid. For example, if you use a document field in an
+that the data types match. For example, if you use a ``String`` field in an
 equality comparison, or an insert or update operation, the
-plugin examines the field to ensure the type is valid.
+plugin examines the field value to ensure the type is also a ``String``.
 
-If the type is invalid, the plugin shows a warning that indicates
+If the value type is invalid, the plugin shows a warning that indicates
 the type cannot be assigned.
 
 To resolve the warning, change the field value to match the expected
@@ -70,7 +70,6 @@ example: ``"start"``.
 Learn More
 ----------
 
-- :ref:`intellij-connect`
-- :ref:`intellij-autocomplete`
+- :ref:`bson-types`
+- :ref:`intellij-db-reference-validation`
 - :ref:`intellij-index-warning`
-- :ref:`intellij-run-java-queries`

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,8 @@ name = "intellij"`
`2`	`2`	`title = "MongoDB for IntelliJ Plugin"`
`3`	`3`
`4`	`4`	`intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv",`
`5`		`- "https://www.mongodb.com/docs/atlas/objects.inv"`
	`5`	`+ "https://www.mongodb.com/docs/atlas/objects.inv",`
	`6`	`+ "https://www.mongodb.com/docs/mongodb-shell/objects.inv"`
`6`	`7`	`]`
`7`	`8`
`8`	`9`	`toc_landing_pages = [`