From acff08b430f8530ab5d0dd4d21ff60d64fd01425 Mon Sep 17 00:00:00 2001 From: Jordan Smith Date: Mon, 13 Jan 2025 12:41:28 -0800 Subject: [PATCH 1/5] issues & help --- snooty.toml | 1 + source/django/issues-and-help.txt | 40 +++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+) create mode 100644 source/django/issues-and-help.txt diff --git a/snooty.toml b/snooty.toml index de16c44e..eead367f 100644 --- a/snooty.toml +++ b/snooty.toml @@ -25,6 +25,7 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" driver-short = "PyMongo" driver-long = "PyMongo, the MongoDB synchronous Python driver," driver-async = "PyMongo Async" +django-odm = "MongoDB Backend for Django" language = "Python" mdb-server = "MongoDB Server" mongo-community = "MongoDB Community Edition" diff --git a/source/django/issues-and-help.txt b/source/django/issues-and-help.txt new file mode 100644 index 00000000..9e6ca668 --- /dev/null +++ b/source/django/issues-and-help.txt @@ -0,0 +1,40 @@ +.. _django-issues-and-help: + +============= +Issues & Help +============= + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: suggestion, bug, github, django + +We're glad to have such a vibrant community of {+django-odm+} +users. We recommend seeking support for general +questions through the :community-forum:`MongoDB Community Forums. ` + +Bugs / Feature Requests +----------------------- + +To report a bug or to request a new feature in {+driver-short+}, +please open an issue in JIRA, our issue-management tool, using the +following steps: + +1. `Create a JIRA account `__. +#. Navigate to `the Python Integrations project `__. +#. Click :guilabel:`Create Issue`. Please provide as much information as possible about the + issue and the steps to reproduce it. + +Bug reports in JIRA for the {+driver-short+} project can be viewed by everyone. + +If you identify a security vulnerability in the driver or in any other +MongoDB project, please report it according to the instructions found in +:manual:`Create a Vulnerability Report `. \ No newline at end of file From 398ae659024077e1d4fe10e598def7dcd85e99e6 Mon Sep 17 00:00:00 2001 From: Jordan Smith Date: Mon, 13 Jan 2025 12:50:16 -0800 Subject: [PATCH 2/5] fix constants --- source/django/issues-and-help.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/django/issues-and-help.txt b/source/django/issues-and-help.txt index 9e6ca668..3fc2ffa9 100644 --- a/source/django/issues-and-help.txt +++ b/source/django/issues-and-help.txt @@ -24,7 +24,7 @@ questions through the :community-forum:`MongoDB Community Forums. ` Bugs / Feature Requests ----------------------- -To report a bug or to request a new feature in {+driver-short+}, +To report a bug or to request a new feature in {+django-odm+}, please open an issue in JIRA, our issue-management tool, using the following steps: @@ -33,7 +33,7 @@ following steps: #. Click :guilabel:`Create Issue`. Please provide as much information as possible about the issue and the steps to reproduce it. -Bug reports in JIRA for the {+driver-short+} project can be viewed by everyone. +Bug reports in JIRA for the {+django-odm+} project can be viewed by everyone. If you identify a security vulnerability in the driver or in any other MongoDB project, please report it according to the instructions found in From 9e68635f56aed197ef9394780800b3ef5f7bebd1 Mon Sep 17 00:00:00 2001 From: Jordan Smith Date: Mon, 13 Jan 2025 12:53:18 -0800 Subject: [PATCH 3/5] fixes --- source/django/issues-and-help.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/django/issues-and-help.txt b/source/django/issues-and-help.txt index 3fc2ffa9..aeed53d0 100644 --- a/source/django/issues-and-help.txt +++ b/source/django/issues-and-help.txt @@ -17,14 +17,14 @@ Issues & Help .. meta:: :keywords: suggestion, bug, github, django -We're glad to have such a vibrant community of {+django-odm+} -users. We recommend seeking support for general +We're glad to have such a vibrant community of users for the {+django-odm+}. We +recommend seeking support for general questions through the :community-forum:`MongoDB Community Forums. ` Bugs / Feature Requests ----------------------- -To report a bug or to request a new feature in {+django-odm+}, +To report a bug or to request a new feature in the {+django-odm+}, please open an issue in JIRA, our issue-management tool, using the following steps: From ac043fbcb4afd58e153f02a67327782326bf982b Mon Sep 17 00:00:00 2001 From: Jordan Smith Date: Mon, 13 Jan 2025 12:55:02 -0800 Subject: [PATCH 4/5] wording --- source/django/issues-and-help.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/django/issues-and-help.txt b/source/django/issues-and-help.txt index aeed53d0..90d2178d 100644 --- a/source/django/issues-and-help.txt +++ b/source/django/issues-and-help.txt @@ -17,7 +17,7 @@ Issues & Help .. meta:: :keywords: suggestion, bug, github, django -We're glad to have such a vibrant community of users for the {+django-odm+}. We +We're glad to have such a vibrant community of users of the {+django-odm+}. We recommend seeking support for general questions through the :community-forum:`MongoDB Community Forums. ` From 9f0cb6641b068957aa20433111b108e604d348ff Mon Sep 17 00:00:00 2001 From: Jordan Smith Date: Tue, 14 Jan 2025 10:41:04 -0800 Subject: [PATCH 5/5] feedback --- snooty.toml | 2 +- source/django/issues-and-help.txt | 11 ++++++++--- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/snooty.toml b/snooty.toml index eead367f..1f5fb267 100644 --- a/snooty.toml +++ b/snooty.toml @@ -25,7 +25,7 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" driver-short = "PyMongo" driver-long = "PyMongo, the MongoDB synchronous Python driver," driver-async = "PyMongo Async" -django-odm = "MongoDB Backend for Django" +django-odm = "Django MongoDB Backend" language = "Python" mdb-server = "MongoDB Server" mongo-community = "MongoDB Community Edition" diff --git a/source/django/issues-and-help.txt b/source/django/issues-and-help.txt index 90d2178d..1bf548b7 100644 --- a/source/django/issues-and-help.txt +++ b/source/django/issues-and-help.txt @@ -17,14 +17,19 @@ Issues & Help .. meta:: :keywords: suggestion, bug, github, django -We're glad to have such a vibrant community of users of the {+django-odm+}. We +We're glad to have such a vibrant community of users of {+django-odm+}. We recommend seeking support for general -questions through the :community-forum:`MongoDB Community Forums. ` +questions through the :community-forum:`MongoDB Community Forums `. + +.. TODO: Uncomment below when limitations page is done +.. .. note:: + +.. {+django-odm+} is in public preview. To see a list of limitations, see the :ref:`limitations` page. Bugs / Feature Requests ----------------------- -To report a bug or to request a new feature in the {+django-odm+}, +To report a bug or to request a new feature in {+django-odm+}, please open an issue in JIRA, our issue-management tool, using the following steps: