Skip to content

docs(django):Improve Django Docs, make explicit mode the recommended.#1123

Merged
rochacbruno merged 2 commits intomasterfrom
648
Jul 16, 2024
Merged

docs(django):Improve Django Docs, make explicit mode the recommended.#1123
rochacbruno merged 2 commits intomasterfrom
648

Conversation

@rochacbruno
Copy link
Copy Markdown
Member

@rochacbruno rochacbruno commented Jul 4, 2024

Closes #648

The issue #648 is currently impossible to fix, it is a trede-off of patching the django settings, as our plan for 4.0 is to deprecate Django patching in favour of a more explicit way to attach dynaconf to Django, I condider that issue closed and improved the django docs.

Closes #578
Added Pylint issue to known caveats

@pedro-psb
Copy link
Copy Markdown
Member

I've added some changes. Not much content stuff, mostly organization/looking. Mainly:

  • Re-organized headers so we have a better grouped ToC
  • Fixed bullets not showing correctly
  • Added tabbed-content to settings sources examples

Other misc:

  • updated django_examples link
  • renamed some titles
  • typos

Screenshots

We don't have netlify live preview anymore, so I'll append some screenshots.

New Toc

  • Created "Integration Modes" to contain Explicit and Extension
  • Moved "Settings Sources" below "Integration Modes" and added "Using envvars" and "Using settings files" to it.
  • Added correct nesting to "Testing on Django" subsections
before after
image image

Tabbed content

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants