zapier / django-knowledge

Add a help desk or knowledge base to your Django project with only a few lines of boilerplate code.

This project is no longer maintained. If you are interested in taking over the project, email [email protected].

Welcome to django-knowledge!

django-knowledge makes it easy to add an integrated support desk, help desk or knowledge base to your Django project with only a few lines of boilerplate code. While we give you a generic design for free, you should just as easily be able to customize the look and feel of the app if you like.

django-knowledge was developed internally for Zapier (see it live here on our support page). Or, check out a plain, live demo.

At a glance:

• Turn common questions or support requests into a knowledge base.
• Control who sees what with simple per object view permissions: public (everyone), private (poster & staff), or internal (only staff).
• Assign questions and answers to categories for easy sorting.
• Staff get moderation controls or they can use the familiar Django admin to handle support requests.
• Allow anonymous questions, or require a standard Django user account (the default).
• Included base templates and design with prebundled HTML and CSS.
• Optionally alert users of new responses via email (or your own alert system).
• BSD license.

Links:

• View a live demo. This is the included stock design.
• Check out the documentation at ReadTheDocs.
• Visit our GitHub repo and join the development!

Screen Shots:

django-knowledge's Issues

Fix form class goofiness.

Switch forms to real classes, not pseudo-functions.

The camel case is misleading at the very least.

Homepage widgets for categories.

Add multi-language support

Any ideas on how I could add multi language support (e.g. for each language a different set of questions/answers)?

Problems migrating in django 1.5: DatabaseError: relation "auth_user" does not exist

I just installed 0.2.0 via pip and when I executed the migration I got the following error message:

Running migrations for knowledge:

• Migrating forwards to 0003_auto__add_unique_category_slug.

  knowledge:0001_initial
  FATAL ERROR - The following SQL query failed: ALTER TABLE "knowledge_question" ADD CONSTRAINT "user_id_refs_id_29c32f273c91c4b" FOREIGN KEY ("user_id") REFERENCES "auth_user" ("id") DEFERRABLE INITIALLY DEFERRED;
  The error was: relation "auth_user" does not exist

Error in migration: knowledge:0001_initial
DatabaseError: relation "auth_user" does not exist

There was something funky going on there, and unfortunately I didn't have much time to dig too deep into it so I simply deleted the migrations folder and did a ./manage.py schemamigration knowledge --initial and ./manage.py migrate knowledge but I thought I should share the info.

Why the software history was not kept?

Hi there,

I'm a researcher studying software evolution. As part of my current research, I'm studying the implications of open-sourcing a proprietary software, for instance, if the project succeed in attracting newcomers. However, I observed that some projects, like django-knowledge, deleted the software history during the transition to open-source.

Knowing that software history is indispensable for developers (e.g., developers need to refer to history several times a day), I would like to ask django-knowledge developers the following four brief questions:

1. Why did you decide to not keep the software history?
2. Do the core developers faced any kind of problems, when trying to refer to the old history? If so, how did they solve these problems?
3. Do the newcomers faced any kind of problems, when trying to refer to the old history? If so, how did they solve these problems?
4. How does the lack of history impacted on software evolution? Does it placed any burden in understanding and evolving the software?

Thanks in advance for your collaboration,

Gustavo Pinto, PhD
http://www.gustavopinto.org

Slug can get a little too long.

Would be nice to limit this at some arbitrary character number.

django 1.6.* support?

/knowledge url is working fine, but then when clicking a question, below is returned

" NoReverseMatch at /knowledge/ask/
Reverse for 'knowledge_thread' with arguments '(3, u'')' and keyword arguments '{}' not found. 1 pattern(s) tried: ['knowledge/questions/(?P<question_id>\d+)/(?P[a-z0-9-_]+)/$']"

And in the error message it refers to " knowledge/templates/django_knowledge/sidebar.html, error at line 11" which is "" and official djangoproject.com says "exception NoReverseMatch
The NoReverseMatch exception is raised by django.core.urlresolvers when a matching URL in your URLconf cannot be identified based on the parameters supplied"

What do I have to look into ? Is it django1.6 compatibility issue ? BTW, I am using django1.6.1

Assignable "tickets".

Admin raw_id on user/question.

Loading a large list into a <select> is bad form.

live demo - Application Error

Show answered status in list.

Might be weird because table joins and mysql slow junk.

Instead of 404 on lack-of-privledge, redirect to login

Instead of showing a django 404 response, redirect to some specified login url.

Docs refer to non-existant KNOWLEDGE_BASE_TEMPLATE setting

We've been customizing the style of django-knowledge and were looking forward to using the KNOWLEDGE_BASE_TEMPLATE setting to avoid having to drop a custom build of all of django-knowledge into our source base. However, the KNOWLEDGE_BASE_TEMPLATE setting seems to be absent from the source.
Is this a setting that is in development, and the docs are too new? Or is this a depreciated setting and the docs need to be scrubbed? Thanks.

A few goofy things in Firefox. How's IE look?

Sort categories by name.

url regex matching

the setting KNOWLEDGE_SLUG_URLS = True causes that the url pattern:
r'^questions/(?P<category_slug>[a-z0-9-_]+)/$' caches the the requests to view a question and maps to knowledge_list view

instead of
r'^questions/(?P<question_id>\d+)/$' who matches to knowledge_thread_no_slug view

Django 1.6 breaks markup template tag library

Django 1.6 removes markup from the django.core feature set.

More information:

django.contrib.markup will be removed following an accelerated deprecation.

The solution is one of two things:

1. (Not recommended, but useful as a patch) Use django-markup-deprecated. This allows you to keep the {% load markup %} template tag.
2. (Recommended) Use django-markupfield where relevant in your models.

In my (currently unmerged) fork and commit of this project I added support for Textile. I am also going to fix this problem using the second approach above and commit to my fork.

Model methods which alter data should have alters_data = True attribute

For example KnowledgeBase.public()

Then they can't be accidentally called in a template.

Show logged in user avatar above reply box.

We often get confused on this one.

Add Question/Response posted signal with request object.

Captcha for anon posts.

User defined types or tagging.

Follow up with email option.

Don't show 404 -> show login

Need to respect the login url from django settings.py

Mod tool for category selection.

Fall back to username if no first name/last name.

Inherit responses on public questions don't show up for anonymous users

When a user isn't logged in they can't see the inherited responses to public questions.

XSS Vulnerability. Upgrade to 0.0.6 immediately.

All versions 0.0.5 and lower are vulnerable. Please update to 0.0.6 immediately.

The cause was the failure to remove html in the stock markdown implementation in Django.

knowledge_moderate view should only accept POST requests

Alert staff of new question.

Current implementation only alerts users.

In notification ("alerts") include a preview of the message

Every email notification I get, I wish it would tell me what the message is in the email.

Translations and i18n.

Simple JSON response.

If 'application/json' header, return JSON instead.

Figure out how to do a can_view() manager method on prefetch_related()?

How do I put questions in categories?

Am I missing something? I can do it from the admin, but I can't find any way of doing it from the frontend, as admin or not. Is this intentional?

Markdown vs. Textile

Is there any reason why this module uses Markdown exclusively? Our operation uses Textile, and it seems like you just have the markdown template tag in the templates, not in the models. I may just fork this repo and add support for Textile.

get_query_set incompatible with Django 1.8

The get_query_set method has been renamed to get_queryset in Django 1.6 https://docs.djangoproject.com/en/1.8/releases/1.6/#get-query-set-and-similar-methods-renamed-to-get-queryset and is removed in Django 1.8 https://docs.djangoproject.com/en/1.8/releases/1.8/#features-removed-in-1-8

Traceback:
File "/home/user/my-env/local/lib/python2.7/site-packages/django/core/handlers/base.py" in get_response
  132.                     response = wrapped_callback(request, *callback_args, **callback_kwargs)
File "/home/user/my-env/local/lib/python2.7/site-packages/knowledge/views.py" in knowledge_index
  45.     questions = Question.objects.can_view(request.user)\
File "/home/user/my-env/local/lib/python2.7/site-packages/knowledge/managers.py" in can_view
  10.         qs = super(QuestionManager, self).get_query_set()\

Exception Type: AttributeError at /knowledge/
Exception Value: 'super' object has no attribute 'get_query_set'

Add older versions to pip registry.

Our system is still using django v1.3.1 so we need the older version of django-knowledge v0.0.6. Would it be possible to add the older versions of django-knowledge to the pip registry?

Thanks and have an epic day!

Slug should be unique.

Class based views mayhaps.

Status field with public or private option on question.

Class based views mayhaps.

Rate, vote or give points.