Skip to content
Permalink
Browse files

doc: guides: add "Asking for Help" guide

I often wish I had a short and Zephyr-specific place to point people
to when they're asking for help in ways that make it hard to help
them.

Add one.

Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
  • Loading branch information...
mbolivar authored and nashif committed Apr 17, 2019
1 parent 8b147cd commit 1e6f4bd1f6f74c2511a14d228717766fcc2149b7
Showing with 52 additions and 0 deletions.
  1. +4 −0 doc/getting_started/index.rst
  2. +47 −0 doc/guides/getting-help.rst
  3. +1 −0 doc/guides/index.rst
@@ -6,6 +6,10 @@ Getting Started Guide
Follow this guide to set up a :ref:`Zephyr <introducing_zephyr>` development
environment on your system, and then build and run a sample application.

.. tip::

Need help with something? See :ref:`help`.

.. _host_setup:

Set Up a Development System
@@ -0,0 +1,47 @@
.. NOTE TO DOCS AUTHORS: keep this as short as humanly possible, or nobody will
read it.
.. _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/yarkuemx
.. _GitHub issues: https://github.com/zephyrproject-rtos/zephyr/issues
.. _snippet: https://get.slack.help/hc/en-us/articles/204145658-Create-a-snippet
@@ -6,6 +6,7 @@ User and Developer Guides
.. toctree::
:maxdepth: 1

getting-help.rst
bluetooth/index.rst
c_library
../README.rst

0 comments on commit 1e6f4bd

Please sign in to comment.
You can’t perform that action at this time.