Merge pull request #4 from sarahsimpers/DOCSP-21488

Makes approved changes from cloud-docs PR and resolves errors

Author: sarahsimpers

snooty.toml

@@ -25,6 +25,8 @@ data-lake = "Atlas Data Lake"
 data-lake-short = "Data Lake"
 data-lake-stores = "data stores"
 data-lake-store = "data store"
+database-deployment = "database deployment"
+database-deployments = "database deployments"
 default-profile = ":ref:`default profile <mcli-profiles>`"
 mcli = "MongoDB CLI"
 mcli-long = "MongoDB Command Line Interface (``mongocli``)"

source/atlas-cli-env-variables.txt

@@ -19,7 +19,7 @@ Precedence
 
 - When you run any command, each setting that you specify with an
   environment variable takes precedence over the :ref:`profile stored in the
-  configuration file <atlas-cli-save-connection-settings>`.
+  configuration file <atlas-cli-profiles>`.
 
 - When you run a command using the ``--projectId`` option, the command
   line option takes precedence over both the environment variable and

source/atlas-cli-profiles.txt

@@ -28,7 +28,7 @@ Prerequisites
 
 Before you begin, complete the following tasks: 
 
-- Create an :doc:`Atlas organization </organizations-projects/>`
+- Create an :atlas:`Atlas organization </organizations-projects/>`
 - :ref:`install-atlas-cli` 
 - :ref:`connect-atlas-cli`
 

source/atlas-cli-quickstart.txt

@@ -1,4 +1,4 @@
-.. _atlas-cli-save-connection-settings:
+.. _atlas-cli-profiles:
 
 ========================
 Save Connection Settings
@@ -12,8 +12,209 @@ Save Connection Settings
    :depth: 1
    :class: singlecol
 
-Content Placeholder
+You can save your frequently-used connection settings as profiles.
+Profiles store the project IDs, organization
+IDs, and, optionally, |api| keys to use in future {+atlas-cli+}
+sessions. To save time, you can specify a profile instead of using the
+``--projectId`` and ``--orgId`` flags with each command. The {+atlas-cli+}
+stores your profiles in a :ref:`configuration file <config-toml-location>` 
+called ``config.toml``. 
+
+.. note:: 
+
+   Any settings stored in :ref:`environment variables <atlas-cli-env-vars>`
+   take precedence over settings stored in profiles. Any project or organization
+   specified with the ``--projectId`` and ``--orgId`` flags take precedence over
+   both the profile and the environment variables.
 
 .. _config-toml-location:
 
-Content on where to find the config file
+Locate the Configuration File
+-----------------------------
+
+The {+atlas-cli+} saves the configuration file to the following
+location depending on your operating system:
+
+.. tabs-platforms::
+
+   .. tab::
+      :tabid: macos
+
+      .. code-block::
+
+         /Users/{username}/Library/Application Support/atlascli
+
+   .. tab::
+      :tabid: windows
+
+      .. code-block::
+
+         %AppData/atlascli
+
+   .. tab::
+      :tabid: linux
+
+      .. code-block::
+
+         $XDG_CONFIG_HOME/atlascli
+
+      If ``$XDG_CONFIG_HOME`` is not set, the {+atlas-cli+} uses:
+
+      .. code-block::
+
+         $HOME/.config/atlascli
+
+The
+{+atlas-cli+} grants the user who ran the command read and write access to
+the file. 
+
+.. _atlas-cli-set-profile:
+
+Create a Profile
+----------------
+
+The first time you run the 
+``atlas auth login`` or ``atlas config init`` command, the
+{+atlas-cli+} automatically creates the ``config.toml`` file and a default
+profile. If you run a command without specifying a profile, environment
+variables, or ``--projectId`` and ``--orgId`` flags, the {+atlas-cli+} uses the
+default profile for the command.
+
+Select Your Use Case
+~~~~~~~~~~~~~~~~~~~~
+
+Select a connection method based on your use case:
+
+.. include:: /includes/list-table-atlas-cli-auth.rst
+
+To learn more, see :ref:`Select a Connection Method <connect-atlas-cli>`.
+
+Complete the Prerequisites
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- :ref:`Install the {+atlas-cli+} <install-atlas-cli>`.
+- Add your host's IP address to the :ref:`IP access list <access-list>`.
+- If you select ``atlas config init`` as your connection method, you must 
+  :ref:`Configure API keys <atlas-admin-api-access>`.
+
+Follow These Steps
+~~~~~~~~~~~~~~~~~~
+
+Select a use case and follow the procedure to create a profile.
+
+.. tabs::
+
+   .. tab:: Non-programmatic Use
+      :tabid: atlas-auth-login
+
+      .. include:: /includes/fact-default-vs-named-profile.rst
+
+      .. tabs:: 
+
+         .. tab:: Default Profile
+            :tabid: Default
+
+            Follow these steps to create the default profile. If the default profile already
+            exists, these commands update the default profile's values.
+
+            .. procedure::
+
+               .. include:: /includes/steps-atlas-cli-auth-nonprog-default.rst
+
+               .. include:: /includes/steps-atlas-cli-add-profile-nonprogrammatic.rst
+
+         .. tab:: Named Profile
+            :tabid: Named
+
+            Follow these steps to create a profile with a custom name.
+
+            .. procedure::
+
+               .. step:: Run the authentication command.
+
+                  Run the ``atlas auth login`` command in your terminal with the
+                  ``profile <profileName>`` flag. ``<profileName>`` should be
+                  the desired name for your new profile.
+
+                  .. code-block:: sh
+
+                     atlas auth login --profile myProfile
+
+                  The command opens a browser window and returns a one-time
+                  activation code. This code expires after 10 minutes.
+
+               .. include:: /includes/steps-atlas-cli-add-profile-nonprogrammatic.rst
+
+   .. tab:: Programmatic Use
+      :tabid: atlas-config-init
+
+      .. include:: /includes/fact-default-vs-named-profile.rst
+
+      .. tabs::
+
+         .. tab:: Default Profile
+            :tabid: Default
+
+            Follow these steps to create the default profile. If the default profile already
+            exists, these commands update the default profile's values.
+
+            .. procedure::
+
+               .. include:: /includes/steps-atlas-cli-auth-prog-default.rst
+
+               .. include:: /includes/steps-atlas-cli-add-profile-programmatic.rst
+
+         .. tab:: Named Profile
+            :tabid: Named
+
+            Follow these steps to create a profile with a custom name.
+
+            .. procedure::
+
+               .. step:: Run the authentication command.
+
+                  Run the ``atlas config init`` command in your terminal with the
+                  ``profile <profileName>`` flag. ``<profileName>`` should be
+                  the desired name for your new profile.
+
+                  .. code-block:: sh
+
+                     atlas config init --profile myProfile
+
+               .. include:: /includes/steps-atlas-cli-add-profile-nonprogrammatic.rst
+
+
+.. _atlas-cli-profile-update:
+
+Update a Profile
+----------------
+
+You can update the
+settings stored in your configuration file in the following ways:
+
+- Edit the ``config.toml`` file with a text editor.
+- Run the ``atlas config set`` command for a setting. This edits an individual
+  value in the ``config.toml`` file.
+
+Run a Command with a Profile
+----------------------------
+
+To run an {+atlas-cli+} command using a profile:
+
+- :ref:`<atlas-cli-set-profile>`.
+- Append the ``--profile <profileName>`` flag to a command or omit the
+  ``--profile <profileName>`` flag to use the default profile.
+
+.. example::
+
+   This command uses a profile named ``myProfile``:
+
+   .. code-block::
+
+      atlas <command> --profile myProfile
+
+   This command uses the default profile:
+
+   .. code-block::
+
+      atlas <command>

source/atlas-cli-save-connection-settings.txt

@@ -16,21 +16,7 @@ Select a Connection Method
 When you connect to |service| from the {+atlas-cli+}, you can authenticate with
 one of the following commands:
 
-.. list-table::
-   :header-rows: 1
-   :widths: 20 40 20
-   
-   * - Command
-     - Authentication Method
-     - Use Case
-
-   * - ``atlas auth login``
-     - |service| login credentials and an authentication token
-     - Best for non-programmatic use
-
-   * - ``atlas config init``
-     - |api| keys
-     - Best for programmatic use
+.. include:: /includes/list-table-atlas-cli-auth.rst
 
 .. important::
 
@@ -127,16 +113,7 @@ from the {+atlas-cli+}.
 
       .. procedure::
 
-         .. step:: Run the authentication command.
-
-            Run the ``atlas auth login`` command in your terminal.
-
-            .. code-block:: sh
-
-               atlas auth login
-
-            The command opens a browser window and returns a one-time
-            activation code. This code expires after 10 minutes.
+         .. include:: /includes/steps-atlas-cli-auth-nonprog-default.rst
 
          .. step:: Sign into |service|.
 
@@ -200,13 +177,7 @@ from the {+atlas-cli+}.
 
       .. procedure::
 
-         .. step:: Run the authentication command.
-
-            Run the ``atlas config init`` command in your terminal.
-
-            .. code-block:: sh
-
-               atlas config init
+         .. include:: /includes/steps-atlas-cli-auth-prog-default.rst
 
          .. step:: Enter your |api| keys.
 
@@ -248,7 +219,7 @@ different profile, see :ref:`<atlas-cli-profiles>`.
 
 .. toctree::
 
-   /atlas-cli-profiles
+   /atlas-cli-save-connection-settings
    /migrate-to-atlas-cli
 
 

source/connect-atlas-cli.txt

@@ -0,0 +1,9 @@
+Select the default profile or a named profile.
+      
+Create a default profile to:
+      
+- Run a command without specifying a profile, environment
+  variables, or ``--projectId`` and ``--orgId`` flags. 
+- Use the ``--profile default`` flag.
+       
+Create a named profile to use the ``--profile <profileName>`` flag.

source/includes/fact-default-vs-named-profile.rst

@@ -0,0 +1,3 @@
+.. note::
+
+   To use the command line interface for |mms|, `install the {+mcli+} <https://www.mongodb.com/docs/mongocli/stable/install/>`__.

source/includes/fact-use-mongocli-for-om-cm.rst

@@ -0,0 +1,15 @@
+.. list-table::
+   :header-rows: 1
+   :widths: 20 40 20
+   
+   * - Command
+     - Authentication Method
+     - Use Case
+
+   * - ``atlas auth login``
+     - |service| login credentials and an authentication token
+     - Best for non-programmatic use
+
+   * - ``atlas config init``
+     - |api| keys
+     - Best for programmatic use