diff --git a/docs/index.rst b/docs/index.rst index de06e3488..0284724e0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,28 +12,15 @@ testing. .. _web crawling: https://en.wikipedia.org/wiki/Web_crawler .. _web scraping: https://en.wikipedia.org/wiki/Web_scraping -.. _getting-help: - Getting help ============ -Having trouble? We'd like to help! +Having trouble? Read the :doc:`FAQ `, ask a question in `GitHub +Discussions`_ or report a bug on our `issue tracker`_. See +:doc:`intro/getting-help` for more options. -* Try the :doc:`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`_. -* Join the Discord community `Scrapy Discord`_. - -.. _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 +.. _GitHub Discussions: https://github.com/scrapy/scrapy/discussions .. _issue tracker: https://github.com/scrapy/scrapy/issues -.. _Scrapy Discord: https://discord.com/invite/mv3yErfpvq First steps @@ -47,6 +34,7 @@ First steps intro/install intro/tutorial intro/examples + intro/getting-help :doc:`intro/overview` Understand what Scrapy is and how it can help you. @@ -60,6 +48,9 @@ First steps :doc:`intro/examples` Learn more by playing with a pre-made Scrapy project. +:doc:`intro/getting-help` + Find support beyond this documentation. + .. _section-basics: Basic concepts diff --git a/docs/intro/getting-help.rst b/docs/intro/getting-help.rst new file mode 100644 index 000000000..a2f22ce9e --- /dev/null +++ b/docs/intro/getting-help.rst @@ -0,0 +1,50 @@ +.. _getting-help: + +============ +Getting help +============ + +Having trouble? We'd like to help! + + +Check the documentation +======================= + +If you cannot install Scrapy, see the :ref:`troubleshooting section +` of the installation guide. For anything else, +read the :ref:`faq` and search this documentation. + + +Search for existing answers +=========================== + +Whatever your question or issue, there is a chance someone else has been in +your shoes before. Search for similar topics in `GitHub Discussions`_ and in +the `issue tracker`_. StackOverflow_ also holds years of answered Scrapy +questions. + + +Ask the community +================= + +If you cannot find an answer or a solution for your problem: + +* If you think you have found a bug in Scrapy, report it on the + `issue tracker`_. + +* If you have a question, prepare a `good question`_ and ask it in + `GitHub Discussions`_. + +* If you want to start a discussion, and you are not looking for a specific + answer, use reddit_. + +* Otherwise, ask on `Discord`_. Be ready to wait for a bit, though; most people + cannot watch the chat 24/7. + + +.. _Discord: https://discord.com/invite/mv3yErfpvq +.. _GitHub Discussions: https://github.com/scrapy/scrapy/discussions +.. _good question: https://stackoverflow.com/help/how-to-ask +.. _issue tracker: https://github.com/scrapy/scrapy/issues +.. _reddit: https://www.reddit.com/r/scrapy/ +.. _StackOverflow: https://stackoverflow.com/tags/scrapy