DOCSP-45382 - Comprehensive Coverage (#654)

(cherry picked from commit 7dfe216)

Author: mongoKart

config/intersphinx.yaml

@@ -1,4 +1,4 @@
-# Weirdly, giza wants a non-empty list of two or more, so we have to include extraneous/unused one --hence the python
+# Weirdly, giza wants a non-empty list of two or more, so we must include extraneous/unused one --hence the python
 name: python
 url: https://docs.python.org/2/
 path: python2.inv

config/redirects

@@ -23,3 +23,76 @@ raw: ${prefix}/master -> ${base}/upcoming/
 [*-v2.30]: ${prefix}/${version}/fundamentals/odata/ -> ${base}/${version}/
 [*-v2.30]: ${prefix}/${version}/fundamentals/crud/write-operations/bulk-write/ -> ${base}/${version}/fundamentals/crud/write-operations/
 [v2.22-v2.24]: ${prefix}/${version}/fundamentals/authentication/oidc/ -> ${base}/${version}/fundamentals/authentication/
+
+# comprehensive coverage reorg
+[*-master]: ${prefix}/${version}/fundamentals/ -> ${base}/${version}/
+[*-master]: ${prefix}/${version}/fundamentals/connection/ -> ${base}/${version}/
+[*-master]: ${prefix}/${version}/fundamentals/crud/ -> ${base}/${version}/
+[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/ -> ${base}/${version}/
+[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/ -> ${base}/${version}/
+[*-master]: ${prefix}/${version}/usage-examples/ -> ${base}/${version}/
+[*-master]: ${prefix}/${version}/get-started/create-connection-string/ -> ${base}/${version}/get-started/
+[*-master]: ${prefix}/${version}/get-started/deploy-cluster/ -> ${base}/${version}/get-started/
+[*-master]: ${prefix}/${version}/get-started/download-driver/ -> ${base}/${version}/get-started/
+[*-master]: ${prefix}/${version}/get-started/run-sample-query/ -> ${base}/${version}/get-started/
+[*-master]: ${prefix}/${version}/compatibility/ -> ${base}/${version}/reference/compatibility/
+[*-master]: ${prefix}/${version}/previous-versions/ -> ${base}/${version}/reference/previous-versions/
+[*-master]: ${prefix}/${version}/quick-reference/ -> ${base}/${version}/reference/quick-reference/
+[*-master]: ${prefix}/${version}/whats-new/ -> ${base}/${version}/reference/release-notes/
+[*-master]: ${prefix}/${version}/upgrade/ -> ${base}/${version}/reference/upgrade/
+[*-master]: ${prefix}/${version}/upgrade/v2/ -> ${base}/${version}/reference/upgrade/v2/
+[*-master]: ${prefix}/${version}/upgrade/v3/ -> ${base}/${version}/reference/upgrade/v3/
+[*-master]: ${prefix}/${version}/fundamentals/linq/ -> ${base}/${version}/aggregation/
+[*-master]: ${prefix}/${version}/fundamentals/aggregation/ -> ${base}/${version}/aggregation/
+[*-master]: ${prefix}/${version}/fundamentals/odata/ -> ${base}/${version}/integrations/odata/
+[*-master]: ${prefix}/${version}/fundamentals/indexes/ -> ${base}/${version}/indexes/
+[*-master]: ${prefix}/${version}/fundamentals/atlas-search/ -> ${base}/${version}/atlas-search/
+[*-master]: ${prefix}/${version}/fundamentals/builders/ -> ${base}/${version}/
+[*-master]: ${prefix}/${version}/fundamentals/connection/connection-options/ -> ${base}/${version}/connect/connection-options/
+[*-master]: ${prefix}/${version}/fundamentals/connection/connection-pools/ -> ${base}/${version}/connect/connection-options/connection-pools/
+[*-master]: ${prefix}/${version}/fundamentals/connection/network-compression/ -> ${base}/${version}/connect/connection-options/network-compression/
+[*-master]: ${prefix}/${version}/fundamentals/connection/server-selection/ -> ${base}/${version}/connect/connection-options/server-selection/
+[*-master]: ${prefix}/${version}/fundamentals/connection/connect/ -> ${base}/${version}/connect/mongoclient/
+[*-master]: ${prefix}/${version}/fundamentals/connection/tls/ -> ${base}/${version}/security/tls-ssl/
+[*-master]: ${prefix}/${version}/fundamentals/read-write-configuration/ -> ${base}/${version}/crud/configure/
+[*-master]: ${prefix}/${version}/connection-troubleshooting/ -> ${base}/${version}/connect/connection-troubleshooting/
+[*-master]: ${prefix}/${version}/fundamentals/geo/ -> ${base}/${version}/crud/geo/
+[*-master]: ${prefix}/${version}/fundamentals/stable-api/ -> ${base}/${version}/connect/connection-options/stable-api/
+[*-master]: ${prefix}/${version}/fundamentals/gridfs/ -> ${base}/${version}/crud/gridfs/
+[*-master]: ${prefix}/${version}/fundamentals/specify-query/ -> ${base}/${version}/crud/query/specify-query/
+[*-master]: ${prefix}/${version}/fundamentals/transactions/ -> ${base}/${version}/crud/transactions/
+[*-master]: ${prefix}/${version}/fundamentals/bson/ -> ${base}/${version}/document-formats/bson/
+[*-master]: ${prefix}/${version}/fundamentals/time-series/ -> ${base}/${version}/time-series/
+[*-master]: ${prefix}/${version}/fundamentals/logging/ -> ${base}/${version}/logging-and-monitoring/logging/
+[*-master]: ${prefix}/${version}/fundamentals/monitoring/ -> ${base}/${version}/logging-and-monitoring/monitoring/
+[*-master]: ${prefix}/${version}/fundamentals/database-collection/ -> ${base}/${version}/databases-collections/
+[*-master]: ${prefix}/${version}/fundamentals/encrypt-fields/ -> ${base}/${version}/security/in-use-encryption/
+[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/distinct/ -> ${base}/${version}/crud/query/distinct/
+[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/retrieve/ -> ${base}/${version}/crud/query/find/
+[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/project/ -> ${base}/${version}/crud/query/project/
+[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/specify-documents-to-return/ -> ${base}/${version}/crud/query/specify-documents-to-return/
+[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/change-streams/ -> ${base}/${version}/logging-and-monitoring/change-streams/
+[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/insert/ -> ${base}/${version}/crud/insert/
+[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/delete/ -> ${base}/${version}/crud/delete/
+[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/bulk-write/ -> ${base}/${version}/bulk-write/
+[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/replace/ -> ${base}/${version}/crud/replace/
+[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/update-many/ -> ${base}/${version}/crud/update-many/
+[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/update-many/arrays/ -> ${base}/${version}/crud/update-many/arrays/
+[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/update-many/fields/ -> ${base}/${version}/crud/update-many/fields/
+[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/update-one/ -> ${base}/${version}/crud/update-one/
+[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/update-one/arrays/ -> ${base}/${version}/crud/update-one/arrays/
+[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/update-one/fields/ -> ${base}/${version}/crud/update-one/fields/
+[*-master]: ${prefix}/${version}/fundamentals/serialization/class-mapping/ -> ${base}/${version}/serialization/class-mapping/
+[*-master]: ${prefix}/${version}/fundamentals/serialization/poco/ -> ${base}/${version}/serialization/poco/
+[*-master]: ${prefix}/${version}/fundamentals/serialization/polymorphic-objects/ -> ${base}/${version}/serialization/polymorphic-objects/
+[*-master]: ${prefix}/${version}/fundamentals/serialization/ -> ${base}/${version}/serialization/
+[*-master]: ${prefix}/${version}/fundamentals/databases-collections/run-command/ -> ${base}/${version}/run-command/
+[*-master]: ${prefix}/${version}/fundamentals/authentication/ -> ${base}/${version}/security/authentication/
+[*-master]: ${prefix}/${version}/fundamentals/authentication/aws-iam/ -> ${base}/${version}/security/authentication/aws-iam/
+[*-master]: ${prefix}/${version}/fundamentals/authentication/kerberos/ -> ${base}/${version}/security/authentication/kerberos/
+[*-master]: ${prefix}/${version}/fundamentals/authentication/ldap/ -> ${base}/${version}/security/authentication/ldap/
+[*-master]: ${prefix}/${version}/fundamentals/authentication/oidc/ -> ${base}/${version}/security/authentication/oidc/
+[*-master]: ${prefix}/${version}/fundamentals/authentication/scram/ -> ${base}/${version}/security/authentication/scram/
+[*-master]: ${prefix}/${version}/fundamentals/authentication/x509/ -> ${base}/${version}/security/authentication/x509/
+[*-master]: ${prefix}/${version}/crud/query/specify-documents-to-return/ -> ${base}/${version}/crud/query/specify-documents/
+[*-master]: ${prefix}/${version}/crud/query/specify-query/ -> ${base}/${version}/crud/query/query-filter/

snooty.toml

@@ -1,15 +1,11 @@
 toc_landing_pages = [
-    "/fundamentals/connection",
-    "/fundamentals/crud",
-    "/usage-examples",
-    "/fundamentals",
-    "/fundamentals/serialization",
-    "/fundamentals/crud/write-operations/update-one",
-    "/fundamentals/crud/write-operations/update-many",
-    "/fundamentals/authentication",
-    "/upgrade",
-    "/fundamentals/database-collection",
-    "/fundamentals/indexes",
+    "/get-started",
+    "/connect/connection-options",
+    "/security/authentication",
+    "/aggregation",
+    "/aggregation/stages",
+    "/serialization",
+    "/indexes",
 ]
 name = "csharp"
 title = "C#/.NET Driver"
@@ -50,4 +46,4 @@ not-available = "N/A"
 analyzer = "MongoDB C# Analyzer"
 analyzer-short = "C# Analyzer"
 query-api = "MongoDB Query API"
-vector-search = "Atlas Vector Search"
+avs = "Atlas Vector Search"

source/aggregation.txt

@@ -0,0 +1,119 @@
+.. _csharp-aggregation:
+
+======================
+Aggregation Operations
+======================
+
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: dotnet, code example, transform, pipeline
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   Pipeline Stages </aggregation/stages>
+   LINQ </aggregation/linq>
+
+Overview
+--------
+
+In this guide, you can learn how to use the {+driver-long+} to perform
+**aggregation operations**.
+
+Aggregation operations process data in your MongoDB collections and
+return computed results. The MongoDB Aggregation framework is modeled on the 
+concept of data processing pipelines. Documents enter a pipeline comprised of one or
+more stages, and this pipeline transforms the documents into an aggregated result.
+
+To learn more about the aggregation stages supported by the {+driver-short+}, see
+:ref:`Aggregation Stages <csharp-aggregation-stages>`.
+
+.. sharedinclude:: dbx/agg-tutorials-manual-tip.rst
+
+   .. replacement:: language
+
+      :guilabel:`{+language+}`
+
+Analogy
+~~~~~~~
+
+Aggregation operations function similarly to car factories with assembly
+lines. The assembly lines have stations with specialized tools to
+perform specific tasks. For example, when building a car, the assembly
+line begins with the frame. Then, as the car frame moves through the
+assembly line, each station assembles a separate part. The result is a
+transformed final product, the finished car.
+
+The assembly line represents the *aggregation pipeline*, the individual
+stations represent the *aggregation stages*, the specialized tools
+represent the *expression operators*, and the finished product
+represents the *aggregated result*.
+
+Compare Aggregation and Find Operations
+---------------------------------------
+
+The following table lists the different tasks you can perform with find
+operations, compared to what you can achieve with aggregation
+operations. The aggregation framework provides expanded functionality
+that allows you to transform and manipulate your data.
+
+.. list-table::
+   :header-rows: 1
+   :widths: 50 50
+
+   * - Find Operations
+     - Aggregation Operations
+
+   * - | Select *certain* documents to return
+       | Select *which* fields to return
+       | Sort the results
+       | Limit the results
+       | Count the results
+     - | Select *certain* documents to return
+       | Select *which* fields to return
+       | Sort the results
+       | Limit the results
+       | Count the results
+       | Group the results
+       | Rename fields
+       | Compute new fields
+       | Summarize data
+       | Connect and merge data sets
+
+Server Limitations
+------------------
+
+Consider the following :manual:`limitations </core/aggregation-pipeline-limits/>` when 
+performing aggregation operations:
+
+- Returned documents must not violate the :manual:`BSON document size limit </reference/limits/#mongodb-limit-BSON-Document-Size>`
+  of 16 megabytes.
+
+- Pipeline stages have a memory limit of 100 megabytes by default. If required, you can exceed this limit by setting
+  the `AllowDiskUse <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.AggregateOptions.AllowDiskUse.html#MongoDB_Driver_AggregateOptions_AllowDiskUse>`__
+  property of the ``AggregateOptions`` object that you pass to the ``Aggregate()`` method.
+
+Troubleshooting
+---------------
+
+.. include:: /includes/troubleshooting/unsupported-filter-expression.rst
+
+Additional Information
+----------------------
+
+To view a full list of expression operators, see 
+:manual:`Aggregation Operators </reference/operator/aggregation/>`.
+
+To learn about explaining MongoDB aggregation operations, see
+:manual:`Explain Results </reference/explain-results/>` and
+:manual:`Query Plans </core/query-plans/>`.

source/fundamentals/linq.txt renamed to source/aggregation/linq.txt

@@ -1,5 +1,8 @@
 .. _csharp-linq:
 
+======================================
+LINQ Syntax for Aggregation Operations
+======================================
 ======================================
 LINQ Syntax for Aggregation Operations
 ======================================
@@ -36,7 +39,7 @@ The {+driver-short+} automatically translates LINQ queries into
 The examples in this guide use the ``restaurants`` collection
 in the ``sample_restaurants`` database provided in the :atlas:`Atlas sample datasets </sample-data>`.
 To learn how to create a free MongoDB Atlas cluster and load the sample datasets,
-see the :ref:`<csharp-quickstart>`.
+see :ref:`<csharp-get-started>`.
 
 The following ``Restaurant``, ``Address`` and ``GradeEntry`` classes model the
 documents in this collection:
@@ -1025,7 +1028,7 @@ aggregation stages:
 - ``$out``
 
 To learn how to create an aggregation pipeline with the ``$out`` stage by using Builders, see
-the :ref:`<csharp-builders-out>` section.
+:ref:`<csharp-aggregation-stages>`.
 
 Supported Methods
 -----------------