DOCSP-26400 Connection Import/Export via Compass UI (#462)

* DOCSP-26400 Connection Import/Export via Compass UI

* add new pages to TOC

* add to sub-page toc

* shorten titles + edit styling for procedures

* copy cleanup

* more copy cleanup

* try to remove steps from toc

* fix import page

* add newlines to fix styling

* results section

* JA edits (pt 1)

* fix TOC

* toc adjustments

* change on compass to in compass

* JA edits pt (?)

* change order of in-page toc

* JA edits

* add newline between title and default-domain

* fix build error

* AH edits

* swap out favorite for saved

* typo fixes

Author: ajhuh-mdb

snooty.toml

@@ -11,7 +11,7 @@ toc_landing_pages = [
     "/install", 
     "/connect",
     "/connect/favorite-connections",
-    "/connect/favorite-connections/import-export-cli/",
+    "/connect/favorite-connections/import-export/",
     "/instance", 
     "/config-file",
     "/command-line-options", 

source/connect/favorite-connections.txt

@@ -56,4 +56,4 @@ Considerations
 .. toctree::
    :titlesonly:
 
-   /connect/favorite-connections/import-export-cli
+   /connect/favorite-connections/import-export

source/connect/favorite-connections/import-export-cli.txt

@@ -1,8 +1,8 @@
 .. _compass-export-connections-cli:
 
-========================================
-Export Favorite Connections with the CLI
-========================================
+=====================================
+Export Saved Connections with the CLI
+=====================================
 
 .. default-domain:: mongodb
 
@@ -13,32 +13,27 @@ Export Favorite Connections with the CLI
    :class: singlecol
 
 You can use the |compass-short| :abbr:`CLI (Command-Line Interface)` to
-export favorite connections. Colleagues can import your favorites, or
+export saved connections. Colleagues can import your saved connections, or
 you can use them yourself in your other workspaces.
 
 About This Task
 ---------------
 
-When you export favorite connections, |compass-short| exports the list
-of connections as a JSON file.
-
-By default, when you export favorite connections, database usernames and
-passwords are included in plaintext. To protect sensitive connection
-information, you may encrypt the exported file with a passphrase.
+.. include:: /includes/fact-export-saved-connection.rst
 
 .. _compass-export-connections-cli-encrypted:
 
-Export Encrypted Favorite Connections
+Export Encrypted Saved Connections
 -------------------------------------
 
-This section shows how to export encrypted favorite connections. When
+This section shows how to export encrypted saved connections. When
 you encrypt the export file, users must specify the matching passphrase
 to import the connections.
 
 Procedure
 ~~~~~~~~~
 
-To export encrypted favorite connections with the |compass-short|
+To export encrypted saved connections with the |compass-short|
 :abbr:`CLI (Command-Line Interface)`, specify:
 
 - The path to the |compass| executable. The name and file path of the
@@ -61,7 +56,7 @@ Your operation should resemble the following prototype:
 Example
 ~~~~~~~
 
-This example exports favorite |compass-short| connections to a file with
+This example exports saved |compass-short| connections to a file with
 the path ``/tmp/compass-connections/favorites-encrypted.json``. The exported file
 is encrypted with the passphrase ``abc123``.
 
@@ -139,18 +134,18 @@ following:
 Sensitive connection information is encrypted in the
 ``connectionSecrets`` field.
 
-Export Unencrypted Favorite Connections
+Export Unencrypted Saved Connections
 ---------------------------------------
 
-This section shows how to export unencrypted favorite connections. If
+This section shows how to export unencrypted saved connections. If
 you do not encrypt the export file, database usernames and passwords are
 exported in plaintext. Only export unencrypted connections if no other
 users will have access to the exported file.
 
 Procedure
 ~~~~~~~~~
 
-To export encrypted favorite connections with the |compass-short|
+To export encrypted saved connections with the |compass-short|
 :abbr:`CLI (Command-Line Interface)`, specify:
 
 - The path to the |compass| executable. The name and file path of the
@@ -169,7 +164,7 @@ Your operation should resemble the following prototype:
 Example
 ~~~~~~~
 
-This example exports favorite |compass-short| connections to a file with
+This example exports saved |compass-short| connections to a file with
 the path ``/tmp/compass-connections/favorites.json``.
 
 Run the following command in the folder containing your MongoDB Compass

source/connect/favorite-connections/import-export-cli/export.txt

@@ -1,8 +1,8 @@
 .. _compass-import-connections-cli:
 
-========================================
-Import Favorite Connections with the CLI
-========================================
+=====================================
+Import Saved Connections with the CLI
+=====================================
 
 .. default-domain:: mongodb
 
@@ -13,35 +13,35 @@ Import Favorite Connections with the CLI
    :class: singlecol
 
 You can use the |compass-short| :abbr:`CLI (Command-Line Interface)` to
-import favorite connections. This lets you use saved connections from
+import saved connections. This lets you use saved connections from
 other workspaces or connections used by other team members.
 
 Prerequisite
 ------------
 
-To import favorite connections, you must first :ref:`export the
+To import saved connections, you must first :ref:`export the
 connections <compass-export-connections-cli>`.
 
 .. _compass-import-connections-cli-encrypted:
 
-Import Encrypted Favorite Connections
--------------------------------------
+Import Encrypted Saved Connections
+----------------------------------
 
-Use this procedure to import a list of favorite connections that is
+Use this procedure to import a list of saved connections that is
 :ref:`encrypted with a passphrase
 <compass-export-connections-cli-encrypted>`.
 
 Procedure
 ~~~~~~~~~
 
-To import unencrypted favorite connections with the |compass-short|
+To import unencrypted saved connections with the |compass-short|
 :abbr:`CLI (Command-Line Interface)`, specify:
 
 - The path to the |compass| executable. The name and filepath of the
   executable depend on your operating system.
 
 - The ``--import-connections`` option set to the destination of the file
-  containing favorite connections.
+  containing saved connections.
 
 - The ``--passphrase`` option set to the passphrase used to encrypt the
   exported file.
@@ -57,7 +57,7 @@ Your operation should resemble the following prototype:
 Example
 ~~~~~~~
 
-The following example imports favorite |compass-short| connections from
+The following example imports saved |compass-short| connections from
 a file with the path
 ``/tmp/compass-connections/favorites-encrypted.json`` that is encrypted
 with the passphrase ``abc123``.
@@ -92,7 +92,7 @@ MongoDB Compass starts and you will see the imported connections under
 Errors
 ~~~~~~
 
-When you try to import encrypted favorite connections, you may
+When you try to import encrypted saved connections, you may
 see these errors:
 
 - If do not specify a passphrase, you will see this error:
@@ -111,23 +111,23 @@ see these errors:
      Failed to perform operation Be [Error]: Cannot decrypt due to corrupt
      data or wrong passphrase
 
-Import Unencrypted Favorite Connections
+Import Unencrypted Saved Connections
 ---------------------------------------
 
-Use this procedure to import a list of favorite connections that is not
+Use this procedure to import a list of saved connections that is not
 encrypted with a passphrase.
 
 Procedure
 ~~~~~~~~~
 
-To import unencrypted favorite connections with the |compass-short|
+To import unencrypted saved connections with the |compass-short|
 :abbr:`CLI (Command-Line Interface)`, specify:
 
 - The path to the |compass| executable. The name and file path of the
   executable depend on your operating system.
 
 - The ``--import-connections`` option set to the destination of the file
-  containing favorite connections.
+  containing saved connections.
 
 Your operation should resemble the following prototype:
 
@@ -138,7 +138,7 @@ Your operation should resemble the following prototype:
 Example
 ~~~~~~~
 
-The following example imports favorite |compass-short| connections from
+The following example imports saved |compass-short| connections from
 a file with the path ``/tmp/compass-connections/favorites.json``.
 
 Run the following command in the folder containing your MongoDB Compass

source/connect/favorite-connections/import-export-cli/import.txt

@@ -0,0 +1,62 @@
+.. _compass-export-connections-ui:
+
+===========================================
+Export Saved Connections in |compass-short|
+===========================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+You can export saved connections in |compass|. Colleagues can import your 
+saved connections, or you can use them in your other workspaces.
+
+About This Task
+---------------
+
+.. include:: /includes/fact-export-saved-connection.rst
+
+Procedure
+---------
+
+To export encrypted saved connections with |compass-short|:
+
+.. procedure::
+   :style: normal
+   
+   .. step:: On the Connect screen, hover over :guilabel:`Saved Connections` in 
+      the left-side navigation and click the :guilabel:`Ellipses (...)` button.
+
+   .. step:: Select :guilabel:`Export saved connections`. 
+    
+   .. step:: In the :guilabel:`Export saved connections` dialog box, select the 
+      connection names you want to export. 
+        
+   .. step:: Under :guilabel:`Target File`, click :guilabel:`Select a file...` 
+      to specify the output file destination.
+
+   .. step:: *Optional*. Toggle :guilabel:`Remove secrets` to omit passwords, 
+      access tokens, and other sensitive information from the exported file.
+
+      If you select :guilabel:`Remove secrets`, you cannot specify an encryption 
+      password.
+    
+   .. step:: *Optional*. Specify an :guilabel:`Encryption Password` to encrypt 
+      passwords, access tokens, and other sensitive information.
+        
+      If you do not encrypt the export file, passwords are exported in 
+      plaintext. Only export unencrypted connections if no other users will have 
+      access to the exported file.
+
+   .. step:: Click :guilabel:`Export` to export your saved connections to 
+      a JSON file.
+
+Next Steps
+----------
+
+To learn how to import saved connections, see
+:ref:`compass-import-connections-ui`.

source/connect/favorite-connections/import-export-ui/export.txt

@@ -0,0 +1,57 @@
+.. _compass-import-connections-ui:
+
+===========================================
+Import Saved Connections in |compass-short|
+===========================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+You can import saved connections in |compass|. This lets you use saved 
+connections from other workspaces or connections used by other team members.
+
+Prerequisite
+------------
+
+Before you import saved connections, you must :ref:`export the
+connections <compass-export-connections-ui>`.
+
+Procedure
+---------
+
+To import saved connections from a JSON file into |compass-short|:
+
+.. procedure:: 
+   :style: normal
+   
+   .. step:: On the Connect screen, hover over :guilabel:`Saved Connections` 
+      in the left-side navigation and click the :guilabel:`Ellipses (...)` 
+      button.
+
+   .. step:: Select :guilabel:`Import saved connections`.
+
+   .. step:: Under :guilabel:`Source File`, click :guilabel:`Select a file`. 
+        
+   .. step:: Select the exported JSON file you want to import.
+
+   .. step:: If your file is encrypted with a password, enter the passphrase 
+      under :guilabel:`Decryption Password`.
+    
+   .. step:: Select the connection names you want to import. 
+    
+      If the connection name already exists under your saved connections, 
+      |compass-short| overwrites the existing connection with the imported 
+      connection.
+      
+   .. step:: Click :guilabel:`Import`.
+        
+Results
+-------
+
+After the connections are imported, they appear on the left-side 
+navigation of the Connect screen under :guilabel:`Saved Connections`.