Skip to content

Commit c5f7fd8

Browse files
authored
DOCSP-47058: Shift TOC (#251)
* DOCSP-47058: Shift TOC * edits * issues and help, edits * fix errors * redirects * landing * RR feedback * RR feedback 2
1 parent d53a70b commit c5f7fd8

Some content is hidden

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

58 files changed

+334
-495
lines changed

config/redirects

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,37 @@ raw: ${prefix}/stable -> ${base}/current/
5959
[*-v1.19]: ${prefix}/${version}/tutorial/example-data/ -> ${base}/v1.x/
6060
[*-v1.19]: ${prefix}/${version}/tutorial/modeling-bson-data/ -> ${base}/v1.x/data-formats/modeling-bson-data/
6161
[*-v1.19]: ${prefix}/${version}/tutorial/stable-api/ -> ${base}/v1.x/stable-api/
62-
[*-v1.19]: ${prefix}/${version}/tutorial/aws-lambda/ -> ${base}/v1.x/aws-lambda/
62+
[*-v1.19]: ${prefix}/${version}/tutorial/aws-lambda/ -> ${base}/v1.x/aws-lambda/
63+
64+
# comprehensive coverage redirects
65+
[*-master]: ${prefix}/${version}/aggregation/atlas-search/ -> ${base}/${version}/atlas-search/
66+
[*-master]: ${prefix}/${version}/aws-lambda/ -> ${base}/${version}/connect/aws-lambda/
67+
[*-master]: ${prefix}/${version}/connect/stable-api/ -> ${base}/${version}/connect/connection-options/stable-api/
68+
[*-master]: ${prefix}/${version}/builders/ -> ${base}/${version}/crud/builders/
69+
[*-master]: ${prefix}/${version}/write/bulk-write/ -> ${base}/${version}/crud/bulk-write/
70+
[*-master]: ${prefix}/${version}/write/delete/ -> ${base}/${version}/crud/delete/
71+
[*-master]: ${prefix}/${version}/write/gridfs/ -> ${base}/${version}/crud/gridfs/
72+
[*-master]: ${prefix}/${version}/write/insert/ -> ${base}/${version}/crud/insert/
73+
[*-master]: ${prefix}/${version}/read/count/ -> ${base}/${version}/crud/query/count/
74+
[*-master]: ${prefix}/${version}/read/cursor/ -> ${base}/${version}/crud/query/cursor/
75+
[*-master]: ${prefix}/${version}/read/distinct/ -> ${base}/${version}/crud/query/distinct/
76+
[*-master]: ${prefix}/${version}/read/project/ -> ${base}/${version}/crud/query/project/
77+
[*-master]: ${prefix}/${version}/read/retrieve/ -> ${base}/${version}/crud/query/retrieve/
78+
[*-master]: ${prefix}/${version}/read/specify-a-query/ -> ${base}/${version}/crud/query/specify-a-query/
79+
[*-master]: ${prefix}/${version}/read/specify-documents-to-return/ -> ${base}/${version}/crud/query/specify-documents-to-return/
80+
[*-master]: ${prefix}/${version}/read-write-pref/ -> ${base}/${version}/crud/read-write-pref/
81+
[*-master]: ${prefix}/${version}/write/replace/ -> ${base}/${version}/crud/replace/
82+
[*-master]: ${prefix}/${version}/write/transaction/ -> ${base}/${version}/crud/transaction/
83+
[*-master]: ${prefix}/${version}/write/update/ -> ${base}/${version}/crud/update/
84+
[*-master]: ${prefix}/${version}/data-formats/codecs/ -> ${base}/${version}/data-formats/custom-types/codecs/
85+
[*-master]: ${prefix}/${version}/databases-collections/time-series/ -> ${base}/${version}/data-formats/time-series/
86+
[*-master]: ${prefix}/${version}/read/change-streams/ -> ${base}/${version}/monitoring-logging/change-streams/
87+
[*-master]: ${prefix}/${version}/monitoring/cluster-monitoring/ -> ${base}/${version}/monitoring-logging/cluster-monitoring/
88+
[*-master]: ${prefix}/${version}/compatibility/ -> ${base}/${version}/references/compatibility/
89+
[*-master]: ${prefix}/${version}/whats-new/ -> ${base}/${version}/references/release-notes/
90+
[*-master]: ${prefix}/${version}/upgrade/ -> ${base}/${version}/references/upgrade/
91+
[*-master]: ${prefix}/${version}/connect/tls/ -> ${base}/${version}/security/tls/
92+
[*-master]: ${prefix}/${version}/aggregation/vector-search/ -> ${base}/${version}/vector-search/
93+
[*-master]: ${prefix}/${version}/monitoring/ -> ${base}/${version}/monitoring-logging/
94+
[*-master]: ${prefix}/${version}/read/ -> ${base}/${version}/crud/
95+
[*-master]: ${prefix}/${version}/write/ -> ${base}/${version}/crud/

snooty.toml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,13 @@ toc_landing_pages = [
2121
"/reference/class/MongoDBModelDatabaseInfo",
2222
"/reference/class/MongoDBModelIndexInfo",
2323
"/connect",
24-
"/read",
25-
"/databases-collections",
26-
"/write",
24+
"/connect/connection-options/",
25+
"/aggregation",
26+
"/data-formats",
27+
"/data-formats/custom-types",
2728
"/indexes",
2829
"/security",
29-
"/data-formats",
3030
"/upgrade",
31-
"/aggregation",
3231
]
3332

3433
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"

source/aggregation.txt

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,6 @@ Transform Your Data with Aggregation
1818
:depth: 2
1919
:class: singlecol
2020

21-
.. toctree::
22-
:titlesonly:
23-
:maxdepth: 1
24-
25-
Atlas Search </aggregation/atlas-search>
26-
Atlas Vector Search </aggregation/vector-search>
27-
2821
Overview
2922
--------
3023

File renamed without changes.

source/connect.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,12 @@ Connect to MongoDB
2323
:maxdepth: 1
2424

2525
Create a Client </connect/client>
26-
Specify Connection Options </connect/connection-options>
2726
Choose a Connection Target </connect/connection-targets>
28-
Configure TLS </connect/tls>
29-
Stable API </connect/stable-api>
27+
Connection Options </connect/connection-options>
28+
Connect with AWS Lambda </connect/aws-lambda>
29+
30+
.. TODO:
31+
Connection Troubleshooting </connect/connection-troubleshooting>
3032

3133
Overview
3234
--------
File renamed without changes.

source/connect/connection-options.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ Specify Connection Options
1717
.. meta::
1818
:keywords: connection string, URI, server, Atlas, settings, configure
1919

20+
.. toctree::
21+
22+
Stable API </connect/connection-options/stable-api>
23+
24+
.. TODO:
25+
Compress Network Traffic </connect/connection-options/network-compression>
26+
Connection Pools </connect/connection-options/connection-pools>
27+
2028
Overview
2129
--------
2230

source/crud.txt

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
.. _php-crud-operations:
2+
3+
===============
4+
CRUD Operations
5+
===============
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
.. facet::
14+
:name: genre
15+
:values: reference
16+
17+
.. meta::
18+
:description: Learn how to use the {+library-short+} to read and write MongoDB data.
19+
:keywords: usage examples, query, find, code example, save, create
20+
21+
.. toctree::
22+
:titlesonly:
23+
:maxdepth: 1
24+
25+
Insert Documents </crud/insert>
26+
Query Documents </crud/query>
27+
Update Documents </crud/update>
28+
Replace Documents </crud/replace>
29+
Delete Documents </crud/delete>
30+
Bulk Write Operations </crud/bulk-write>
31+
Transactions </crud/transaction>
32+
Configure CRUD Operations </crud/read-write-pref>
33+
Store Large Files </crud/gridfs>
34+
Operations with Builders </crud/builders>
35+
36+
CRUD (Create, Read, Update, Delete) operations enable you to work with
37+
data stored in MongoDB. To learn more about running CRUD operations on
38+
your data, visit the following guides:
39+
40+
- :ref:`php-write-insert`
41+
- :ref:`php-query`
42+
- :ref:`php-write-update`
43+
- :ref:`php-write-replace`
44+
- :ref:`php-write-delete`
45+
- :ref:`php-bulk-write`
46+
- :ref:`php-transactions`
47+
- :ref:`php-read-write-pref`
48+
- :ref:`php-gridfs`
49+
- :ref:`php-builders`
File renamed without changes.

source/write/bulk-write.txt renamed to source/crud/bulk-write.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ specify the write operations:
6868
.. tip::
6969

7070
For more information about delete, insert, replace, and update
71-
operations, see the :ref:`Write operation guides <php-write>`.
71+
operations, see the :ref:`php-crud-operations` guides.
7272

7373
When you call the ``bulkWrite()`` method, the library automatically runs the
7474
write operations in the order they're specified in the array. To learn how to
File renamed without changes.
File renamed without changes.

source/write/insert.txt renamed to source/crud/insert.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,6 @@ insert operation bypasses document-level validation:
158158
Additional Information
159159
----------------------
160160

161-
To view runnable code examples of inserting documents with the {+php-library+}, see
162-
:ref:`php-write`.
163-
164161
API Documentation
165162
~~~~~~~~~~~~~~~~~
166163

source/crud/query.txt

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.. _php-query:
2+
3+
================
4+
Query Operations
5+
================
6+
7+
.. meta::
8+
:description: Learn how to use the {+library-short+} to read data from MongoDB.
9+
:keywords: usage examples, query, find, code example
10+
11+
.. facet::
12+
:name: genre
13+
:values: reference
14+
15+
.. meta::
16+
:keywords: code example, node.js, sample dataset
17+
18+
.. toctree::
19+
:maxdepth: 1
20+
21+
Find Documents </crud/query/retrieve>
22+
Specify Documents to Return </crud/query/specify-documents-to-return>
23+
Specify Fields to Return </crud/query/project>
24+
Specify a Query </crud/query/specify-a-query>
25+
Count Documents </crud/query/count>
26+
Distinct Field Values </crud/query/distinct>
27+
Access Data from a Cursor </crud/query/cursor>
28+
29+
To learn more about querying data stored in MongoDB collections,
30+
visit the following guides:
31+
32+
- :ref:`php-retrieve`
33+
- :ref:`php-specify-documents-to-return`
34+
- :ref:`php-project`
35+
- :ref:`php-count`
36+
- :ref:`php-distinct`
37+
- :ref:`php-cursors`
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

source/read/retrieve.txt renamed to source/crud/query/retrieve.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -240,9 +240,6 @@ Additional Information
240240

241241
To learn more about query filters, see the :ref:`php-specify-query` guide.
242242

243-
To view code examples of retrieving documents with the {+php-library+},
244-
see :ref:`php-read`.
245-
246243
API Documentation
247244
~~~~~~~~~~~~~~~~~
248245

File renamed without changes.
File renamed without changes.

source/write/transaction.txt renamed to source/crud/transaction.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,8 @@ completes the following actions:
163163

164164
.. sharedinclude:: dbx/transactions-parallelism.rst
165165

166+
.. replacement:: driver-specific-content
167+
166168
Additional Information
167169
----------------------
168170

File renamed without changes.

source/data-formats.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ Specialized Data Formats
2222
:maxdepth: 1
2323

2424
Custom Data Types </data-formats/custom-types>
25-
Codecs </data-formats/codecs>
2625
Decimal128 </data-formats/decimal128>
2726
BSON </data-formats/modeling-bson-data>
27+
Time Series </data-formats/time-series>
2828

2929
Overview
3030
--------
@@ -34,6 +34,6 @@ application. To learn how to work with these data formats, see the following
3434
guides:
3535

3636
- :ref:`php-custom-types`
37-
- :ref:`php-codecs`
3837
- :ref:`php-decimal128`
39-
- :ref:`php-bson`
38+
- :ref:`php-bson`
39+
- :ref:`php-time-series`

source/data-formats/custom-types.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@
44
Custom Data-Types
55
=================
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
.. toctree::
14+
:maxdepth: 1
15+
16+
Codecs </data-formats/custom-types/codecs>
717

818
.. note::
919

source/data-formats/codecs.txt renamed to source/data-formats/custom-types/codecs.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
Codecs
55
======
66

7-
87
.. contents:: On this page
98
:local:
109
:backlinks: none

source/databases-collections/time-series.txt renamed to source/data-formats/time-series.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ following Server manual entries:
196196
- :manual:`Create and Query a Time Series Collection </core/timeseries/timeseries-procedures/>`
197197
- :manual:`Set Granularity for Time Series Data </core/timeseries/timeseries-granularity/>`
198198

199-
To learn more about performing read operations, see :ref:`php-read`.
199+
To learn more about performing query operations, see :ref:`php-query`.
200200

201201
To learn more about performing aggregation operations, see the :ref:`php-aggregation`
202202
guide.

source/databases-collections.txt

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,6 @@ Databases and Collections
1717
.. meta::
1818
:keywords: table, row, organize, storage, code example
1919

20-
.. toctree::
21-
:titlesonly:
22-
:maxdepth: 1
23-
24-
Time Series </databases-collections/time-series>
25-
2620
Overview
2721
--------
2822

source/get-started.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,5 +344,5 @@ and retrieves a document that matches a query.
344344

345345
Learn more about the {+php-library+} from the following resources:
346346

347-
- Learn how to perform read operations in the :ref:`<php-read>` section.
348-
- Learn how to perform write operations in the :ref:`<php-write>` section.
347+
- Learn how to configure your MongoDB connection in the :ref:`php-connect` section.
348+
- Learn how to perform read and write operations in the :ref:`php-crud-operations` section.

source/includes/extracts-bucket-option.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
ref: bucket-option-codec
22
content: |
3-
The :doc:`codec </data-formats/codecs>` to use for encoding or decoding documents.
3+
The :ref:`php-codecs` to use for encoding or decoding documents.
44
This option is mutually exclusive with the ``typeMap`` option.
55
66
Defaults to the bucket's codec. Inheritance for a default ``codec`` option

source/includes/extracts-collection-option.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
ref: collection-option-codec
22
content: |
3-
The :doc:`codec </data-formats/codecs>` to use for encoding or decoding documents.
3+
The :ref:`php-codecs` to use for encoding or decoding documents.
44
This option is mutually exclusive with the ``typeMap`` option.
55
66
Defaults to the collection's codec. Inheritance for a default ``codec`` option

source/includes/extracts-common-option.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
ref: common-option-codec
22
content: |
3-
The :doc:`codec </data-formats/codecs>` to use for encoding or decoding documents.
3+
The :ref:`php-codecs` to use for encoding or decoding documents.
44
This option is mutually exclusive with the ``typeMap`` option.
55
---
66
ref: common-option-collation

0 commit comments

Comments
 (0)