-
Notifications
You must be signed in to change notification settings - Fork 34
DOCSP-47058: Shift TOC #251
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
Changes from 6 commits
b09530d
f3833c2
5f9ae2e
4893502
72bd19a
a253e74
44ad1b8
6b0af60
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -59,4 +59,37 @@ raw: ${prefix}/stable -> ${base}/current/ | |
[*-v1.19]: ${prefix}/${version}/tutorial/example-data/ -> ${base}/v1.x/ | ||
[*-v1.19]: ${prefix}/${version}/tutorial/modeling-bson-data/ -> ${base}/v1.x/data-formats/modeling-bson-data/ | ||
[*-v1.19]: ${prefix}/${version}/tutorial/stable-api/ -> ${base}/v1.x/stable-api/ | ||
[*-v1.19]: ${prefix}/${version}/tutorial/aws-lambda/ -> ${base}/v1.x/aws-lambda/ | ||
[*-v1.19]: ${prefix}/${version}/tutorial/aws-lambda/ -> ${base}/v1.x/aws-lambda/ | ||
|
||
# comprehensive coverage redirects | ||
[v2.x-*]: ${prefix}/${version}/aggregation/atlas-search/ -> ${base}/${version}/atlas-search/ | ||
[v2.x-*]: ${prefix}/${version}/aws-lambda/ -> ${base}/${version}/connect/aws-lambda/ | ||
[v2.x-*]: ${prefix}/${version}/connect/stable-api/ -> ${base}/${version}/connect/connection-options/stable-api/ | ||
[v2.x-*]: ${prefix}/${version}/builders/ -> ${base}/${version}/crud/builders/ | ||
[v2.x-*]: ${prefix}/${version}/write/bulk-write/ -> ${base}/${version}/crud/bulk-write/ | ||
[v2.x-*]: ${prefix}/${version}/write/delete/ -> ${base}/${version}/crud/delete/ | ||
[v2.x-*]: ${prefix}/${version}/write/gridfs/ -> ${base}/${version}/crud/gridfs/ | ||
[v2.x-*]: ${prefix}/${version}/write/insert/ -> ${base}/${version}/crud/insert/ | ||
[v2.x-*]: ${prefix}/${version}/read/count/ -> ${base}/${version}/crud/query/count/ | ||
[v2.x-*]: ${prefix}/${version}/read/cursor/ -> ${base}/${version}/crud/query/cursor/ | ||
[v2.x-*]: ${prefix}/${version}/read/distinct/ -> ${base}/${version}/crud/query/distinct/ | ||
[v2.x-*]: ${prefix}/${version}/read/project/ -> ${base}/${version}/crud/query/project/ | ||
[v2.x-*]: ${prefix}/${version}/read/retrieve/ -> ${base}/${version}/crud/query/retrieve/ | ||
[v2.x-*]: ${prefix}/${version}/read/specify-a-query/ -> ${base}/${version}/crud/query/specify-a-query/ | ||
[v2.x-*]: ${prefix}/${version}/read/specify-documents-to-return/ -> ${base}/${version}/crud/query/specify-documents-to-return/ | ||
[v2.x-*]: ${prefix}/${version}/read-write-pref/ -> ${base}/${version}/crud/read-write-pref/ | ||
[v2.x-*]: ${prefix}/${version}/write/replace/ -> ${base}/${version}/crud/replace/ | ||
[v2.x-*]: ${prefix}/${version}/write/transaction/ -> ${base}/${version}/crud/transaction/ | ||
[v2.x-*]: ${prefix}/${version}/write/update/ -> ${base}/${version}/crud/update/ | ||
[v2.x-*]: ${prefix}/${version}/data-formats/codecs/ -> ${base}/${version}/data-formats/custom-types/codecs/ | ||
[v2.x-*]: ${prefix}/${version}/databases-collections/time-series/ -> ${base}/${version}/data-formats/time-series/ | ||
[v2.x-*]: ${prefix}/${version}/read/change-streams/ -> ${base}/${version}/monitoring-logging/change-streams/ | ||
[v2.x-*]: ${prefix}/${version}/monitoring/cluster-monitoring/ -> ${base}/${version}/monitoring-logging/cluster-monitoring/ | ||
[v2.x-*]: ${prefix}/${version}/compatibility/ -> ${base}/${version}/references/compatibility/ | ||
[v2.x-*]: ${prefix}/${version}/whats-new/ -> ${base}/${version}/references/release-notes/ | ||
[v2.x-*]: ${prefix}/${version}/upgrade/ -> ${base}/${version}/references/upgrade/ | ||
[v2.x-*]: ${prefix}/${version}/connect/tls/ -> ${base}/${version}/security/tls/ | ||
[v2.x-*]: ${prefix}/${version}/aggregation/vector-search/ -> ${base}/${version}/vector-search/ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. S: consider redirecting to the monitoring-logging.txt landing page |
||
[v2.x-*]: ${prefix}/${version}/monitoring/ -> ${base}/${version}/ | ||
[v2.x-*]: ${prefix}/${version}/read/ -> ${base}/${version}/ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. S: consider redirecting these to the CRUD landing page instead |
||
[v2.x-*]: ${prefix}/${version}/write/ -> ${base}/${version}/ |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -21,14 +21,12 @@ toc_landing_pages = [ | |
"/reference/class/MongoDBModelDatabaseInfo", | ||
"/reference/class/MongoDBModelIndexInfo", | ||
"/connect", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. S: add |
||
"/read", | ||
"/databases-collections", | ||
"/write", | ||
"/aggregation", | ||
"/data-formats", | ||
"/data-formats/custom-types", | ||
"/indexes", | ||
"/security", | ||
"/data-formats", | ||
"/upgrade", | ||
"/aggregation", | ||
] | ||
|
||
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
.. _php-crud-operations: | ||
|
||
=============== | ||
CRUD Operations | ||
=============== | ||
|
||
.. contents:: On this page | ||
:local: | ||
:backlinks: none | ||
:depth: 2 | ||
:class: singlecol | ||
|
||
.. facet:: | ||
:name: genre | ||
:values: reference | ||
|
||
.. meta:: | ||
:description: Learn how to use the {+library-short+} to read and write MongoDB data. | ||
:keywords: usage examples, query, find, code example, save, create | ||
|
||
.. toctree:: | ||
:titlesonly: | ||
:maxdepth: 1 | ||
|
||
Insert Documents </crud/insert> | ||
Query Documents </crud/query> | ||
Update Documents </crud/update> | ||
Replace Documents </crud/replace> | ||
Delete Documents </crud/delete> | ||
Bulk Write Operations </crud/bulk-write> | ||
Transactions </crud/transaction> | ||
Configure CRUD Operations </crud/read-write-pref> | ||
Store Large Files </crud/gridfs> | ||
Operations with Builders </crud/builders> | ||
|
||
CRUD (Create, Read, Update, Delete) operations enable you to work with | ||
data stored in MongoDB. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. S: add a sentence introducing the list
|
||
|
||
- :ref:`php-write-insert` | ||
- :ref:`php-query` | ||
- :ref:`php-write-update` | ||
- :ref:`php-write-replace` | ||
- :ref:`php-write-delete` | ||
- :ref:`php-bulk-write` | ||
- :ref:`php-transactions` | ||
- :ref:`php-read-write-pref` | ||
- :ref:`php-gridfs` | ||
- :ref:`php-builders` |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -68,7 +68,7 @@ specify the write operations: | |||||
.. tip:: | ||||||
|
||||||
For more information about delete, insert, replace, and update | ||||||
operations, see the :ref:`Write operation guides <php-write>`. | ||||||
operations, see the :ref:`CRUD <php-crud-operations>` section. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
When you call the ``bulkWrite()`` method, the library automatically runs the | ||||||
write operations in the order they're specified in the array. To learn how to | ||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
.. _php-query: | ||
|
||
================ | ||
Query Operations | ||
================ | ||
|
||
.. meta:: | ||
:description: Learn how to use the {+library-short+} to read data from MongoDB. | ||
:keywords: usage examples, query, find, code example | ||
|
||
.. facet:: | ||
:name: genre | ||
:values: reference | ||
|
||
.. meta:: | ||
:keywords: code example, node.js, sample dataset | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
Find Documents </crud/query/retrieve> | ||
Specify Documents to Return </crud/query/specify-documents-to-return> | ||
Specify Fields to Return </crud/query/project> | ||
Specify a Query </crud/query/specify-a-query> | ||
Count Documents </crud/query/count> | ||
Distinct Field Values </crud/query/distinct> | ||
Access Data from a Cursor </crud/query/cursor> | ||
|
||
rustagir marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- :ref:`php-retrieve` | ||
- :ref:`php-specify-documents-to-return` | ||
- :ref:`php-project` | ||
- :ref:`php-count` | ||
- :ref:`php-distinct` | ||
- :ref:`php-cursors` |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,6 @@ | |
Codecs | ||
====== | ||
|
||
|
||
.. contents:: On this page | ||
:local: | ||
:backlinks: none | ||
|
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
@@ -344,5 +344,5 @@ and retrieves a document that matches a query. | |||||||||
|
||||||||||
Learn more about the {+php-library+} from the following resources: | ||||||||||
|
||||||||||
- Learn how to perform read operations in the :ref:`<php-read>` section. | ||||||||||
- Learn how to perform write operations in the :ref:`<php-write>` section. | ||||||||||
- Learn how to configure your MongoDB connection in the :ref:`<php-connect>` section. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. S: nit - dont need <> brackets when importing the ref title directly
Suggested change
|
||||||||||
- Learn how to perform read and write operations in the :ref:`<php-crud-operations>` section. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Q: are we going to backport the TOC changes as we've done with the other languages? in that case, should you redirect all versions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If that's what we've done for the others then yes I'll backport to all for PHP too, fixed!