Skip to content

Commit e297b29

Browse files
authored
DOCSP-46320: Interact & model landing pages (#13)
* DOCSP-46320: Interact &model landing pages * edits * fix index * warning * RM feedback * fix
1 parent 6a1c617 commit e297b29

File tree

5 files changed

+78
-12
lines changed

5 files changed

+78
-12
lines changed

snooty.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,17 @@ intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv",
77
]
88

99
toc_landing_pages = [
10+
"/model-data",
1011
"/get-started",
1112
"/interact-data",
1213
]
1314

1415
[constants]
1516
django-odm = "Django MongoDB Backend"
16-
api = "https://django-mongodb.readthedocs.io/en/latest/"
17+
api = "https://django-mongodb-backend.readthedocs.io/en/latest/"
1718
mdb-server = "MongoDB Server"
1819
django-version = "5.0"
1920
django-docs = "https://docs.djangoproject.com/en/{+django-version+}"
20-
django-api = "https://django-mongodb-backend.readthedocs.io/en/latest/"
21+
framework = "Django"
2122
pymongo-version = "4.10"
2223
pymongo-docs = "https://www.mongodb.com/docs/languages/python/pymongo-driver/current"

source/get-started/next-steps.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ and interacts with data.
1313
Learn more about {+django-odm+} from the following resources:
1414

1515
- :github:`django-mongodb-backend </mongodb-labs/django-mongodb-backend>` source code
16-
- `{+django-odm+} <{+django-api+}>`__ API documentation
16+
- `{+django-odm+} <{+api+}>`__ API documentation

source/index.txt

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,21 @@ Django MongoDB Backend
1313

1414
Get Started </get-started>
1515
Connection Configuration </connect>
16+
Model Your Data </model-data>
1617
Interact with Data </interact-data>
1718
Issues & Help </issues-and-help>
1819
Compatibility </compatibility>
20+
API Documentation <{+api+}>
1921

2022
.. TODO:
21-
Model Your Data </model-data>
2223
Django Feature Limitations </feature-limitations>
23-
API Documentation <{+api+}>
2424

25+
.. warning:: Public Preview
26+
27+
{+django-odm+} is in Public Preview and intended for evaluation purposes only.
28+
Public Preview is not recommended for production deployments, as breaking changes
29+
may be introduced.
30+
2531
Introduction
2632
------------
2733

@@ -40,6 +46,12 @@ Connection Configuration
4046
Learn how to configure a connection to a MongoDB deployment
4147
in the :ref:`django-connection-configuration` section.
4248

49+
Model Your Data
50+
---------------
51+
52+
Learn how to create Django models that represent MongoDB collections
53+
in the :ref:`django-model-data` section.
54+
4355
Interact with Data
4456
------------------
4557

@@ -48,12 +60,6 @@ in the :ref:`django-interact-data` section.
4860

4961
.. TODO:
5062

51-
.. Model Your Data
52-
.. ---------------
53-
54-
.. Learn how to create Django models that represent MongoDB collections
55-
in the :ref:`django-model-data` section.
56-
5763
.. Django Feature Limitations
5864
.. --------------------------
5965

source/interact-data.txt

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,37 @@
44
Interact with Data
55
==================
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
713
.. facet::
814
:name: genre
915
:values: reference
1016

1117
.. meta::
18+
:description: Learn how to use Django MongoDB Backend to interact with MongoDB data.
1219
:keywords: odm, crud, query
1320

1421
.. toctree::
1522
:caption: Interact with Data
1623

17-
Perform Raw Queries </interact-data/raw-queries>
24+
Perform Raw Queries </interact-data/raw-queries>
25+
26+
.. TODO:
27+
CRUD Operations </interact-data/crud>
28+
Specify a Query </interact-data/specify-a-query>
29+
30+
In this section, you can learn how to use {+django-odm+} to interact with your
31+
MongoDB data.
32+
33+
- :ref:`django-crud`: Learn how to perform create, read, update, and delete
34+
operations on your data.
35+
36+
- :ref:`django-specify-query`: Learn how to perform complex read operations on
37+
your data.
38+
39+
- :ref:`django-raw-queries`: Learn how to use MongoDB's aggregation pipeline syntax
40+
or the PyMongo driver to query your data.

source/model-data.txt

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. _django-model-data:
2+
3+
===============
4+
Model Your Data
5+
===============
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
.. facet::
14+
:name: genre
15+
:values: reference
16+
17+
.. meta::
18+
:description: Learn how to use Django MongoDB Backend to model MongoDB data.
19+
:keywords: field, collection, object, model
20+
21+
.. toctree::
22+
:titlesonly:
23+
:maxdepth: 1
24+
25+
.. TODO:
26+
Create Models </model-data/models>
27+
Create Indexes </model-data/models>
28+
29+
In this section, you can learn how to create and customize
30+
your Django models for use with MongoDB.
31+
32+
- :ref:`django-models`: Learn how to create models by using supported field
33+
types and Django's model configuration features.
34+
35+
- :ref:`django-indexes`: Learn how to create indexes by modifying your
36+
model classes.

0 commit comments

Comments
 (0)