Skip to content

Commit c407f23

Browse files
stephmarie17rachel-mack
authored andcommitted
DOCSP-48375 ToC reorg part one (#1035)
1 parent b3e13d4 commit c407f23

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+1464
-432
lines changed

config/redirects

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,63 @@ raw: ${prefix}/stable -> ${base}/current/
2323
[*-v5.5]: ${prefix}/${version}/fundamentals/run-command/ -> ${base}/${version}/usage-examples/command/
2424
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/change-a-document/ -> ${base}/${version}/fundamentals/crud/write-operations/modify/
2525

26-
[*-v6.0): ${prefix}/${version}/fundamentals/connection/socks/ -> ${base}/${version}/
26+
[*-v6.0)]: ${prefix}/${version}/fundamentals/connection/socks/ -> ${base}/${version}/
27+
28+
[*-master]: ${prefix}/${version}/quick-start/download-and-install/ -> ${base}/${version}/get-started/
29+
[*-master]: ${prefix}/${version}/quick-start/create-a-deployment/ -> ${base}/${version}/get-started/
30+
[*-master]: ${prefix}/${version}/quick-start/create-a-connection-string/ -> ${base}/${version}/get-started/
31+
[*-master]: ${prefix}/${version}/quick-start/connect-to-mongodb/ -> ${base}/${version}/get-started/
32+
[*-master]: ${prefix}/${version}/quick-start/next-steps/ -> ${base}/${version}/get-started/
33+
[*-master]: ${prefix}/${version}/fundamentals/connection/ -> ${base}/${version}/connect/
34+
[*-master]: ${prefix}/${version}/fundamentals/connection/connect/ -> ${base}/${version}/connect/mongoclient/
35+
[*-master]: ${prefix}/${version}/fundamentals/connection/connection-options/ -> ${base}/${version}/connect/connection-options/
36+
[*-master]: ${prefix}/${version}/connection-troubleshooting/ -> ${base}/${version}/connect/connection-troubleshooting/
37+
[*-master]: ${prefix}/${version}/fundamentals/connection/network-compression/ -> ${base}/${version}/connect/connection-options/network-compression/
38+
[*-master]: ${prefix}/${version}/fundamentals/connection/csot/ -> ${base}/${version}/connect/connection-options/csot/
39+
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/bulk/ -> ${base}/${version}/crud/bulk-write/
40+
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/insert/ -> ${base}/${version}/crud/insert/
41+
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/upsert/ -> ${base}/${version}/crud/update/
42+
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/delete/ -> ${base}/${version}/crud/delete/
43+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/ -> ${base}/${version}/crud/query/
44+
[*-master]: ${prefix}/${version}/fundamentals/crud/query-document/ -> ${base}/${version}/crud/query/query-document/
45+
[*-master]: ${prefix}/${version}/fundamentals/crud/compound-operations/ -> ${base}/${version}/crud/compound-operations/
46+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-write-pref/ -> ${base}/${version}/crud/read-write-pref/
47+
[*-master]: ${prefix}/${version}/fundamentals/transactions/ -> ${base}/${version}/crud/transactions/
48+
[*-master]: ${prefix}/${version}/fundamentals/gridfs/ -> ${base}/${version}/crud/gridfs/
49+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/retrieve/ -> ${base}/${version}/crud/query/retrieve/
50+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/project/ -> ${base}/${version}/crud/query/project/
51+
[*-master]: ${prefix}/${version}/fundamentals/usage-examples/count/ -> ${base}/${version}/crud/query/count/
52+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/distinct/ -> ${base}/${version}/crud/query/distinct/
53+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/cursor/ -> ${base}/${version}/crud/query/cursor/
54+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/geo/ -> ${base}/${version}/crud/query/geo/
55+
[*-master]: ${prefix}/${version}/fundamentals/crud/time-series/ -> ${base}/${version}/data-formats/time-series/
56+
[*-master]: ${prefix}/${version}/fundamentals/bson/ -> ${base}/${version}/data-formats/bson/
57+
[*-master]: ${prefix}/${version}/fundamentals/indexes/ -> ${base}/${version}/indexes/
58+
[*-master]: ${prefix}/${version}/fundamentals/run-command/ -> ${base}/${version}/run-command/
59+
[*-master]: ${prefix}/${version}/fundamentals/monitoring/ -> ${base}/${version}/monitoring-and-logging/monitoring/
60+
[*-master]: ${prefix}/${version}/fundamentals/logging/ -> ${base}/${version}/monitoring-and-logging/logging/
61+
[*-master]: ${prefix}/${version}/usage-examples/changeStream -> ${base}/monitoring-and-logging/change-streams/
62+
[*-master]: ${prefix}/${version}/fundamentals/aggregation/ -> ${base}/${version}/aggregation/
63+
[*-master]: ${prefix}/${version}/aggregation-tutorials/ -> ${base}/aggregation/
64+
[*-master]: ${prefix}/${version}/aggregation-tutorials/filtered-subset/ -> ${base}/aggregation/filtered-subset/
65+
[*-master]: ${prefix}/${version}/aggregation-tutorials/group-total/ -> ${base}/aggregation/group-total/
66+
[*-master]: ${prefix}/${version}/aggregation-tutorials/multi-field-join/ -> ${base}/aggregation/multi-field-join/
67+
[*-master]: ${prefix}/${version}/aggregation-tutorials/one-to-one-join/ -> ${base}/aggregation/one-to-one-join/
68+
[*-master]: ${prefix}/${version}/aggregation-tutorials/unpack-arrays/ -> ${base}/aggregation/unpack-arrays/
69+
[*-master]: ${prefix}/${version}/fundamentals/authentication -> ${base}/security/authentication/
70+
[*-master]: ${prefix}/${version}/fundamentals/authentication/mechanisms/ -> ${base}/security/authentication/mechanisms/
71+
[*-master]: ${prefix}/${version}/fundamentals/authentication/enterprise-mechanisms/ -> ${base}/security/authentication/enterprise-mechanisms/
72+
[*-master]: ${prefix}/${version}/fundamentals/encrypt-fields/ -> ${base}/security/encrypt-fields/
73+
[*-master]: ${prefix}/${version}/fundamentals/connection/tls/ -> ${base}/security/tls/
74+
[*-master]: ${prefix}/${version}/fundamentals/connection/socks/ -> ${base}/security/socks/
75+
[*-master]: ${prefix}/${version}/fundamentals/typescript/ -> ${base}/typescript/
76+
[*-master]: ${prefix}/${version}/whats-new/ -> ${base}/reference/release-notes/
77+
[*-master]: ${prefix}/${version}/compatibility/ -> ${base}/reference/compatibility/
78+
[*-master]: ${prefix}/${version}/upgrade/ -> ${base}/reference/upgrade/
79+
[*-master]: ${prefix}/${version}/quick-reference/ -> ${base}/reference/quick-reference/
80+
[*-master]: ${prefix}/${version}/fundamentals/collations/ -> ${base}/crud/configure/
81+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/text/ -> ${base}/crud/query/text/
82+
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/modify/ -> ${base}/crud/update/modify/
83+
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/embedded-arrays/ -> ${base}/crud/update/embedded-arrays/
84+
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/pkFactory/ -> ${base}/crud/pkFactory/
85+

snooty.toml

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,19 @@ intersphinx = [
77
]
88

99
toc_landing_pages = [
10-
"/fundamentals/authentication",
11-
"/fundamentals",
12-
"/fundamentals/connection",
13-
"/fundamentals/crud",
14-
"/fundamentals/bson",
15-
"/usage-examples",
16-
"/quick-start",
10+
"/get-started",
11+
"/connect",
12+
"/aggregation",
13+
"/aggregation/aggregation-tutorials",
14+
"/security",
15+
"/security/authentication",
1716
"/aggregation-tutorials",
17+
"/data-formats",
18+
"connect/connection-options",
19+
"crud",
20+
"/crud/query",
21+
"crud/update",
22+
"monitoring-and-logging"
1823
]
1924
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
2025

source/aggregation-tutorials.txt

Lines changed: 0 additions & 124 deletions
This file was deleted.

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

Lines changed: 114 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,12 @@
55
Aggregation
66
===========
77

8+
.. facet::
9+
:name: genre
10+
:values: reference
11+
812
.. meta::
13+
:keywords: node.js, code example, runnable app
914
:description: Learn to use aggregation operations in the MongoDB Node.js Driver to create pipelines for data transformation and summarization.
1015

1116
.. contents:: On this page
@@ -14,6 +19,14 @@ Aggregation
1419
:depth: 2
1520
:class: singlecol
1621

22+
.. toctree::
23+
24+
Filtered Subset </aggregation/filtered-subset/>
25+
Group & Total </aggregation/group-total/>
26+
Unpack Arrays & Group </aggregation/unpack-arrays/>
27+
One-to-One Join </aggregation/one-to-one-join/>
28+
Multi-Field Join </aggregation/multi-field-join/>
29+
1730
.. _nodejs-aggregation-overview:
1831

1932
Overview
@@ -101,7 +114,7 @@ database:
101114

102115
.. tip::
103116

104-
For more information on connecting to your MongoDB deployment, see the :doc:`Connection Guide </fundamentals/connection>`.
117+
For more information on connecting to your MongoDB deployment, see the :doc:`Connection Guide </connect>`.
105118

106119
Aggregation Example
107120
~~~~~~~~~~~~~~~~~~~
@@ -134,6 +147,106 @@ This example produces the following output:
134147

135148
For more information, see the `aggregate() API documentation <{+api+}/classes/Collection.html#aggregate>`__.
136149

150+
.. _node-aggregation-tutorials-landing:
151+
.. _node-aggregation-tutorials:
152+
153+
Aggregation Tutorials
154+
---------------------
155+
156+
Aggregation tutorials provide detailed explanations of common
157+
aggregation tasks in a step-by-step format. The tutorials are adapted
158+
from examples in the `Practical MongoDB Aggregations book
159+
<https://www.practical-mongodb-aggregations.com/>`__ by Paul Done.
160+
161+
Each tutorial includes the following sections:
162+
163+
- **Introduction**, which describes the purpose and common use cases of the
164+
aggregation type. This section also describes the example and desired
165+
outcome that the tutorial demonstrates.
166+
167+
- **Before You Get Started**, which describes the necessary databases,
168+
collections, and sample data that you must have before building the
169+
aggregation pipeline and performing the aggregation.
170+
171+
- **Tutorial**, which describes how to build and run the aggregation
172+
pipeline. This section describes each stage of the completed
173+
aggregation tutorial, and then explains how to run and interpret the
174+
output of the aggregation.
175+
176+
At the end of each aggregation tutorial, you can find a link to a fully
177+
runnable Node.js code file that you can run in your environment.
178+
179+
.. tip::
180+
181+
To learn more about performing aggregations, see the
182+
:ref:`node-aggregation` guide.
183+
184+
.. _node-agg-tutorial-template-app:
185+
186+
Aggregation Template App
187+
~~~~~~~~~~~~~~~~~~~~~~~~
188+
189+
Before you begin following an aggregation tutorial, you must set up a
190+
new Node.js app. You can use this app to connect to a MongoDB
191+
deployment, insert sample data into MongoDB, and run the aggregation
192+
pipeline in each tutorial.
193+
194+
.. tip::
195+
196+
To learn how to install the driver and connect to MongoDB,
197+
see the :ref:`node-get-started-download-and-install` and
198+
:ref:`node-get-started-create-deployment` steps of the
199+
Quick Start guide.
200+
201+
Once you install the driver, create a file called
202+
``agg_tutorial.js``. Paste the following code in this file to create an
203+
app template for the aggregation tutorials:
204+
205+
.. literalinclude:: /includes/aggregation/template-app.js
206+
:language: javascript
207+
:copyable: true
208+
209+
.. important::
210+
211+
In the preceding code, read the code comments to find the sections of
212+
the code that you must modify for the tutorial you are following.
213+
214+
If you attempt to run the code without making any changes, you will
215+
encounter a connection error.
216+
217+
For every tutorial, you must replace the connection string placeholder with
218+
your deployment's connection string.
219+
220+
.. tip::
221+
222+
To learn how to locate your deployment's connection string, see the
223+
:ref:`node-get-started-connection-string` step of the Quick Start guide.
224+
225+
For example, if your connection string is
226+
``"mongodb+srv://mongodb-example:27017"``, your connection string assignment resembles
227+
the following:
228+
229+
.. code-block:: javascript
230+
:copyable: false
231+
232+
const uri = "mongodb+srv://mongodb-example:27017";
233+
234+
To run the completed file after you modify the template for a
235+
tutorial, run the following command in your shell:
236+
237+
.. code-block:: bash
238+
239+
node agg_tutorial.js
240+
241+
Available Tutorials
242+
~~~~~~~~~~~~~~~~~~~
243+
244+
- :ref:`node-aggregation-filtered-subset`
245+
- :ref:`node-aggregation-group-total`
246+
- :ref:`node-aggregation-arrays`
247+
- :ref:`node-aggregation-one-to-one`
248+
- :ref:`node-aggregation-multi-field`
249+
137250
Additional Examples
138251
~~~~~~~~~~~~~~~~~~~
139252

source/fundamentals/collations.txt renamed to source/archive-reference-files/collations.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.. _node-fundamentals-collations:
2+
.. _node-collations:
23

34
==========
45
Collations
@@ -58,7 +59,7 @@ Usage
5859
-----
5960

6061
You can specify a collation when you create a new collection or new index. You
61-
can also specify a collation for :doc:`CRUD operations </fundamentals/crud>`
62+
can also specify a collation for :doc:`CRUD operations </crud>`
6263
and aggregations.
6364

6465
When you create a new collection with a collation, you define the default

0 commit comments

Comments
 (0)