hovel / pybbm

Django forum solution. Tested, documented, shipped with example project.
BSD 2-Clause "Simplified" License
225 stars 151 forks source link

Update documentation for latest version of Django #260

Open wyzewyz opened 7 years ago

wyzewyz commented 7 years ago

I'm starting a brand new site with the latest Django and I've come across some shortcomings with the documentation.

DylannCordel commented 7 years ago

Hi @wyzewyz

Thanks for this feedback.

You right about django.contrib.sites : there is not any part of the doc which mention it. IMHO, it should be added (at least) in the section "Enable applications and edit settings".

As pybb is no longer compatible with django < 1.8, we can now upgrade the documentation to remove references to deprecated Django settings like TEMPLATE_*.

About markdown, it's documented in section "markup"

Do you want to help us to update the documentation ? If you don't know how to do this, it's quite simple:

  1. "fork" this project inside your github namespace
  2. create a branch (called doc-update for exemple)
  3. enchance the doc, and commit / push it into your github branch
  4. at this step, you'll get a button "compare and pull request" displayed on the "code" page of the project inside your namespace.

You also can find a "guide" on github to help people to contribute to a project

In any case, thanks for took time for this issue.