doc: move 'getting help' to contrib guidelines

Move this standalone page into the contribution guidelines. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
zephyrproject-rtos · Apr 20, 2021 · 05ccdd7 · 05ccdd7
1 parent 541b261
commit 05ccdd7
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 48 deletions.
diff --git a/doc/contribute/index.rst b/doc/contribute/index.rst
@@ -12,6 +12,53 @@ This document explains how to participate in project conversations, log bugs
 and enhancement requests, and submit patches to the project so your patch will
 be accepted quickly in the codebase.
 
+
+.. _help:
+
+Asking for Help
+***************
+
+You can ask for help on a mailing list or on Slack. Please send bug reports and
+feature requests to GitHub.
+
+* **Mailing Lists**: users@lists.zephyrproject.org is usually the right list to
+  ask for help. `Search archives and sign up here`_.
+* **Slack**: Zephyr's workspace is https://zephyrproject.slack.com; you can
+  register with this `Slack invite`_.
+* **GitHub**: Use `GitHub issues`_ for bugs and feature requests.
+
+How to Ask
+===========
+
+.. important::
+
+   Please search this documentation and the mailing list archives first. Your
+   question may have an answer there.
+
+Don't just say "this isn't working" or ask "is this working?". Include as much
+detail as you can about:
+
+#. What you want to do
+#. What you tried (commands you typed, etc.)
+#. What happened (output of each command, etc.)
+
+Use Copy/Paste
+==============
+
+Please **copy/paste text** instead of taking a picture or a screenshot of it.
+Text includes source code, terminal commands, and their output.
+
+Doing this makes it easier for people to help you, and also helps other users
+search the archives.
+
+When copy/pasting more than 5 lines of text into Slack, create a `snippet`_.
+
+.. _Search archives and sign up here: https://lists.zephyrproject.org/g/users
+.. _Slack invite: https://tinyurl.com/y5glwylp
+.. _GitHub issues: https://github.com/zephyrproject-rtos/zephyr/issues
+.. _snippet: https://get.slack.help/hc/en-us/articles/204145658-Create-a-snippet
+
+
 Licensing
 *********
 

diff --git a/doc/guides/getting-help.rst b/doc/guides/getting-help.rst
diff --git a/doc/guides/index.rst b/doc/guides/index.rst
@@ -6,7 +6,6 @@ User and Developer Guides
 .. toctree::
    :maxdepth: 1
 
-   getting-help.rst
    beyond-GSG.rst
    arch/index.rst
    bluetooth/index.rst