Skip to content

Commit

Permalink
[3.0.x] Rewrote Get Help FAQ.
Browse files Browse the repository at this point in the history
Backport of 6ef4c8a from master
  • Loading branch information
adamchainz authored and carltongibson committed Mar 26, 2020
1 parent 3bb1e6c commit f4ee1ba
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 26 deletions.
59 changes: 40 additions & 19 deletions docs/faq/help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,34 @@ FAQ: Getting Help
How do I do X? Why doesn't Y work? Where can I go to get help?
==============================================================

If this FAQ doesn't contain an answer to your question, you might want to
try the |django-users| mailing list. Feel free to ask any question related
to installing, using, or debugging Django.
First, please check if your question is answered on the :doc:`FAQ <faq/index>`.
Also, search for answers using your favorite search engine, and in `the forum`.

If you prefer IRC, the `#django IRC channel`_ on the Freenode IRC network is an
active community of helpful individuals who may be able to solve your problem.
.. _`the forum`: https://forum.djangoproject.com/

If you can't find an answer, please take a few minutes to formulate your
question well. Explaining the problems you are facing clearly will help others
help you. See the StackOverflow guide on `asking good questions`.

.. _`asking good questions`: https://stackoverflow.com/help/how-to-ask

Then, please post it in one of the following channels:

* The Django Forum section `"Using Django"`_. This is for web-based
discussions.
* The |django-users| mailing list. This is for email-based discussions.
* The `#django IRC channel`_ on the Freenode IRC network. This is for
chat-based discussions.

.. _`"Using Django"`: https://forum.djangoproject.com/c/users
.. _`#django IRC channel`: irc://irc.freenode.net/django

In all these channels please abide by the `Django Code of Conduct`_. In
summary, being friendly and patient, considerate, respectful, and careful in
your choice of words.

.. _Django Code of Conduct: https://www.djangoproject.com/conduct/

.. _message-does-not-appear-on-django-users:

Why hasn't my message appeared on `django-users`?
Expand All @@ -30,23 +49,25 @@ that spammers get caught, but it also means that your first question to the
list might take a little longer to get answered. We apologize for any
inconvenience that this policy may cause.

Nobody on `django-users` answered my question! What should I do?
================================================================
Nobody answered my question! What should I do?
==============================================

Try making your question more specific, or provide a better example of your
problem.

As with most open-source mailing lists, the folks on |django-users| are
volunteers. If nobody has answered your question, it may be because nobody
knows the answer, it may be because nobody can understand the question, or it
may be that everybody that can help is busy. One thing you might try is to ask
the question on IRC -- visit the `#django IRC channel`_ on the Freenode IRC
network.
As with most open-source projects, the folks on these channels are volunteers.
If nobody has answered your question, it may be because nobody knows the
answer, it may be because nobody can understand the question, or it may be that
everybody that can help is busy.

You can also try asking on a different channel. But please don't post your
question in all three channels in quick succession.

You might notice we have a second mailing list, called |django-developers| --
but please don't email support questions to this mailing list. This list is
for discussion of the development of Django itself. Asking a tech support
question there is considered quite impolite.
You might notice we have a second mailing list, called |django-developers|.
This list is for discussion of the development of Django itself. Please don't
email support questions to this mailing list. Asking a tech support question
there is considered impolite, and you will likely be directed to ask on
|django-users|.

I think I've found a bug! What should I do?
===========================================
Expand All @@ -62,8 +83,8 @@ to security@djangoproject.com. This is a private list only open to long-time,
highly trusted Django developers, and its archives are not publicly readable.

Due to the sensitive nature of security issues, we ask that if you think you
have found a security problem, *please* don't send a message to one of the
public mailing lists. Django has a
have found a security problem, *please* don't post a message on the forum, IRC,
or one of the public mailing lists. Django has a
:ref:`policy for handling security issues <reporting-security-issues>`;
while a defect is outstanding, we would like to minimize any damage that
could be inflicted through public knowledge of that defect.
Expand Down
9 changes: 2 additions & 7 deletions docs/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,11 @@ Having trouble? We'd like to help!
* Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or
the :doc:`detailed table of contents <contents>`.

* Search for information in the archives of the |django-users| mailing list, or
`post a question`_.

* Ask a question in the `#django IRC channel`_.
* Not found anything? See :doc:`faq/help` for information on getting support
and asking questions to the community.

* Report bugs with Django in our `ticket tracker`_.

.. _archives: https://groups.google.com/group/django-users/
.. _post a question: https://groups.google.com/d/forum/django-users
.. _#django IRC channel: irc://irc.freenode.net/django
.. _ticket tracker: https://code.djangoproject.com/

How the documentation is organized
Expand Down

0 comments on commit f4ee1ba

Please sign in to comment.