Skip to content

Commit 1e6f4bd

Browse files
mbolivar-nordicnashif
authored andcommitted
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 <[email protected]>
1 parent 8b147cd commit 1e6f4bd

File tree

3 files changed

+52
-0
lines changed

3 files changed

+52
-0
lines changed

doc/getting_started/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ Getting Started Guide
66
Follow this guide to set up a :ref:`Zephyr <introducing_zephyr>` development
77
environment on your system, and then build and run a sample application.
88

9+
.. tip::
10+
11+
Need help with something? See :ref:`help`.
12+
913
.. _host_setup:
1014

1115
Set Up a Development System

doc/guides/getting-help.rst

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
.. NOTE TO DOCS AUTHORS: keep this as short as humanly possible, or nobody will
2+
read it.
3+
4+
.. _help:
5+
6+
Asking for Help
7+
###############
8+
9+
You can ask for help on a mailing list or on Slack. Please send bug reports and
10+
feature requests to GitHub.
11+
12+
* **Mailing Lists**: [email protected] is usually the right list to
13+
ask for help. `Search archives and sign up here`_.
14+
* **Slack**: Zephyr's workspace is https://zephyrproject.slack.com; you can
15+
register with this `Slack invite`_.
16+
* **GitHub**: Use `GitHub issues`_ for bugs and feature requests.
17+
18+
How to Ask
19+
**********
20+
21+
.. important::
22+
23+
Please search this documentation and the mailing list archives first. Your
24+
question may have an answer there.
25+
26+
Don't just say "this isn't working" or ask "is this working?". Include as much
27+
detail as you can about:
28+
29+
#. What you want to do
30+
#. What you tried (commands you typed, etc.)
31+
#. What happened (output of each command, etc.)
32+
33+
Use Copy/Paste
34+
**************
35+
36+
Please **copy/paste text** instead of taking a picture or a screenshot of it.
37+
Text includes source code, terminal commands, and their output.
38+
39+
Doing this makes it easier for people to help you, and also helps other users
40+
search the archives.
41+
42+
When copy/pasting more than 5 lines of text into Slack, create a `snippet`_.
43+
44+
.. _Search archives and sign up here: https://lists.zephyrproject.org/g/users
45+
.. _Slack invite: https://tinyurl.com/yarkuemx
46+
.. _GitHub issues: https://github.com/zephyrproject-rtos/zephyr/issues
47+
.. _snippet: https://get.slack.help/hc/en-us/articles/204145658-Create-a-snippet

doc/guides/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ User and Developer Guides
66
.. toctree::
77
:maxdepth: 1
88

9+
getting-help.rst
910
bluetooth/index.rst
1011
c_library
1112
../README.rst

0 commit comments

Comments
 (0)