From 3170eec7f328f48351c7007f52e1d417911aa922 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 15 Mar 2019 10:56:26 +0100 Subject: [PATCH 1/2] Create a separate page about getting help --- docs/index.rst | 25 +++---------- docs/intro/getting-help.rst | 73 +++++++++++++++++++++++++++++++++++++ 2 files changed, 79 insertions(+), 19 deletions(-) create mode 100644 docs/intro/getting-help.rst diff --git a/docs/index.rst b/docs/index.rst index 6d5f9e77d..e2072440f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 ` -- 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 ========================= diff --git a/docs/intro/getting-help.rst b/docs/intro/getting-help.rst new file mode 100644 index 000000000..b3263a42f --- /dev/null +++ b/docs/intro/getting-help.rst @@ -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 +`. Also remember to check out its +:ref:`troubleshooting section `. + +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 From 10822b3d4f4cf74b0c7c543b4848f0d0df124ea7 Mon Sep 17 00:00:00 2001 From: Adrian Chaves Date: Mon, 3 Aug 2026 13:16:40 +0200 Subject: [PATCH 2/2] Update, and restore the intro for visibility --- docs/index.rst | 20 +++++++---- docs/intro/getting-help.rst | 72 +++++++++++++------------------------ 2 files changed, 38 insertions(+), 54 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index b9aa30747..629538378 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,7 +12,16 @@ testing. .. _web crawling: https://en.wikipedia.org/wiki/Web_crawler .. _web scraping: https://en.wikipedia.org/wiki/Web_scraping -.. _section-first-steps: +Getting 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. + +.. _GitHub Discussions: https://github.com/scrapy/scrapy/discussions +.. _issue tracker: https://github.com/scrapy/scrapy/issues + First steps =========== @@ -21,14 +30,11 @@ 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. + intro/getting-help :doc:`intro/overview` Understand what Scrapy is and how it can help you. @@ -42,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 @@ -121,7 +130,6 @@ Built-in services :doc:`topics/telnetconsole` Inspect a running crawler using a built-in Python console. -.. _section-solving-problems: Solving specific problems ========================= diff --git a/docs/intro/getting-help.rst b/docs/intro/getting-help.rst index ee83406d8..a2f22ce9e 100644 --- a/docs/intro/getting-help.rst +++ b/docs/intro/getting-help.rst @@ -6,69 +6,45 @@ 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 -`. Also remember to check out its -:ref:`troubleshooting section `. +Check the documentation +======================= -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`. +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. -Are you first? -============== +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 StackOverflow_, reddit_, the -old `mailing list`_ or the `issue tracker`_. +your shoes before. Search for similar topics in `GitHub Discussions`_ and in +the `issue tracker`_. StackOverflow_ also holds years of answered Scrapy +questions. -Ask away -======== +Ask the community +================= -If you cannot find an answer or a solution for your problem, you can try to get -help from the Scrapy community: +If you cannot find an answer or a solution for your problem: -* If you think you have found a bug in Scrapy, please submit a bug report on - our `issue tracker`_. +* If you think you have found a bug in Scrapy, report it on the + `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 have a question, prepare a `good question`_ and ask it in + `GitHub Discussions`_. -* If you think your problem may happen to someone else in the future, prepare - a `good question`_ and ask on StackOverflow_. +* If you want to start a discussion, and you are not looking for a specific + answer, use reddit_. -* Otherwise, you may ask for help on the `Scrapy Discord`_ server. Be ready - to wait for a bit, though; most people cannot watch the chat 24/7. +* 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 - -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 - .. _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/ -.. _Scrapy Discord: https://discord.com/invite/mv3yErfpvq .. _StackOverflow: https://stackoverflow.com/tags/scrapy