Create a separate page about getting help

This commit is contained in:
Adrián Chaves 2019-03-15 10:56:26 +01:00
parent a97a9b57bf
commit 3170eec7f3
2 changed files with 79 additions and 19 deletions

View File

@ -12,25 +12,7 @@ testing.
.. _web crawling: https://en.wikipedia.org/wiki/Web_crawler
.. _web scraping: https://en.wikipedia.org/wiki/Web_scraping
Getting help
============
Having trouble? We'd like to help!
* Try the :doc:`FAQ <faq>` -- it's got answers to some common questions.
* Looking for specific information? Try the :ref:`genindex` or :ref:`modindex`.
* Ask or search questions in `StackOverflow using the scrapy tag`_.
* Ask or search questions in the `Scrapy subreddit`_.
* Search for questions on the archives of the `scrapy-users mailing list`_.
* Ask a question in the `#scrapy IRC channel`_,
* Report bugs with Scrapy in our `issue tracker`_.
.. _scrapy-users mailing list: https://groups.google.com/forum/#!forum/scrapy-users
.. _Scrapy subreddit: https://www.reddit.com/r/scrapy/
.. _StackOverflow using the scrapy tag: https://stackoverflow.com/tags/scrapy
.. _#scrapy IRC channel: irc://irc.freenode.net/scrapy
.. _issue tracker: https://github.com/scrapy/scrapy/issues
.. _section-first-steps:
First steps
===========
@ -39,11 +21,15 @@ First steps
:caption: First steps
:hidden:
intro/getting-help
intro/overview
intro/install
intro/tutorial
intro/examples
:doc:`intro/getting-help`
Find support beyond the Scrapy documentation.
:doc:`intro/overview`
Understand what Scrapy is and how it can help you.
@ -144,6 +130,7 @@ Built-in services
:doc:`topics/webservice`
Monitor and control a crawler using a web service.
.. _section-solving-problems:
Solving specific problems
=========================

View File

@ -0,0 +1,73 @@
============
Getting help
============
Having trouble? We'd like to help!
Cover your bases
================
If you are experiencing issues while using Scrapy, or cannot install Scrapy at
all, make sure you have followed the installation steps described in the
:ref:`intro-install`, including :ref:`platform-specific steps
<intro-install-platform-notes>`. Also remember to check out its
:ref:`troubleshooting section <intro-install-troubleshooting>`.
If you have a question about Scrapy, try to get familiar with Scrapy first.
:ref:`section-first-steps` pages will help you get started quickly.
:ref:`section-basics` pages will solve most basic questions about Scrapy.
If you have questions beyond the basics, or you are experiencing issues while
using Scrapy, start by reading the :ref:`faq` page, which covers common
questions and issues.
If you are not sure how to solve a specific problem with Scrapy,
:ref:`section-solving-problems` pages cover solutions for common problems.
You can also search the documentation, or check the
:ref:`genindex` or the :ref:`modindex`.
Are you first?
==============
Whatever your question or issue, there is a chance someone else has been in
your shoes before. Search for similar topics in StackOverflow_, reddit_, the
old `mailing list`_ or the `issue tracker`_.
Ask away
========
If you cannot find an answer or a solution for your problem, you can try to get
help from the Scrapy community:
* If you think you have found a bug in Scrapy, please submit a bug report on
our `issue tracker`_.
* If you want to start a discussion related to Scrapy, and you are not
looking for a specific answer, use reddit_.
* If you think your problem may happen to someone else in the future, prepare
a `good question`_ and ask on StackOverflow_.
* Otherwise, you may ask for help on the Scrapy web chat, the `#scrapy`_ IRC
channel at Freenode. Be ready to wait for a bit, though; most people cannot
watch the chat 24/7.
.. _good question: https://stackoverflow.com/help/how-to-ask
Give back
=========
You may have questions about Scrapy, or problems that you cannot solve, but
you also have answers and solutions that you can share with others. While you
wait for a response, please see if you can `help someone else`_.
.. _help someone else: https://stackoverflow.com/unanswered/tagged/scrapy?tab=newest
.. _#scrapy: http://webchat.freenode.net?randomnick=1&channels=%23scrapy
.. _issue tracker: https://github.com/scrapy/scrapy/issues
.. _mailing list: https://groups.google.com/forum/#!forum/scrapy-users
.. _reddit: https://www.reddit.com/r/scrapy/
.. _StackOverflow: https://stackoverflow.com/tags/scrapy