(DOCSP-20716) Documents telemetry for Atlas CLI (#27)

* (DOCSP-20716) Documents telemetry for Atlas CLI

* Adds examples for what we DONT track

* Adds enable/disable instructions

* Adds env variable and config file instructions

* Includes changes from copy review

* Includes updates from tech review

Author: sarahsimpers

snooty.toml

@@ -16,7 +16,8 @@ toc_landing_pages = [
   "/command/atlas",
   "/connect-atlas-cli",
   "/install-atlas-cli",
-  "/migrate-to-atlas-cli"
+  "/migrate-to-atlas-cli",
+  "/telemetry"
   ]
 
 [constants]

source/atlas-cli-env-variables.txt

@@ -44,6 +44,14 @@ The {+atlas-cli+} supports the following environment variables:
    * - Variable
      - Description
 
+   * - ``DO_NOT_TRACK``
+     - Flag that indicates whether telemetry is disabled for the 
+       {+atlas-cli+}. Set to ``1`` to disable telemetry.
+
+       You can also enable or disable telemetry with
+       ``MONGODB_ATLAS_TELEMETRY_ENABLED``, but you don't need to
+       specify both.
+
    * - ``MONGODB_ATLAS_PUBLIC_API_KEY``
      - Sets the public |api| key for commands that interact with 
        |service|.
@@ -98,4 +106,11 @@ The {+atlas-cli+} supports the following environment variables:
 
    * - ``MONGODB_ATLAS_REFRESH_TOKEN``
      - String that allows |service| to automatically request a new
-       access token when the current access token expires.
+       access token when the current access token expires.
+
+   * - ``MONGODB_ATLAS_TELEMETRY_ENABLED``
+     - Flag that indicates whether telemetry is enabled for the 
+       {+atlas-cli+}. Set to ``false`` to disable telemetry.
+
+       You can also enable or disable telemetry with ``DO_NOT_TRACK``,
+       but you don't need to specify both.

source/configure-optional-settings.txt

@@ -0,0 +1,16 @@
+
+===========================
+Configure Optional Settings
+===========================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+.. toctree::
+
+   /telemetry

source/index.txt

@@ -37,6 +37,7 @@ Follow these steps to get started using the {+atlas-cli+}:
    Overview </index>
    /install-atlas-cli
    /connect-atlas-cli
+   /configure-optional-settings
    /atlas-cli-tutorials
    Atlas CLI Commands </command/atlas>
    /atlas-cli-changelog

source/telemetry.txt

@@ -0,0 +1,124 @@
+.. _telemetry:
+
+===================
+Configure Telemetry
+===================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+{+atlas-cli+}'s telemetry collects anonymous, aggregate usage data to
+identify improvements with the greatest impact. The 
+{+atlas-cli+} enables telemetry by default.
+
+Learn What the {+atlas-cli+} Tracks
+-----------------------------------
+
+{+atlas-cli+} telemetry tracks 
+non-Personally-Identifiable Information (PII), which includes but is
+not limited to the following information:
+
+.. list-table::
+   :header-rows: 1
+   :widths: 60 40
+
+   * - Data
+     - Example Value
+
+   * - {+atlas-cli+} version number
+     - ``1.0.0``
+  
+   * - Installation source
+     - ``Homebrew``
+
+   * - Operating System (OS) and OS version
+     - ``Windows 11.5``
+
+   * - Authentication method. {+atlas-cli+} telemetry does *not* track
+       the values for the |api| keys and login credentials.
+     - ``API key``   
+
+   * - Details for commands you run. {+atlas-cli+} telemetry tracks 
+       the options you specify, but does *not* track the values.
+     - ``timestamp: 2022-04-11T11:35:46.794119+01:00``
+       ``command: atlas cluster create``
+       ``--provider --region``
+
+   * - Performance information, such as the amount of time it takes for
+       the {+atlas-cli+} to execute a command.
+     - ``completion timestamp: 2022-04-11T11:35:49.456719+01:00``
+
+   * - Errors you encounter, including the command you run and the
+       parameters you use.
+     - ``atlas rgister``
+       ``Error: unknown command "rgister" for "atlas"``
+
+Learn What the {+atlas-cli+} Doesn't Track
+------------------------------------------
+
+{+atlas-cli+} telemetry *doesn't* track:
+
+.. list-table::
+   :header-rows: 1
+   :widths: 60 40
+
+   * - Data
+     - Example
+
+   * - PII and values that could potentially contain PII, including all
+       free-text fields such as custom names or database user
+       names.
+     - ``--clusterName MyCluster``
+
+   * - |api| key values or |service| login credentials.
+     - ``private_api_key abcdefghi123456789``
+
+
+Disable Telemetry for the {+atlas-cli+}
+---------------------------------------
+
+To disable telemetry for the {+atlas-cli+}, run the following command
+in the terminal:
+
+.. code-block:: sh
+
+   atlas config set telemetry_enabled false
+
+You can also disable telemetry in the following ways:
+
+- Navigate to the :ref:`configuration file <config-toml-location>` and
+  enter ``telemetry_enabled = false``.
+- Set the :ref:`MONGODB_ATLAS_TELEMETRY_ENABLE environment variable
+  <atlas-cli-env-vars>` to ``false``. 
+
+
+Enable Telemetry for the {+atlas-cli+}
+--------------------------------------
+
+The {+atlas-cli+} enables telemetry by default. If telemetry is
+currently disabled, you can enable telemetry by running the following
+command in the terminal:
+
+.. code-block:: sh
+
+   atlas config set telemetry_enabled true
+
+You can also enable telemetry in the following ways:
+
+- Navigate to the :ref:`configuration file <config-toml-location>` and
+  remove ``telemetry_enabled = false``.
+- Set the :ref:`MONGODB_ATLAS_TELEMETRY_ENABLE environment variable
+  <atlas-cli-env-vars>` to ``true``. 
+
+
+
+
+
+
+
+