DOP-1386: update master to build on snooty

(DOCSP-11721): Content changes for nextgen migration

fix toctree paths to be not relative

Author: schmalliso

snooty.toml

@@ -1,13 +1,73 @@
 name = "mongocli"
+title = "MongoDB Command Line Interface"
 
-intersphinx = ["https://docs.mongodb.com/manual/objects.inv","https://docs.atlas.mongodb.com/objects.inv"]
+intersphinx = ["https://docs.opsmanager.mongodb.com/current/objects.inv", "https://docs.mongodb.com/manual/objects.inv",
+               "https://docs.atlas.mongodb.com/objects.inv"]
+
+toc_landing_pages = ["/configure"]
 
 [constants]
 aagent = "Automation Agent"
+data-lake = "Atlas Data Lake"
+data-lake-short = "Data Lake"
+data-lake-stores = "data stores"
+data-lake-store = "data store"
 default-profile = ":ref:`default profile <mcli-profiles>`"
 mcli = "MongoDB CLI"
 mcli-long = "MongoDB Command Line Interface (``mongocli``)"
 mcli-version = "1.7.0"
 mdbagent = "MongoDB Agent"
 mdbVersion = "4.2"
 
+[substitutions]
+a-application = "an Ops Manager Application"
+a-mms = "an Ops Manager"
+A-mms = "An Ops Manager"
+application-s = "Ops Manager Applications"
+application = "Ops Manager Application"
+"2fa" = ":abbr:`2FA (Two Factor Authentication)`"
+cloud = ":cloudmgr:`MongoDB Cloud Manager </>`"
+cloud-short = "Cloud Manager"
+api = ":abbr:`API (Application Programming Interface)`"
+API = ":abbr:`API (Application Programming Interface)`"
+aws = ":abbr:`AWS (Amazon Web Services)`"
+bic-short = ":bic:`BI Connector </>`"
+bic = "BI Connector for Atlas"
+bson = ":abbr:`BSON (Binary Javascript Object Notation)`"
+cidr = ":abbr:`CIDR (Classless Inter-Domain Routing)`"
+com = "Cloud Manager or Ops Manager"
+dns = ":abbr:`DNS (Domain Name System)`"
+Epoch-time-ms = "Timestamp in the number of milliseconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
+epoch-time-ms = "timestamp in the number of milliseconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
+Epoch-time = "Timestamp in the number of seconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
+epoch-time = "timestamp in the number of seconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
+fqdn = ":abbr:`FQDN (fully qualified domain name)`"
+fts = "Atlas Search"
+gcp = ":abbr:`GCP (Google Cloud Platform)`"
+iana = ":abbr:`IANA (Internet Assigned Numbers Authority)`"
+iops = ":abbr:`IOPS (Input/Output Operations per Second)`"
+ipaddr = ":abbr:`IP (Internet Protocol)`"
+iso8601-time = "Timestamp in `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601?oldid=793821205>`__ date and time format in |utc|"
+iso8601 = "`ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601?oldid=793821205>`__"
+ipv4 = ":abbr:`IPv4 (Internet Protocol version 4)`"
+ipv6 = ":abbr:`IPv6 (Internet Protocol version 6)`"
+json = ":abbr:`JSON (Javascript Object Notation)`"
+kmip = ":abbr:`KMIP (Key Management Interoperability)`"
+ldap = ":abbr:`LDAP (Lightweight Directory Access Protocol)`"
+mms-full = ":opsmgr:`MongoDB Ops Manager </>`"
+mms = "``Ops Manager``"
+mongod = ":binary:`~bin.mongod`"
+mongos = ":binary:`~bin.mongos`"
+mongo = ":binary:`~bin.mongo`"
+onprem = "Ops Manager"
+onprem-link = ":opsmgr:`Ops Manager </>`"
+s3 = ":abbr:`S3 (Simple Storage Service)`"
+service-fullname = ":atlas:`MongoDB Atlas <>`"
+service = "Atlas"
+ssl = ":abbr:`SSL (Secure Sockets Layer)`"
+svc-api-key = "Programmatic API Key"
+snmp = ":abbr:`SNMP (Simple Network Management Protocol)`"
+tls = ":abbr:`TLS (Transport Layer Security)`"
+url = ":abbr:`URL (Uniform Resource Locator)`"
+utc = ":abbr:`UTC (Coordinated Universal Time)`"
+vpc = ":abbr:`VPC (Virtual Private Cloud)`"

source/configure.txt

@@ -12,15 +12,13 @@ Configure the {+mcli+}
    :depth: 1
    :class: singlecol
 
-.. class:: hidden
+.. toctree::
+   :titlesonly:
 
-   .. toctree::
-      :titlesonly:
-
-      /configure/configuration-file
-      /configure/environment-variables
-      /configure/autocomplete
-      /configure/go-template-output
+   /configure/configuration-file
+   /configure/environment-variables
+   /configure/autocomplete
+   /configure/go-template-output
 
 You can define the settings that the {+mcli+} uses to interact with
 MongoDB services like |service|, |cloud-short|, and |onprem| by using

source/configure/environment-variables.txt

@@ -78,13 +78,15 @@ The {+mcli+} supports the following environment variables:
           * - ``ops-manager``
             - |mms-full|
 
-   * - ``MCLI_OPS_MANAGER_CA_CERTIFICATE``
-     - **|onprem| only** If applicable, the full path on your local
+   * - | ``MCLI_OPS_MANAGER_CA_CERTIFICATE``
+       | *Ops Manager only*
+     - If applicable, the full path on your local
        system to the PEM-encoded Certificate Authority (CA) certificate
        used to sign the client and |onprem| TLS certificates.
 
-   * - ``MCLI_OPS_MANAGER_SKIP_VERIFY``
-     - **|onprem| only** When set to ``yes``, the
+   * - | ``MCLI_OPS_MANAGER_SKIP_VERIFY``
+       | *Ops Manager only*
+     - When set to ``yes``, the
        ``MCLI_OPS_MANAGER_CA_CERTIFICATE`` TLS certificate is not
        verified. This prevents your connections from being rejected due
        to an invalid certificate.

source/includes/atlas-cluster-output-fields.rst

@@ -165,7 +165,7 @@
        - :atlas:`Azure </reference/microsoft-azure/#microsoft-azure>`
 
    * - ``replicationFactor``
-     - Number of :term:`replica set members <replica set>` in the
+     - Number of replica set members in the
        cluster: ``3``, ``5``, or ``7``.
 
    * - ``replicationSpec``

source/includes/atlas-snapshots-list-output-fields.rst

@@ -86,14 +86,14 @@
      - document array
      - The individual parts that comprise the complete snapshot.
 
-       - For a :term:`replica set`, this array contains a single
+       - For a replica set, this array contains a single
          document.
-       - For a :term:`sharded cluster`, this array contains one document
+       - For a sharded cluster, this array contains one document
          for each shard plus one document for the :term:`config server`.
 
    * - ``parts.clusterId``
      - objectId
-     - ID of the :term:`replica set`.
+     - ID of the replica set.
 
    * - ``parts.compressionSetting``
      - string
@@ -121,13 +121,13 @@
 
    * - ``parts.mongodVersion``
      - string
-     - The version of MongoDB that the :term:`replica set`
-       :term:`primary` was running when the snapshot was
+     - The version of MongoDB that the replica set
+       primary was running when the snapshot was
        created.
 
    * - ``parts.replicaSetName``
      - string
-     - Name of the :term:`replica set`.
+     - Name of the replica set.
 
    * - ``parts.shardName``
      - string

source/includes/backup-checkpoints-output-fields.rst

@@ -14,7 +14,7 @@
 
    * - ``links``
      - object array
-     - Includes one or more :ref:`links <api-linking>` to 
+     - Includes one or more links to 
        sub-resources and/or related resources. The relations between 
        URLs are explained in the `Web Linking Specification
        <http://tools.ietf.org/html/rfc5988>`__.

source/includes/backup-restore-list-output.rst

@@ -11,14 +11,14 @@
      - Unique identifier of the batch to which this restore job
        belongs.
 
-       Only present for a restore of a :term:`sharded cluster`.
+       Only present for a restore of a sharded cluster.
 
    * - ``clusterId``
      - string
-     - Unique identifier of the :term:`cluster` the restore job
+     - Unique identifier of the cluster the restore job
        represents.
 
-       Only present for a restore of a :term:`cluster`.
+       Only present for a restore of a cluster.
 
    * - ``created``
      - string

source/includes/backup-restore-output-fields.rst

@@ -9,7 +9,7 @@
 
    * - clusterId
      - string
-     - Unique identifier of the :term:`cluster` that the
+     - Unique identifier of the cluster that the
        restore job represents.
 
    * - created
@@ -18,7 +18,7 @@
 
    * - delivery
      - object
-     - Method and details of how the restored :term:`snapshot` data
+     - Method and details of how the restored snapshot data
        is delivered.
 
    * - delivery.expirationHours
@@ -63,7 +63,7 @@
      - string
      - *For HTTP only.*
 
-       |url| from which the restored :term:`snapshot` data can be
+       |url| from which the restored snapshot data can be
        downloaded.
 
    * - encryptionEnabled
@@ -73,7 +73,7 @@
 
    * - groupId
      - string
-     - Unique identifier of the :term:`group` that owns the restore 
+     - Unique identifier of the group that owns the restore 
        job.
 
    * - id
@@ -83,8 +83,7 @@
    * - links
      - object array
      - One or more links to sub-resources and/or related resources. The
-       relations between URLs are explained in the `Web Linking Specification
-       <http://tools.ietf.org/html/rfc5988>`_.
+       relations between URLs are explained in the `Web Linking Specification <http://tools.ietf.org/html/rfc5988>`_.
 
    * - pointInTime
      - boolean
@@ -93,7 +92,7 @@
 
    * - snapshotId
      - string
-     - Unique identifier of the :term:`snapshot` to restore.
+     - Unique identifier of the snapshot to restore.
 
    * - statusName
      - string
@@ -116,4 +115,4 @@
    * - timestamp.increment
      - string
      - Order of all operations completed at the latest oplog entry in
-       the restored snapshot.
+       the restored snapshot.

source/includes/backup-restore-start-args.rst

@@ -26,8 +26,7 @@
           data files, see
           :atlas:`Manual Restore One Snapshot </backup/archive/archive-one-snapshot/>`.
 
-       .. admonition:: Download Limitations
-          :class: note
+       .. note:: Download Limitations
 
           Each cloud backup can have one download at a time, and each
           :atlas:`project </tutorial/manage-projects/>` can have

source/includes/fact-online-archive-beta.rst

@@ -1,5 +1,4 @@
-.. admonition:: Beta
-   :class: note
+.. note:: Beta
 
    Online archive is available as a Beta feature. The feature and the 
    corresponding documentation may change at any time during the Beta 

source/includes/logs-jobs-list-results.rst

@@ -13,7 +13,7 @@
 
    * - ``groupId``
      - string
-     - Unique identifier of the :term:`project` that the log
+     - Unique identifier of the project that the log
        collection request is associated with.
 
    * - ``userId``

source/includes/metrics-disks-describe-output.rst

@@ -27,10 +27,10 @@
      - The hostname of the machine running the MongoDB process.
 
    * - ``links``
-     - array
-     - An array of documents, representing a :ref:`link <api-linking>` to one
-       or more sub-resources and/or related resources such as :ref:`list
-       pagination <api-lists>`. See :ref:`api-linking` for more information.
+     - document array
+     - One or more links to sub-resources and/or related resources.
+       The relations between URLs are explained in the `Web Linking
+       Specification <http://tools.ietf.org/html/rfc5988>`_.
 
    * - ``measurements``
      - object array

source/includes/metrics-process-output.rst

@@ -3,8 +3,7 @@ Output
 
 .. include:: /includes/command-output-intro.rst
 
-.. admonition:: Free Tier
-   :class: important
+.. important:: Free Tier
 
    ``M0`` Free Tier and ``M2/M5`` shared-tier clusters return a subset
    of the metrics documented here.
@@ -43,10 +42,10 @@ The HTTP response returns a JSON document that includes the following objects:
      - The hostname of the machine running the |service| MongoDB process.
 
    * - ``links``
-     - array
-     - An array of documents, representing a :ref:`link <api-linking>` to one
-       or more sub-resources and/or related resources such as :ref:`list
-       pagination <api-lists>`. See :ref:`api-linking` for more information.
+     - document array
+     - One or more links to sub-resources and/or related resources.
+       The relations between URLs are explained in the `Web Linking
+       Specification <http://tools.ietf.org/html/rfc5988>`_.
 
    * - ``measurements``
      - object array

source/includes/mms-snapshots-list-output-fields.rst

@@ -50,7 +50,7 @@
 
    * - ``groupId``
      - objectId
-     - ID of the :term:`project` that owns the snapshot.
+     - ID of the project that owns the snapshot.
 
    * - ``id``
      - objectId
@@ -83,20 +83,20 @@
 
    * - ``namespaceFilterList``
      - object
-     - The :term:`namespaces <namespace>` that are included or excluded
+     - The namespaces that are included or excluded
        from this snapshot.
 
    * - ``namespaceFilterList.filterList``
      - string array
      - A comma-separated list of any combination of databases or
-       :term:`namespaces <namespace>` that are exclusively included or
+       namespaces that are exclusively included or
        explicitly excluded from the snapshot.
 
        The default value is an empty array (``[]``).
 
    * - ``namespaceFilterList.filterType``
      - string
-     - A value that determines how :term:`namespaces <namespace>` are
+     - A value that determines how namespaces are
        filtered for this snapshot.
 
        - If this value is set to ``blacklist``, namespaces in
@@ -112,14 +112,14 @@
      - document array
      - The individual parts that comprise the complete snapshot.
 
-       - For a :term:`replica set`, this array contains a single
+       - For a replica set, this array contains a single
          document.
-       - For a :term:`sharded cluster`, this array contains one document
+       - For a sharded cluster, this array contains one document
          for each shard plus one document for the :term:`config server`.
 
    * - ``parts.clusterId``
      - objectId
-     - ID of the :term:`replica set`.
+     - ID of the replica set.
 
    * - ``parts.compressionSetting``
      - string
@@ -147,13 +147,13 @@
 
    * - ``parts.mongodVersion``
      - string
-     - The version of MongoDB that the :term:`replica set`
-       :term:`primary` was running when the snapshot was
+     - The version of MongoDB that the replica set
+       primary was running when the snapshot was
        created.
 
    * - ``parts.replicaSetName``
      - string
-     - Name of the :term:`replica set`.
+     - Name of the replica set.
 
    * - ``parts.shardName``
      - string
@@ -168,4 +168,4 @@
      - The type of server that the part represents:
 
        - ``REPLICA_SET``
-       - ``CONFIG_SERVER_REPLICA_SET``
+       - ``CONFIG_SERVER_REPLICA_SET``