Skip to content

Update docs #24

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 4 commits into from
Apr 24, 2025
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ Table of Contents
-----------------

.. toctree::
third-party-library-support/index
installation
usage/index
third-party-library-support/index
supported-libraries/index
glossary

Expand Down
12 changes: 9 additions & 3 deletions docs/source/third-party-library-support/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
Third party library support
===========================

This is the criteria used to determine if a third party library is supported
by Django MongoDB Backend. It is not a guarantee that the library will
work without issues, just that these criteria have been met.
A third party library supported when the following criteria are met:

.. note::

This is the criteria used to determine if a third party library is
supported by :ref:`Django MongoDB Backend <django-mongodb-backend>`.

It is not a guarantee that the library will work without issues,
just that these criteria have been met.

.. toctree::
test-suites
Expand Down
30 changes: 15 additions & 15 deletions docs/source/third-party-library-support/test-suites.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,26 @@ Test suites

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

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

- Evaluate test runner configuration
a. Evaluate test runner configuration

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

- Update django settings
b. Update django settings

- Replace the database backend with ``django_mongodb_backend``
- Replace contrib apps with MongoDB compatible apps
- Replace test suite apps with MongoDB compatible apps
i. Replace the database backend with ``django_mongodb_backend``
#. Replace contrib apps with MongoDB compatible apps
#. Replace test suite apps with MongoDB compatible apps

- Update or disable migrations
c. Update or disable migrations

- Use MongoDB compatible migrations if not disabled
i. Use MongoDB compatible migrations if not disabled

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

- Replace static primary key references with dynamic references or static ``ObjectId`` references
a. Replace static primary key references with dynamic references or static ``ObjectId`` references
10 changes: 5 additions & 5 deletions docs/source/usage/third-party.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ django-filter

dm repo test django-filter

When completed successfully the output should look something like this:
When completed successfully the output will look like this:

.. image:: ../_static/images/django-filter.png

Expand All @@ -19,7 +19,7 @@ django-rest-framework

dm repo test django-rest-framework

When completed successfully the output should look something like this:
When completed successfully the output will look like this:

.. image:: ../_static/images/django-rest-framework.png

Expand All @@ -30,7 +30,7 @@ django-debug-toolbar

dm repo test django-debug-toolbar

When completed successfully the output should look something like this:
When completed successfully the output will look like this:

.. image:: ../_static/images/django-debug-toolbar.png

Expand All @@ -48,7 +48,7 @@ django-allauth

dm repo test django-allauth

When completed successfully the output should look something like this:
When completed successfully the output will look like this:

.. image:: ../_static/images/django-allauth.png

Expand All @@ -59,6 +59,6 @@ wagtail

dm repo test wagtail

When completed successfully the output should look something like this:
When completed successfully the output will look like this:

.. image:: ../_static/images/wagtail.png