DOCSP-46362 - TOC reorganization

config/redirects

@@ -14,7 +14,68 @@ raw: ${prefix}/get-started/download-and-install/ -> ${base}/current/get-started/
 [*-master]: ${prefix}/${version}/security/enterprise-authentication/ -> ${base}/${version}/security/authentication/
 [*-master]: ${prefix}/${version}/faq/ -> ${base}/${version}/
 [*-master]: ${prefix}/${version}/connect/connection-pools/ -> ${base}/${version}/connect/connection-options/#connection-pools
-[v4.7-*]: ${prefix}/${version}/get-started/connect-to-mongodb -> ${base}/${version}/get-started/run-sample-query/
+[*-master]: ${prefix}/${version}/get-started/download-and-install/ -> ${base}/${version}/get-started/
+[*-master]: ${prefix}/${version}/get-started/create-a-deployment/ -> ${base}/${version}/get-started/
+[*-master]: ${prefix}/${version}/get-started/create-a-connection-string/ -> ${base}/${version}/get-started/
+[*-master]: ${prefix}/${version}/get-started/connect-to-mongodb/ -> ${base}/${version}/get-started/
+[*-master]: ${prefix}/${version}/get-started/next-steps/ -> ${base}/${version}/get-started/
+[*-master]: ${prefix}/${version}/connect/csot/ -> ${base}/${version}/connect/connection-options/csot/
+[*-master]: ${prefix}/${version}/connect/network-compression/ -> ${base}/${version}/connect/connection-options/network-compression/
+[*-master]: ${prefix}/${version}/connect/server-selection/ -> ${base}/${version}/connect/connection-options/server-selection/
+[*-master]: ${prefix}/${version}/connect/stable-api/ -> ${base}/${version}/connect/connection-options/stable-api/
+[*-master]: ${prefix}/${version}/connect/tls/ -> ${base}/${version}/security/tls/
+[*-master]: ${prefix}/${version}/write/bulk-write/ -> ${base}/${version}/crud/bulk-write/
+[*-master]: ${prefix}/${version}/databases-collections/#configure-read-and-write-operations/ -> ${base}/${version}/crud/configure/
+[*-master]: ${prefix}/${version}/write/delete/ -> ${base}/${version}/crud/delete/
+[*-master]: ${prefix}/${version}/write/gridfs/ -> ${base}/${version}/crud/gridfs/
+[*-master]: ${prefix}/${version}/write/insert/ -> ${base}/${version}/crud/insert/
+[*-master]: ${prefix}/${version}/write/transactions/ -> ${base}/${version}/crud/transactions/
+[*-master]: ${prefix}/${version}/write/update/ -> ${base}/${version}/crud/update/
+[*-master]: ${prefix}/${version}/write/replace/ -> ${base}/${version}/crud/update/replace/
+[*-master]: ${prefix}/${version}/read/ -> ${base}/${version}/crud/query/
+[*-master]: ${prefix}/${version}/read/count/ -> ${base}/${version}/crud/query/count/
+[*-master]: ${prefix}/${version}/read/cursors/ -> ${base}/${version}/crud/query/cursors/
+[*-master]: ${prefix}/${version}/read/distinct/ -> ${base}/${version}/crud/query/distinct/
+[*-master]: ${prefix}/${version}/read/retrieve/ -> ${base}/${version}/crud/query/find/
+[*-master]: ${prefix}/${version}/read/project/ -> ${base}/${version}/crud/query/project/
+[*-master]: ${prefix}/${version}/read/specify-documents-to-return/ -> ${base}/${version}/crud/query/specify-documents-to-return/
+[*-master]: ${prefix}/${version}/read/specify-a-query/ -> ${base}/${version}/crud/query/specify-query/
+[*-master]: ${prefix}/${version}/read/change-streams/ -> ${base}/${version}/monitoring-and-logging/change-streams/
+[*-master]: ${prefix}/${version}/logging/ -> ${base}/${version}/monitoring-and-logging/logging/
+[*-master]: ${prefix}/${version}/monitoring/ -> ${base}/${version}/monitoring-and-logging/monitoring/
+[*-master]: ${prefix}/${version}/data-formats/custom-types/ -> ${base}/${version}/data-formats/custom-types/type-codecs/
+[*-master]: ${prefix}/${version}/serialization/#binary-data -> ${base}/${version}/reference/compatibility/
+[*-master]: ${prefix}/${version}/compatibility/ -> ${base}/${version}/reference/compatibility/
+[*-master]: ${prefix}/${version}/get-started/connect-to-mongodb/ -> ${base}/${version}/get-started/
+[*-master]: ${prefix}/${version}/get-started/create-a-connection-string/ -> ${base}/${version}/get-started/
+[*-master]: ${prefix}/${version}/get-started/create-a-deployment/ -> ${base}/${version}/get-started/
+[*-master]: ${prefix}/${version}/get-started/download-and-install/ -> ${base}/${version}/get-started/
+[*-master]: ${prefix}/${version}/get-started/next-steps/ -> ${base}/${version}/get-started/
+[*-master]: ${prefix}/${version}/motor-async-migration/ -> ${base}/${version}/reference/migration/
+[*-master]: ${prefix}/${version}/pymongo-to-async-guide/ -> ${base}/${version}/reference/migration/
+[*-master]: ${prefix}/${version}/previous-versions/ -> ${base}/${version}/reference/previous-versions/
+[*-master]: ${prefix}/${version}/whats-new/ -> ${base}/${version}/reference/release-notes/
+[*-master]: ${prefix}/${version}/tools/ -> ${base}/${version}/integrations/
+[*-master]: ${prefix}/${version}/upgrade/ -> ${base}/${version}/reference/upgrade/
+[*-master]: ${prefix}/${version}/write-operations/ -> ${base}/${version}/crud/[v4.7-*]: ${prefix}/${version}/get-started/connect-to-mongodb -> ${base}/${version}/get-started/run-sample-query/
+[*-master]: ${prefix}/${version}/work-with-indexes/ -> ${base}/${version}/indexes/
+
+[*-master]: ${prefix}/${version}/indexes/single-field-index/ -> ${base}/${version}/indexes/
+[*-master]: ${prefix}/${version}/indexes/compound-index/ -> ${base}/${version}/indexes/
+[*-master]: ${prefix}/${version}/indexes/multikey-index/ -> ${base}/${version}/indexes/
+[*-master]: ${prefix}/${version}/indexes/atlas-search-index/ -> ${base}/${version}/indexes/
+[*-master]: ${prefix}/${version}/indexes/text-index/ -> ${base}/${version}/indexes/
+[*-master]: ${prefix}/${version}/indexes/geospatial-index/ -> ${base}/${version}/indexes/
+[*-master]: ${prefix}/${version}/indexes/unique-index/ -> ${base}/${version}/indexes/
+[*-master]: ${prefix}/${version}/indexes/wildcard-index/ -> ${base}/${version}/indexes/
+[*-master]: ${prefix}/${version}/indexes/clustered-index/ -> ${base}/${version}/indexes/
+
+[*-master]: ${prefix}/${version}/aggregation/aggregation-tutorials/ -> ${base}/${version}/aggregation/
+[*-master]: ${prefix}/${version}/aggregation/aggregation-tutorials/filtered-subset/ -> ${base}/${version}/aggregation/filtered-subset/
+[*-master]: ${prefix}/${version}/aggregation/aggregation-tutorials/group-total/ -> ${base}/${version}/aggregation/group-total/
+[*-master]: ${prefix}/${version}/aggregation/aggregation-tutorials/multi-field-join/ -> ${base}/${version}/aggregation/multi-field-join/
+[*-master]: ${prefix}/${version}/aggregation/aggregation-tutorials/one-to-one-join/ -> ${base}/${version}/aggregation/one-to-one-join/
+[*-master]: ${prefix}/${version}/aggregation/aggregation-tutorials/unpack-arrays/ -> ${base}/${version}/aggregation/unpack-arrays/
 
 # temp redirect until DOP deletes unversioned URLs
 [master]: ${prefix}/compatibility/ -> ${base}/current/compatibility/

snooty.toml

@@ -2,17 +2,16 @@ name = "pymongo"
 title = "PyMongo Driver"
 toc_landing_pages = [
     "/get-started",
-    "/write-operations",
-    "/read",
     "/connect",
-    "/indexes",
-    "work-with-indexes",
     "/aggregation",
-    "/aggregation/aggregation-tutorials",
     "/security",
     "/security/authentication",
-    "/aggregation-tutorials",
     "/data-formats",
+    "/connect/connection-options",
+    "crud",
+    "/crud/query",
+    "/crud/update",
+    "monitoring-and-logging"
 ]
 
 intersphinx = [

source/aggregation.txt

@@ -9,7 +9,7 @@ Transform Your Data with Aggregation
    :values: reference
 
 .. meta::
-   :keywords: code example, transform, computed, pipeline
+   :keywords: code example, transform, computed, pipeline, runnable app
    :description: Learn how to use {+driver-short+} to perform aggregation operations.
 
 .. contents:: On this page
@@ -22,7 +22,11 @@ Transform Your Data with Aggregation
    :titlesonly:
    :maxdepth: 1
 
-   Tutorials </aggregation/aggregation-tutorials>
+   Filtered Subset </aggregation/filtered-subset/>
+   Group & Total </aggregation/group-total/>
+   Unpack Arrays & Group </aggregation/unpack-arrays/>
+   One-to-One Join </aggregation/one-to-one-join/>
+   Multi-Field Join </aggregation/multi-field-join/>
 
 Overview
 --------
@@ -254,7 +258,36 @@ Aggregation Tutorials
 ~~~~~~~~~~~~~~~~~~~~~
 
 To view step-by-step explanations of common aggregation tasks, see
-:ref:`pymongo-aggregation-tutorials-landing`.
+the following tutorials:
+
+- :ref:`pymongo-aggregation-filtered-subset`
+- :ref:`pymongo-aggregation-group-total`
+- :ref:`pymongo-aggregation-arrays`
+- :ref:`pymongo-aggregation-one-to-one`
+- :ref:`pymongo-aggregation-multi-field`
+
+Aggregation tutorials provide detailed explanations of common
+aggregation tasks in a step-by-step format. The tutorials are adapted
+from examples in the `Practical MongoDB Aggregations book
+<https://www.practical-mongodb-aggregations.com/>`__ by Paul Done.
+
+Each tutorial includes the following sections:
+
+- **Introduction**, which describes the purpose and common use cases of the
+  aggregation type. This section also describes the example and desired
+  outcome that the tutorial demonstrates.
+
+- **Before You Get Started**, which describes the necessary databases,
+  collections, and sample data that you must have before building the
+  aggregation pipeline and performing the aggregation.
+
+- **Tutorial**, which describes how to build and run the aggregation
+  pipeline. This section describes each stage of the completed
+  aggregation tutorial, and then explains how to run and interpret the
+  output of the aggregation.
+
+At the end of each aggregation tutorial, you can find a link to a fully
+runnable Python code file that you can run in your environment.
 
 API Documentation
 ~~~~~~~~~~~~~~~~~

source/aggregation/aggregation-tutorials/filtered-subset.txt → source/aggregation/filtered-subset.txt

@@ -42,9 +42,7 @@ date of birth, vocation, and other details.
 Before You Get Started
 ----------------------
 
-Before you start this tutorial, complete the
-:ref:`pymongo-agg-tutorial-template-app` instructions to set up a working
-Python application.
+.. include:: /includes/aggregation-tutorial-intro.rst
 
 After you set up the app, access the ``persons`` collection by adding the
 following code to the application:

source/aggregation/aggregation-tutorials/group-total.txt → source/aggregation/group-total.txt

@@ -44,9 +44,7 @@ only one customer, the order documents are grouped by the
 Before You Get Started
 ----------------------
 
-Before you start this tutorial, complete the
-:ref:`pymongo-agg-tutorial-template-app` instructions to set up a working
-Python application.
+.. include:: /includes/aggregation-tutorial-intro.rst
 
 After you set up the app, access the ``orders`` collection by adding the
 following code to the application:

source/aggregation/aggregation-tutorials/multi-field-join.txt → source/aggregation/multi-field-join.txt

@@ -66,9 +66,7 @@ the ``orders`` collection.
 Before You Get Started
 ----------------------
 
-Before you start this tutorial, complete the
-:ref:`pymongo-agg-tutorial-template-app` instructions to set up a working
-Python application.
+.. include:: /includes/aggregation-tutorial-intro.rst
 
 After you set up the app, access the ``products`` and ``orders``
 collections by adding the following code to the application:

source/aggregation/aggregation-tutorials/one-to-one-join.txt → source/aggregation/one-to-one-join.txt

@@ -61,9 +61,7 @@ that exists in documents in both collections.
 Before You Get Started
 ----------------------
 
-Before you start this tutorial, complete the
-:ref:`pymongo-agg-tutorial-template-app` instructions to set up a working
-Python application.
+.. include:: /includes/aggregation-tutorial-intro.rst
 
 After you set up the app, access the ``orders`` and ``products``
 collections by adding the following code to the application:

source/aggregation/aggregation-tutorials/unpack-arrays.txt → source/aggregation/unpack-arrays.txt

@@ -46,9 +46,7 @@ into individual product order documents.
 Before You Get Started
 ----------------------
 
-Before you start this tutorial, complete the
-:ref:`pymongo-agg-tutorial-template-app` instructions to set up a working
-Python application.
+.. include:: /includes/aggregation-tutorial-intro.rst
 
 After you set up the app, access the ``orders`` collection by adding the
 following code to the application: