Skip to content

Commit c306f19

Browse files
committed
Update support criteria
1 parent f7a97cf commit c306f19

File tree

2 files changed

+24
-18
lines changed

2 files changed

+24
-18
lines changed

docs/source/third-party-library-support/index.rst

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
Third party library support
22
===========================
33

4-
This is the criteria used to determine if a third party library is supported
5-
by Django MongoDB Backend. It is not a guarantee that the library will
6-
work without issues, just that these criteria have been met.
4+
A third party library supported when the following criteria are met:
5+
6+
.. note::
7+
8+
This is the criteria used to determine if a third party library is
9+
supported by :ref:`Django MongoDB Backend <django-mongodb-backend>`.
10+
11+
It is not a guarantee that the library will work without issues,
12+
just that these criteria have been met.
713

814
.. toctree::
915
test-suites

docs/source/third-party-library-support/test-suites.rst

+15-15
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,26 @@ Test suites
55

66
For each third party library that is supported, the following tasks are performed:
77

8-
- The test suite is configured to run with Django MongoDB Backend
8+
#. **The test suite is configured to run with Django MongoDB Backend.**
99

10-
- Evaluate test runner configuration
10+
a. Evaluate test runner configuration
1111

12-
- Depending on the test runner, updating the settings may require copying
13-
``mongo_apps.py`` and ``mongo_migrations`` to a module that is already
14-
included in ``sys.path``.
12+
i. Depending on the test runner, updating the settings may require
13+
copying ``mongo_apps.py`` and ``mongo_migrations`` to a module that is
14+
already included in ``sys.path``.
1515

16-
- Update django settings
16+
b. Update django settings
1717

18-
- Replace the database backend with ``django_mongodb_backend``
19-
- Replace contrib apps with MongoDB compatible apps
20-
- Replace test suite apps with MongoDB compatible apps
18+
i. Replace the database backend with ``django_mongodb_backend``
19+
#. Replace contrib apps with MongoDB compatible apps
20+
#. Replace test suite apps with MongoDB compatible apps
2121

22-
- Update or disable migrations
22+
c. Update or disable migrations
2323

24-
- Use MongoDB compatible migrations if not disabled
24+
i. Use MongoDB compatible migrations if not disabled
2525

26-
- The test suite is run with Django MongoDB Backend
27-
- The test results are recorded
28-
- The test suite is updated
26+
2. **The test suite is run with Django MongoDB Backend configured.**
27+
#. **The test run results are logged.**
28+
#. **The test suite tests are updated as needed.**
2929

30-
- Replace static primary key references with dynamic references or static ``ObjectId`` references
30+
a. Replace static primary key references with dynamic references or static ``ObjectId`` references

0 commit comments

Comments
 (0)