Skip to content

Commit 850369d

Browse files
rustagirrustagir
authored
Merge branch 'master' into DOCSP-30559-compat
2 parents 3a294aa + 28b6d92 commit 850369d

File tree

7 files changed

+168
-4
lines changed

7 files changed

+168
-4
lines changed

‎.github/workflows/copy-compat-to-docs-shared.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Copy Files to docs-shared
2+
3+
on:
4+
push:
5+
branches:
6+
- "master"
7+
paths:
8+
- "source/includes/mongodb-compatibility-table-rust.rst"
9+
- "source/includes/language-compatibility-table-rust.rst"
10+
11+
jobs:
12+
copy-file:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v2
17+
18+
- name: Copy mongodb-compat table
19+
uses: dmnemec/copy_file_to_another_repo_action@main
20+
env:
21+
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
22+
with:
23+
source_file: "source/includes/mongodb-compatibility-table-rust.rst"
24+
destination_repo: "10gen/docs-shared"
25+
destination_folder: "dbx"
26+
user_email: "docs-builder-bot@mongodb.com"
27+
user_name: "docs-builder-bot"
28+
commit_message: "Auto-import from docs-rust"
29+
30+
- name: Copy language-compat table
31+
uses: dmnemec/copy_file_to_another_repo_action@main
32+
env:
33+
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
34+
with:
35+
source_file: "source/includes/language-compatibility-table-rust.rst"
36+
destination_repo: "10gen/docs-shared"
37+
destination_folder: "dbx"
38+
user_email: "docs-builder-bot@mongodb.com"
39+
user_name: "docs-builder-bot"
40+
commit_message: "Auto-import from docs-rust"

‎snooty.toml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv",
66
"https://www.mongodb.com/docs/atlas/objects.inv"
77
]
88

9-
# toc_landing_pages = ["/paths/to/pages/that/have/nested/content"]
9+
toc_landing_pages = [
10+
"/fundamentals/connection",
11+
"/fundamentals/crud"
12+
]
1013

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

‎source/fundamentals.txt‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
.. _rust-fundamentals:
2+
3+
============
4+
Fundamentals
5+
============
6+
7+
.. toctree::
8+
:titlesonly:
9+
:maxdepth: 1
10+
11+
/fundamentals/connections
12+
/fundamentals/crud
13+
14+
..
15+
Connect to MongoDB Atlas from AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>
16+
/fundamentals/stable-api
17+
/fundamentals/context
18+
/fundamentals/auth
19+
/fundamentals/enterprise-auth
20+
/fundamentals/bson
21+
/fundamentals/aggregation
22+
/fundamentals/indexes
23+
/fundamentals/transactions
24+
/fundamentals/logging
25+
/fundamentals/run-command
26+
/fundamentals/collations
27+
/fundamentals/monitoring
28+
/fundamentals/gridfs
29+
/fundamentals/time-series
30+
/fundamentals/encrypt-fields
31+
/fundamentals/geo
32+
33+
.. include:: /includes/fundamentals-sections.rst

‎source/fundamentals/connections.txt‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.. _rust-connection:
2+
3+
===========
4+
Connections
5+
===========
6+
7+
.. toctree::
8+
9+
..
10+
/fundamentals/connection/connection-guide
11+
/fundamentals/connection/connection-options
12+
/fundamentals/connection/network-compression
13+
/fundamentals/connection/tls
14+
Connect to MongoDB Atlas from AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>
15+
16+
.. contents:: On this page
17+
:local:
18+
:backlinks: none
19+
:depth: 1
20+
:class: singlecol
21+
22+
Overview
23+
--------
24+
25+
Learn how to configure your application's connection to a MongoDB
26+
deployment using the {+driver-short+} in the following sections:
27+
28+
.. - :ref:`Connect to MongoDB <rust-connect-to-mongodb>`
29+
.. - :ref:`Connection Options <rust-connection-options>`
30+
.. - :ref:`Enable Network Compression <rust-network-compression>`
31+
.. - :ref:`Enable TLS on a Connection <rust-connect-tls>`
32+
.. - :atlas:`Connect to MongoDB Atlas from AWS Lambda </manage-connections-aws-lambda/>`
33+
34+
.. To learn how to authenticate to MongoDB, see the following pages:
35+
36+
.. - :ref:`rust-authentication-mechanisms`
37+
.. - :ref:`rust-enterprise-authentication-mechanisms`

‎source/fundamentals/crud.txt‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. _rust-crud:
2+
3+
===============
4+
CRUD Operations
5+
===============
6+
7+
.. toctree::
8+
:caption: CRUD Operations
9+
10+
..
11+
/fundamentals/crud/read-operations
12+
/fundamentals/crud/write-operations
13+
/fundamentals/crud/compound-operations
14+
/fundamentals/crud/write-read-pref
15+
16+
CRUD (create, read, update, and delete) operations enable you to work
17+
with data stored in MongoDB.
18+
19+
.. - :ref:`rust-crud-read-operations` find and return
20+
.. documents stored in your database.
21+
.. - :ref:`rust-crud-write-operations` insert, modify,
22+
.. or delete documents in your database.
23+
24+
.. Compound operations combine functionalities of read and write
25+
.. operations. To learn more about these methods, see
26+
.. the :ref:`rust-compound-operations` guide.
27+
28+
.. To learn how to modify the way your CRUD operations execute on
29+
.. the server, see the :ref:`rust-write-read-pref` guide.

‎source/includes/fundamentals-sections.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Learn how to perform the following tasks using the {+driver-short+} in the
2+
Fundamentals section:
3+
4+
- :ref:`Connect to MongoDB <rust-connection>`
5+
- :ref:`Read from and Write to MongoDB <rust-crud>`
6+
7+
..
8+
- :atlas:`Connect to MongoDB Atlas from AWS Lambda </manage-connections-aws-lambda/>`
9+
- :ref:`Specify the Stable API Version <rust-stable-api>`
10+
- :ref:`Authenticate to MongoDB <rust-authentication-mechanisms>`
11+
- :ref:`Connect with Enterprise Authentication Mechanisms <rust-enterprise-authentication-mechanisms>`
12+
- :ref:`Convert Data to and from BSON <rust-bson>`
13+
- :ref:`Perform Aggregations <rust-aggregation>`
14+
- :ref:`Construct Indexes <rust-indexes>`
15+
- :ref:`Specify Collations to Order Results <rust-collations>`
16+
- :ref:`Record Log Messages <rust-logging>`
17+
- :ref:`Run A Database Command <rust-run-command>`
18+
- :ref:`Monitor Driver Events <rust-monitoring>`
19+
- :ref:`Store and Retrieve Large Files by Using GridFS <rust-gridfs>`
20+
- :ref:`Use a Time Series Collection <rust-time-series>`
21+
- :ref:`Encrypt Fields <rust-fle>`
22+
- :ref:`Query and Write Geospatial Data <rust-geo>`

‎source/index.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
:titlesonly:
77
:maxdepth: 1
88

9+
/fundamentals
10+
API Documentation <{+api+}/>
911
/compatibility
1012
View the Source <https://github.com/mongodb/mongo-rust-driver>
1113

@@ -14,8 +16,6 @@
1416
/quick-reference
1517
/whats-new
1618
/usage-examples
17-
/fundamentals
18-
API Documentation <{+api+}/mongo>
1919
/faq
2020
/connection-troubleshooting
2121
/issues-and-help
@@ -55,7 +55,7 @@ Usage Examples
5555
Fundamentals
5656
------------
5757

58-
.. .. include:: /includes/fundamentals-sections.rst
58+
.. include:: /includes/fundamentals-sections.rst
5959

6060
API
6161
---

0 commit comments

Comments
 (0)