Skip to content

DOCSP-46320: Interact & model landing pages #13

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

Merged
merged 9 commits into from
Jan 27, 2025
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv",
]

toc_landing_pages = [
"/interact-data"
"/model-data",
"/interact-data",
]

[constants]
django-odm = "Django MongoDB Backend"
api = "https://django-mongodb.readthedocs.io/en/latest/"
api = "https://django-mongodb-backend.readthedocs.io/en/latest/"
mdb-server = "MongoDB Server"
django-version = "5.0"
django-docs = "https://docs.djangoproject.com/en/{+django-version+}"
framework = "Django"
pymongo-docs = "https://www.mongodb.com/docs/languages/python/pymongo-driver/current"
30 changes: 18 additions & 12 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,30 +11,30 @@ Django MongoDB Backend

.. toctree::

Model Your Data </model-data>
Interact with Data </interact-data>
Issues & Help </issues-and-help>
Compatibility </compatibility>
API Documentation <{+api+}>


.. TODO:
Get Started </get-started>
Connection Configuration </connect>
Model Your Data </model-data>
Django Feature Limitations </feature-limitations>
API Documentation <{+api+}>

.. warning:: Public Preview

{+django-odm+} is in Public Preview and available for evaluation purposes.
Public Preview is not recommended for production deployments, as breaking changes
may be introduced.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion:

Suggested change
{+django-odm+} is in Public Preview and available for evaluation purposes.
Public Preview is not recommended for production deployments, as breaking changes
may be introduced.
{+django-odm+} is in Public Preview and intended for evaluation purposes only.
Public Preview is not recommended for production deployments, as breaking changes
may be introduced.


Introduction
------------

Welcome to the documentation site for the official {+django-odm+},
a Django database backend that uses PyMongo to connect to MongoDB.

Interact with Data
------------------

Learn how to use {+django-odm+} to perform operations on MongoDB data
in the :ref:`django-interact-data` section.

.. TODO:

.. Get Started
Expand All @@ -49,11 +49,17 @@ in the :ref:`django-interact-data` section.
.. Learn how to configure a connection to a MongoDB deployment
in the :ref:`django-connection-configuration` section.

.. Model Your Data
.. ---------------
Model Your Data
---------------

Learn how to create Django models that represent MongoDB collections
in the :ref:`django-model-data` section.

.. Learn how to create Django models that represent MongoDB collections
in the :ref:`django-model-data` section.
Interact with Data
------------------

Learn how to use {+django-odm+} to perform operations on MongoDB data
in the :ref:`django-interact-data` section.

.. Django Feature Limitations
.. --------------------------
Expand Down
25 changes: 24 additions & 1 deletion source/interact-data.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,37 @@
Interact with Data
==================

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

.. facet::
:name: genre
:values: reference

.. meta::
:description: Learn how to use Django MongoDB Backend to interact with MongoDB data.
:keywords: odm, crud, query

.. toctree::
:caption: Interact with Data

Perform Raw Queries </interact-data/raw-queries>
Perform Raw Queries </interact-data/raw-queries>

.. TODO:
CRUD Operations </interact-data/crud>
Specify a Query </interact-data/specify-a-query>

In this section, you can learn how to use {+django-odm+} to interact with your
MongoDB data.

- :ref:`django-crud`: Learn how to perform create, read, update, and delete
operations on your data.

- :ref:`django-specify-query`: Learn how to perform complex read operations on
your data.

- :ref:`django-raw-queries`: Learn how to use MongoDB's aggregation pipeline syntax
or the PyMongo driver to query your data.
36 changes: 36 additions & 0 deletions source/model-data.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. _django-model-data:

===============
Model Your Data
===============

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

.. facet::
:name: genre
:values: reference

.. meta::
:description: Learn how to use Django MongoDB Backend to model MongoDB data.
:keywords: field, collection, object, model

.. toctree::
:titlesonly:
:maxdepth: 1

.. TODO:
Create Models </model-data/models>
Create Indexes </model-data/models>

In this section, you can learn how to create and customize
your Django models for use with MongoDB.

- :ref:`django-models`: Learn how to create models by using supported field
types and Django's model configuration features.

- :ref:`django-indexes`: Learn how to create indexes by modifying your
model classes.
Loading