Skip to content
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

Update documentation for latest version of Django #260

Open
wyzewyz opened this issue Jan 17, 2017 · 1 comment
Open

Update documentation for latest version of Django #260

wyzewyz opened this issue Jan 17, 2017 · 1 comment

Comments

@wyzewyz
Copy link

wyzewyz commented Jan 17, 2017

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

  • django.contrib.sites must be enabled in INSTALLED_APPS, and SITE_ID must be set per the django docs (TLDR: To get started, SITE_ID = 1 is sufficient)
  • TEMPLATE_CONTEXT_PROCESSORS mentioned here no longer exists.
  • If you use Markdown, you must specify PYBB_MARKUP = "markdown"
@DylannCordel
Copy link
Contributor

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.

@DylannCordel DylannCordel mentioned this issue Mar 15, 2017
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants