Skip to content

DOCSP-50754: Add agg tutorials links #277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions config/redirects
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
define: prefix docs/languages/python/pymongo-driver
define: base https://www.mongodb.com/${prefix}
define: server https://www.mongodb.com/docs/manual
define: versions v4.0 v4.1 v4.2 v4.3 v4.4 v4.5 v4.6 v4.7 v4.8 v4.9 v4.10 v4.11 v4.12 v4.13 master

symlink: current -> master
Expand Down Expand Up @@ -169,10 +170,16 @@ raw: ${prefix}/security/authentication/kerberos/ -> ${base}/current/security/aut
[*-master]: ${prefix}/${version}/indexes/wildcard-index/ -> ${base}/${version}/indexes/
[*-master]: ${prefix}/${version}/indexes/clustered-index/ -> ${base}/${version}/indexes/

# Aggregation tutorials redirects
[*-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/
[*-master]: ${prefix}/${version}/aggregation/aggregation-tutorials/filtered-subset/ -> ${server}/tutorial/aggregation-examples/filtered-subset/
[*-master]: ${prefix}/${version}/aggregation/filtered-subset/ -> ${server}/tutorial/aggregation-examples/filtered-subset/
[*-master]: ${prefix}/${version}/aggregation/aggregation-tutorials/group-total/ -> ${server}/tutorial/aggregation-examples/group-and-total/
[*-master]: ${prefix}/${version}/aggregation/group-total/ -> ${server}/tutorial/aggregation-examples/group-and-total/
[*-master]: ${prefix}/${version}/aggregation/aggregation-tutorials/multi-field-join/ -> ${server}/tutorial/aggregation-examples/multi-field-join/
[*-master]: ${prefix}/${version}/aggregation/multi-field-join/ -> ${server}/tutorial/aggregation-examples/multi-field-join/
[*-master]: ${prefix}/${version}/aggregation/aggregation-tutorials/one-to-one-join/ ->${server}/tutorial/aggregation-examples/one-to-one-join/
[*-master]: ${prefix}/${version}/aggregation/one-to-one-join/ -> ${server}/tutorial/aggregation-examples/one-to-one-join/
[*-master]: ${prefix}/${version}/aggregation/aggregation-tutorials/unpack-arrays/ -> ${server}/tutorial/aggregation-examples/unpack-arrays/
[*-master]: ${prefix}/${version}/aggregation/unpack-arrays/ -> ${server}/tutorial/aggregation-examples/unpack-arrays/

1 change: 0 additions & 1 deletion snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title = "PyMongo Driver"
toc_landing_pages = [
"/get-started",
"/connect",
"/aggregation",
"/security",
"/security/authentication",
"/data-formats",
Expand Down
51 changes: 6 additions & 45 deletions source/aggregation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,6 @@ Transform Your Data with Aggregation
:depth: 2
:class: singlecol

.. toctree::
:titlesonly:
:maxdepth: 1

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
--------

Expand All @@ -50,6 +40,12 @@ The **aggregation pipeline** is the assembly line, **aggregation stages** are th
assembly stations, and **operator expressions** are the
specialized tools.

.. sharedinclude:: dbx/agg-tutorials-manual-tip.rst

.. replacement:: language

:guilabel:`{+language+}`

Aggregation Versus Find Operations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -281,41 +277,6 @@ To learn more about explaining MongoDB operations, see
:manual:`Explain Output </reference/explain-results/>` and
:manual:`Query Plans. </core/query-plans/>`

Aggregation Tutorials
~~~~~~~~~~~~~~~~~~~~~

To view step-by-step explanations of common aggregation tasks, see
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
~~~~~~~~~~~~~~~~~

Expand Down
218 changes: 0 additions & 218 deletions source/aggregation/filtered-subset.txt

This file was deleted.

Loading
Loading