restructure docs per Diátaxis framework #233
Conversation
timgraham
force-pushed
the
intersphinx-django-https
branch
7 times, most recently
from
ab68e23 to
ae26783
Compare
docs/source/intro/configure.rst
Outdated
| :setting:`USER`, :setting:`PASSWORD`, and :setting:`PORT` (if 27017) may also | ||
| be optional. |
There was a problem hiding this comment.
Can we have it say, if you do not require authentication, :setting:USER and :setting:PASSWORD should be omitted.
| :setting:`USER`, :setting:`PASSWORD`, and :setting:`PORT` (if 27017) may also | |
| be optional. | |
| :setting:`USER` and :setting:`PASSWORD` should be omitted if you do not require authentication. | |
| :setting:`PORT` (if 27017) may also be optional. |
| MONGODB_URI = "mongodb+srv://my_user:[email protected]/myDatabase?retryWrites=true&w=majority&tls=false" | ||
| DATABASES["default"] = django_mongodb_backend.parse_uri(MONGODB_URI) |
docs/source/intro/index.rst
Outdated
| If you're new to Django_, you might want to start by getting an idea of | ||
| what it's like. The :doc:`official Django tutorial | ||
| <django:intro/tutorial01>` is a great place to start. Once you understand |
There was a problem hiding this comment.
We should also point to our Getting Started on the MongoDB docs as well. The Django Tutorial site won't make it clear how they should run the app using the library.
docs/source/ref/utils.rst
Outdated
| .. function:: parse_uri(uri, conn_max_age=0, test=None) | ||
|
|
||
| Parses a MongoDB URI into a dictionary suitable for Django's | ||
| :setting:`DATABASES` setting. |
|
|
||
| Like any database, MongoDB has some particularities. Also keep in mind that | ||
| because MongoDB is a NoSQL database, it's impossible to implement SQL-specific | ||
| functionality. |
There was a problem hiding this comment.
| functionality. | |
| functionality. | |
| If you notice an issue not listed or would like a feature that has yet to be implemented, visit the Issues & Help section of `docs/source/internals.rst` for instructions on how to file a ticket. |
There was a problem hiding this comment.
The above needs verbal workshopping but directing folks, but it's a good idea to still direct folks to where to make requests, especially if they are already looking at the limitations.
|
Do we have RTD configured to build PRs for previewing and if not, can we configure RTD to build PRs for previewing? |
I'm not aware of such functionality. To build this locally: Add thist to your Then |
Thanks! I enabled "build PRs" in RTD so next push should do it. 🤞 |
Add intro, reference, and topic sections
timgraham
force-pushed
the
intersphinx-django-https
branch
from
ae26783 to
1986472
Compare
Add intro, reference, and topic sections
The Diátaxis framework is how Django's documentation is structured, so anyone coming from Django will see the parallels.