DOCSP-11193 restructured doc pages (#44)

* DOCSP-11193 restructured doc pages

Author: kanchana-mongodb

config/redirects

@@ -1,3 +1,5 @@
 define: base https://docs.mongodb.com/datalake
 
 raw: /reference/cli/datalake-cli -> ${base}/reference/cli/administration-commands/
+raw: /reference/config-files/data-lake-configuration -> ${base}/reference/format/data-lake-configuration
+raw: /reference/config-files/sql-schema-format -> ${base}/reference/format/sql-schema-format

snooty.toml

@@ -3,7 +3,7 @@ title = "MongoDB Atlas Data Lake"
 
 intersphinx = ["https://docs.mongodb.com/manual/objects.inv","https://docs.atlas.mongodb.com/objects.inv"]
 
-toc_landing_pages = ["/config/config-data-lake", "/tutorial/getting-started", "/admin/query-with-sql"]
+toc_landing_pages = ["/config/config-data-lake", "/tutorial/getting-started", "/admin/query-with-sql", "/query/query-data-lake"]
 
 [constants]
 adl = "Atlas Data Lake"

source/admin/optimize-query-performance.txt

@@ -19,7 +19,8 @@ The performance of your {+data-lake+} is affected by the
 following factors:
 
 - The structure of your data in |s3| and how you represent it in your
-  {+data-lake+} :doc:`configuration file </reference/config-files/data-lake-configuration>`.
+  {+data-lake+} :doc:`configuration 
+  </reference/format/data-lake-configuration>`.
 - The size of your data files.
 - The format and structure of your data files.
 
@@ -29,13 +30,13 @@ Data Structure in |s3|
 For easier management, make sure that your data is
 logically grouped into partitions. You can leverage partitions to
 improve {+data-lake-short+} performance by mapping them to partition
-attributes in your :doc:`configuration file
-</reference/config-files/data-lake-configuration>`.
+attributes in your :doc:`configuration 
+</reference/format/data-lake-configuration>`.
 
 You can improve your {+data-lake-short+}\'s performance by ensuring that
 your partition structure maps to your query patterns and that it is
-defined in your :doc:`configuration file
-</reference/config-files/data-lake-configuration>`. By mapping your *partition
+defined in your :doc:`configuration 
+</reference/format/data-lake-configuration>`. By mapping your *partition
 attributes* (the parts of your |s3| prefix that looks like a folder) to
 a query attribute, {+data-lake-short+} can selectively open the files
 that contain data related to your query. This both reduces the amount of
@@ -55,14 +56,14 @@ and downloads less files from |aws|.
          |--phone
 
    You can set a partition attribute for "metric type" by defining
-   ``/metrics/{metric_type string}/*`` in your configuration file. If
+   ``/metrics/{metric_type string}/*`` in your configuration. If
    you issue a query that contains ``{metric_type: software}``,
    {+data-lake-short+} only processes the files with the prefix
    ``/software`` and ignores files with the prefix ``/hardware``. 
 
    You can then set a partition attribute for "software type" by
    defining ``/metrics/{metric_type string}/{software_type string}`` in
-   your configuration file. If you issue a query that contains
+   your configuration . If you issue a query that contains
    ``{metric_type: software, software_type: computer}``,
    {+data-lake-short+} ignores files with the prefix ``/phone``.
 

source/admin/query-with-sql.txt

@@ -64,7 +64,7 @@ automatically removes the schema for a collection or view when you:
    .. toctree::
       :titlesonly:
 
-      SQL Schema Format </reference/config-files/sql-schema-format>
+      SQL Schema Format </reference/format/sql-schema-format>
       Generate SQL Schema </reference/cli/sql/sqlgenerateschema>
       Set SQL Schema </reference/cli/sql/sqlsetschema>
       Retrieve SQL Schema </reference/cli/sql/sqlgetschema>

source/administration.txt

@@ -18,6 +18,8 @@ This section contains the following:
    .. toctree::
       :titlesonly:
 
+      /config/manage-stores-cli
+      /config/manage-dbs-cli
+      /config/manage-collections-views-cli
       /admin/manage-namespace-catalog-cli
-      /admin/optimize-query-performance
-      /admin/determine-query-status
+      /config/update-region

source/config/config-data-lake.txt

@@ -16,10 +16,9 @@ Overview
 --------
 
 You can configure {+data-lake+} using the :ref:`datalake-configuration-file`. 
-The configuration file defines mappings between your {+data-lake-stores+} 
-and {+data-lake-short+}. To learn more about the configuration file including 
-the configuration fields and file format, see 
-:ref:`datalake-configuration-file`.
+The configuration defines mappings between your {+data-lake-stores+} 
+and {+data-lake-short+}. To learn more about the configuration including 
+the configuration fields and format, see :ref:`datalake-configuration-file`.
 
 You can retrieve and update the {+data-lake-short+} configuration by 
 connecting a :binary:`~bin.mongo` shell to the {+data-lake-short+}:
@@ -56,8 +55,8 @@ database commands to retrieve the {+data-lake-short+} configuration:
    db.runCommand( { "storageGetConfig" : 1 } )
 
 The command returns the current {+data-lake-short+} configuration. For 
-complete documentation on the configuration fields and file format,
-see :ref:`datalake-configuration-format`.
+complete documentation on the configuration fields and format, see 
+:ref:`datalake-configuration-format`.
 
 .. _datalake-setstorageconfig:
 
@@ -72,12 +71,12 @@ database commands to set or update the {+data-lake-short+} configuration:
    use admin
    db.runCommand( { "storageSetConfig" : <config> } )
 
-Replace ``<config>`` with the {+data-lake-short+} configuration
-file. For complete documentation on the configuration fields and file 
-format, see :ref:`datalake-configuration-format`. You can validate 
-your :ref:`configuration <datalake-configuration-file>` before setting or 
-updating the {+data-lake-short+} configuration by running the 
-:ref:`storageValidateConfig <datalake-validatestorageconfig>` command.
+Replace ``<config>`` with the {+data-lake-short+} configuration. For complete 
+documentation on the configuration fields and format, see 
+:ref:`datalake-configuration-format`. You can validate your :ref:`configuration 
+<datalake-configuration-file>` before setting or updating the 
+{+data-lake-short+} configuration by running the :ref:`storageValidateConfig 
+<datalake-validatestorageconfig>` command.
 
 To set or update the storage configuration through the |service| UI: 
 
@@ -103,9 +102,9 @@ You can run the following command to validate your {+data-lake-short+}
    use admin
    db.runCommand( { "storageValidateConfig" : <config> } )
 
-Replace ``<config>`` with the {+data-lake-short+} configuration
-file. For complete documentation on the configuration fields and file 
-format, see :ref:`datalake-configuration-format`.
+Replace ``<config>`` with the {+data-lake-short+} configuration. For complete 
+documentation on the configuration fields and format, see 
+:ref:`datalake-configuration-format`.
 
 The command returns the following if your {+dl+} configuration is valid:
 
@@ -168,16 +167,13 @@ and run the following database commands:
    use admin 
    db.runCommand( { "storageGenerateConfig" : 1 } )
 
-For complete documentation on the configuration fields and file format, see :ref:`datalake-configuration-format`. 
+For complete documentation on the configuration fields and format, see :ref:`datalake-configuration-format`. 
 
 .. class:: hidden
 
    .. toctree::
       :titlesonly:
 
-      /reference/config-files/data-lake-configuration
+      /reference/format/data-lake-configuration
       /reference/examples/path-syntax-examples
-      /config/manage-stores-cli
-      /config/manage-dbs-cli
-      /config/manage-collections-views-cli
-      /config/update-region
+      /supported-unsupported/supported-partition-attributes

source/includes/extracts-data-lake.yaml

@@ -40,21 +40,21 @@ content: |
          <https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html>`_.
 
      * - ``dataProcessRegion``
-       - Optional
+       - object
        - The cloud provider region to which {+data-lake+} routes
          client connections for data processing.
 
          If ``null``, the {+data-lake+} routes client connections to the
          region nearest to the client based on DNS resolution.
 
      * - ``dataProcessRegion.cloudProvider``
-       - Required
+       - string
        - Name of the cloud service provider. 
 
-         {+data-lake+} only supports ``AWS``.
+         {+data-lake+} only supports ``aws``.
 
      * - ``dataProcessRegion.region``
-       - Required
+       - string
        - Name of the region to which {+data-lake+} routes client 
          connections for data processing.
 
@@ -215,7 +215,7 @@ content: |
             response body.
 
      * - ``dataProcessRegion``
-       - Optional
+       - string
        - The cloud provider region to which {+data-lake+} routes
          client connections for data processing.
 

source/index.txt

@@ -32,10 +32,9 @@ the |mongo| shell, :dl:`MongoDB Compass <compass>`, or any
 When you create a |data-lake|, you grant |service| either read only or 
 read and write access to |s3| buckets in your |aws| account. To access your 
 |service| clusters, |service| uses your existing :manual:`Role Based Access 
-Controls</core/authorization>`. You can view and edit the generated 
-data storage :ref:`configuration file <datalake-configuration-file>` that maps 
-data from your |s3| buckets and |service| clusters to virtual databases and 
-collections.
+Controls</core/authorization>`. You can view and edit the generated data 
+storage :ref:`configuration <datalake-configuration-file>` that maps data from 
+your |s3| buckets and |service| clusters to virtual databases and collections.
 
 A database user must have one of the following roles to query an |service| 
 |data-lake|:
@@ -107,6 +106,7 @@ for same-region, region-to-region, or region-to-internet data transfer.
       /tutorial/getting-started
       /config/config-data-lake
       /administration
+      /query/query-data-lake
       /admin/query-with-sql
       /reference
       /supported-unsupported