From e071a070a88a9ada0ff968f0cb160ab1456da3d1 Mon Sep 17 00:00:00 2001 From: norareidy Date: Fri, 24 Jan 2025 10:16:09 -0500 Subject: [PATCH 1/6] DOCSP-46320: Interact &model landing pages --- snooty.toml | 6 +++++- source/index.txt | 22 ++++++++++++---------- source/interact-data.txt | 39 +++++++++++++++++++++++++++++++++++++++ source/model-data.txt | 36 ++++++++++++++++++++++++++++++++++++ 4 files changed, 92 insertions(+), 11 deletions(-) create mode 100644 source/interact-data.txt create mode 100644 source/model-data.txt diff --git a/snooty.toml b/snooty.toml index 1fe2cb2..12f8502 100644 --- a/snooty.toml +++ b/snooty.toml @@ -6,7 +6,10 @@ intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv", "http://docs.djangoproject.com/en/5.0/_objects/" ] -# toc_landing_pages = ["/paths/to/pages/that/have/nested/content"] +toc_landing_pages = [ + "/model-data", + "/interact-data", +] [constants] django-odm = "Django MongoDB Backend" @@ -14,3 +17,4 @@ api = "https://django-mongodb.readthedocs.io/en/latest/" mdb-server = "MongoDB Server" django-version = "5.0" django-docs = "https://docs.djangoproject.com/en/{+django-version+}" +framework = "Django" diff --git a/source/index.txt b/source/index.txt index ea41052..daf36ee 100644 --- a/source/index.txt +++ b/source/index.txt @@ -11,6 +11,8 @@ Django MongoDB Backend .. toctree:: + Model Your Data + Interact with Data Issues & Help Compatibility @@ -18,8 +20,8 @@ Django MongoDB Backend .. TODO: Get Started Connection Configuration - Interact with Data - Model Your Data + + Django Feature Limitations API Documentation <{+api+}> @@ -43,17 +45,17 @@ a Django database backend that uses PyMongo to connect to MongoDB. .. Learn how to configure a connection to a MongoDB deployment in the :ref:`django-connection-configuration` section. -.. Interact with Data -.. ------------------ +Model Your Data +--------------- -.. Learn how to use {+django-odm+} to perform operations on MongoDB data - in the :ref:`django-interact-data` section. +Learn how to create Django models that represent MongoDB collections +in the :ref:`django-model-data` section. -.. Model Your Data -.. --------------- +Interact with Data +------------------ -.. Learn how to create Django models that represent MongoDB collections - in the :ref:`django-model-data` section. +Learn how to use {+django-odm+} to perform operations on MongoDB data +in the :ref:`django-interact-data` section. .. Django Feature Limitations .. -------------------------- diff --git a/source/interact-data.txt b/source/interact-data.txt new file mode 100644 index 0000000..7d19511 --- /dev/null +++ b/source/interact-data.txt @@ -0,0 +1,39 @@ +.. _django-interact-data: + +================== +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 + +.. TODO: + CRUD Operations + Specify a Query + Perform Raw Queries + +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 From 18d4f409b1e9bb29a17bd24718a37b8e1cc0fc7d Mon Sep 17 00:00:00 2001 From: norareidy Date: Fri, 24 Jan 2025 10:22:20 -0500 Subject: [PATCH 2/6] edits --- source/interact-data.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/interact-data.txt b/source/interact-data.txt index 7d19511..6662e28 100644 --- a/source/interact-data.txt +++ b/source/interact-data.txt @@ -21,10 +21,11 @@ Interact with Data .. toctree:: :caption: Interact with Data + Perform Raw Queries + .. TODO: CRUD Operations Specify a Query - Perform Raw Queries In this section, you can learn how to use {+django-odm+} to interact with your MongoDB data. From 668407392c7bdf01ef492b93aef9e05691f4b0ee Mon Sep 17 00:00:00 2001 From: norareidy Date: Fri, 24 Jan 2025 10:24:39 -0500 Subject: [PATCH 3/6] fix index --- source/index.txt | 6 ------ 1 file changed, 6 deletions(-) diff --git a/source/index.txt b/source/index.txt index 00bbdf3..0bfb74f 100644 --- a/source/index.txt +++ b/source/index.txt @@ -29,12 +29,6 @@ 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 From c4528c613334d6672e1105935deb90253f988d97 Mon Sep 17 00:00:00 2001 From: norareidy Date: Fri, 24 Jan 2025 11:06:59 -0500 Subject: [PATCH 4/6] warning --- source/index.txt | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/source/index.txt b/source/index.txt index 0bfb74f..858214d 100644 --- a/source/index.txt +++ b/source/index.txt @@ -23,6 +23,12 @@ Django MongoDB Backend Connection Configuration Django Feature Limitations +.. 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. + Introduction ------------ From a38c6ce0996c55589731d588d58212a5af24d56a Mon Sep 17 00:00:00 2001 From: norareidy Date: Mon, 27 Jan 2025 10:18:29 -0500 Subject: [PATCH 5/6] RM feedback --- source/index.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.txt b/source/index.txt index 858214d..7619895 100644 --- a/source/index.txt +++ b/source/index.txt @@ -25,7 +25,7 @@ Django MongoDB Backend .. warning:: Public Preview - {+django-odm+} is in Public Preview and available for evaluation purposes. + {+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. From 4876212966b0ea20a213fb5953ccb31bb19c7483 Mon Sep 17 00:00:00 2001 From: norareidy Date: Mon, 27 Jan 2025 11:27:27 -0500 Subject: [PATCH 6/6] fix --- snooty.toml | 1 - source/get-started/next-steps.txt | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/snooty.toml b/snooty.toml index 1039880..958dedf 100644 --- a/snooty.toml +++ b/snooty.toml @@ -19,6 +19,5 @@ mdb-server = "MongoDB Server" django-version = "5.0" django-docs = "https://docs.djangoproject.com/en/{+django-version+}" framework = "Django" -django-api = "https://django-mongodb-backend.readthedocs.io/en/latest/" 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