diff --git a/snooty.toml b/snooty.toml index b2a0dd1..958dedf 100644 --- a/snooty.toml +++ b/snooty.toml @@ -7,16 +7,17 @@ intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv", ] toc_landing_pages = [ + "/model-data", "/get-started", "/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+}" -django-api = "https://django-mongodb-backend.readthedocs.io/en/latest/" +framework = "Django" pymongo-version = "4.10" pymongo-docs = "https://www.mongodb.com/docs/languages/python/pymongo-driver/current" diff --git a/source/get-started/next-steps.txt b/source/get-started/next-steps.txt index ffe2162..022242c 100644 --- a/source/get-started/next-steps.txt +++ b/source/get-started/next-steps.txt @@ -13,4 +13,4 @@ and interacts with data. Learn more about {+django-odm+} from the following resources: - :github:`django-mongodb-backend ` source code -- `{+django-odm+} <{+django-api+}>`__ API documentation \ No newline at end of file +- `{+django-odm+} <{+api+}>`__ API documentation \ No newline at end of file diff --git a/source/index.txt b/source/index.txt index bef3a79..cc62cfb 100644 --- a/source/index.txt +++ b/source/index.txt @@ -13,15 +13,21 @@ Django MongoDB Backend Get Started Connection Configuration + Model Your Data Interact with Data Issues & Help Compatibility + API Documentation <{+api+}> .. TODO: - Model Your Data Django Feature Limitations - API Documentation <{+api+}> +.. warning:: Public Preview + + {+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 ------------ @@ -40,6 +46,12 @@ Connection Configuration Learn how to configure a connection to a MongoDB deployment in the :ref:`django-connection-configuration` section. +Model Your Data +--------------- + +Learn how to create Django models that represent MongoDB collections +in the :ref:`django-model-data` section. + Interact with Data ------------------ @@ -48,12 +60,6 @@ in the :ref:`django-interact-data` section. .. TODO: -.. Model Your Data -.. --------------- - -.. Learn how to create Django models that represent MongoDB collections - in the :ref:`django-model-data` section. - .. Django Feature Limitations .. -------------------------- diff --git a/source/interact-data.txt b/source/interact-data.txt index 024caa3..6662e28 100644 --- a/source/interact-data.txt +++ b/source/interact-data.txt @@ -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 \ No newline at end of file + Perform Raw Queries + +.. TODO: + CRUD Operations + 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. \ No newline at end of file diff --git a/source/model-data.txt b/source/model-data.txt new file mode 100644 index 0000000..67d55e8 --- /dev/null +++ b/source/model-data.txt @@ -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 + Create Indexes + +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. \ No newline at end of file