(DOCSP-26893) Adds page/section for automating processes (#136)

* (DOCSP-26893) Adds page/section for automating processes

* Includes changes from copy review

Author: sarahsimpers

snooty.toml

@@ -10,6 +10,7 @@ intersphinx = [ "https://www.mongodb.com/docs/ops-manager/current/objects.inv",
 toc_landing_pages = [
   "/atlas-cli-changelog",
   "/atlas-cli-env-variables",
+  "/atlas-cli-automate",
   "/atlas-cli-profiles",
   "/atlas-cli-quickstart",
   "/atlas-cli-tutorials",

source/atlas-cli-automate.txt

@@ -0,0 +1,100 @@
+.. _atlas-cli-automate:
+
+=========================================
+Automate Processes with the {+atlas-cli+}
+=========================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+To automate a process with the {+atlas-cli+} in a script, use
+the following resources and best practices as guidance.  
+
+To learn how to connect to the {+atlas-cli+} programmatically, see
+the :guilabel:`Programmatic User` tabs on :ref:`connect-atlas-cli`.
+
+Resources for Automation with the {+atlas-cli+}
+-----------------------------------------------
+
+.. list-table:: 
+   :header-rows: 1
+   :widths: 40 60
+
+   * - Resource
+     - Objective
+
+   * - :ref:`atlas-cli-env-vars`
+     - Set environment variables that you can define once and use
+       across all of your scripts.
+
+   * - :ref:`go-template-output`
+     - Use Go templates or |json| paths to customize the output from
+       the {+atlas-cli+}. You can include the anticipated custom output in your scripts.
+
+Best Practices for Automation with the {+atlas-cli+}
+----------------------------------------------------
+
+Follow these best practices when you automate processes with the
+{+atlas-cli+}:
+
+Base Your Script on the Version of the {+atlas-cli+} that You Run
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When you create a script to automate processes, you should base the
+script on the version of the {+atlas-cli+} that you currently run.
+**Don't** build automatic upgrades for the {+atlas-cli+} into your
+script because new {+atlas-cli+} releases could introduce breaking
+changes, which could break your automated processes.
+
+Instead, check release notes for deprecated features and
+breaking changes before you manually upgrade your version of the 
+{+atlas-cli+}.
+
+.. _atlas-cli-redirect-stderr:
+
+Redirect ``stderr``
+~~~~~~~~~~~~~~~~~~~
+
+The {+atlas-cli+} prints error messages and command deprecation
+warnings in the output for commands. These unanticipated error messages
+and warnings can cause issues for your automated processes that
+anticipate a specific output. To prevent issues, you can redirect
+``stderr`` to an output file in your script.
+
+For example, the following command redirects the ``stderr`` output from
+a script called ``myScript.sh`` to a text file called ``error.txt``:
+
+.. code-block::
+
+   myScript.sh 2> error.txt
+
+In the previous example, all error messages and deprecation warnings
+are stored in ``error.txt`` and don't display in the output, so
+they don't disrupt your automated processes.
+
+Command deprecation messages are similar to the following text:
+
+.. code-block::
+
+   Command "describe" is deprecated, Please use atlas privateEndpoints aws interfaces describe <atlasPrivateEndpointId> [--privateEndpointId privateEndpointID] [--projectId projected]
+
+Update Scripts Regularly
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+You should regularly update your scripts to discontinue use of 
+deprecated commands because they will be removed in future releases.
+You can learn which commands are deprecated from the
+:ref:`atlas-cli-changelog`. If you 
+:ref:`set up a redirect file for stderr <atlas-cli-redirect-stderr>`,
+you can also check that file for deprecation warnings.
+
+.. toctree::
+   :titlesonly:
+
+   /atlas-cli-env-variables
+   /custom-output-cli

source/atlas-cli-changelog.txt

@@ -1,3 +1,5 @@
+.. _atlas-cli-changelog:
+
 :noprevnext:
 
 =======================

source/configure-optional-settings.txt

@@ -229,7 +229,6 @@ different profile, see :ref:`<atlas-cli-profiles>`.
 .. toctree::
 
    /atlas-cli-save-connection-settings
-   /atlas-cli-env-variables
    /migrate-to-atlas-cli
 
 

source/connect-atlas-cli.txt

@@ -113,9 +113,10 @@ Learn the {+atlas-cli+} commands and optimize your workflow with advanced tutori
    Overview </index>
    /install-atlas-cli
    /connect-atlas-cli
-   /configure-optional-settings
-   /atlas-cli-tutorials
    Atlas CLI Commands </command/atlas>
+   /atlas-cli-automate
+   /telemetry
+   /atlas-cli-tutorials
    /reference
    /troubleshooting
    /atlas-cli-changelog