Skip to content

Commit a9f317a

Browse files
committed
Update support page for new theme
1 parent cadf2ce commit a9f317a

File tree

1 file changed

+83
-71
lines changed

1 file changed

+83
-71
lines changed

support.md

Lines changed: 83 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ redirect_from: /issues/index.html
77
{:toc}
88

99
<center>
10-
<strong>Have a problem or question?</strong>
11-
<br /><br />
12-
<strong>We are here to help - but you have to help us help you.</strong>
10+
<h3>Have a problem or question?
11+
<br/>
12+
<small>We are here to help - but you have to help us help you.</small>
13+
</h3>
1314
</center>
1415

1516
GitHub Issues
@@ -19,74 +20,85 @@ We keep track of problems, suggestions and questions about ev3dev using [GitHub
1920
Issues]. This lets us keep everything in one place. (So, please don't email the
2021
developers directly unless you have a personal question.)
2122

22-
* First, before submitting an issue, please make sure that you have the latest
23-
kernel and other packages:
24-
25-
# as root...
26-
apt-get update
27-
apt-get upgrade
28-
apt-get dist-upgrade
29-
# if a new kernel package was installed
30-
reboot
23+
First, before submitting an issue, please make sure that you have the latest
24+
kernel and other packages:
25+
26+
# as root...
27+
apt-get update
28+
apt-get upgrade
29+
apt-get dist-upgrade
30+
# if a new kernel package was installed
31+
reboot
32+
33+
Then search the existing issues (open and closed) to make sure someone else has
34+
not already reported the same problem or asked the same question. Please only
35+
comment on an existing issue if you are fairly sure your problem/question is
36+
*exactly* the same. When in doubt, open a new issue instead.
37+
38+
<form class="input-group" onSubmit="window.open('https://github.com/ev3dev/ev3dev/issues?q=is%3Aissue+'
39+
+ document.getElementById('search-issues').value.replace(' ', '+')); return false;">
40+
<span class="input-group-addon glyphicon glyphicon-search" style="top: 0"></span>
41+
<input id="search-issues" class="form-control" type="search" placeholder="Example: hitechnic ir receiver" />
42+
<span class="input-group-btn">
43+
<input type="submit" value="Search Issues" class="btn btn-primary">
44+
</span>
45+
</form>
46+
47+
<small>
48+
__Note:__ The [ev3dev-lang]{:target="_blank"} repository has its own
49+
[issues][ev3dev-lang-issues]{:target="_blank"} tracker.
50+
</small>
51+
52+
If you don't find anything helpful by searching, then create a [new issue]{:target="_blank"}
53+
(only __one__ problem, question or suggestion per issue please).
54+
55+
<div class="panel panel-info">
56+
<div class="panel-heading">
57+
<h2 class="panel-title">Tips for Posting Issues</h2>
58+
</div>
59+
<div class="panel-body" markdown="1">
60+
<strong>Most importantly for problems, we need to know the *exact* steps need to reproduce the
61+
issue. If you are writing a program, post the code. If you are following
62+
a tutorial, which step failed? Be as detailed as possible.</strong>
63+
64+
In the description of your issue, be sure to also include:
65+
66+
* The image file that you used to flash your SD card (e.g. `ev3dev-jessie-2015-02-24.img`).
67+
* Your kernel version (output of `uname -rv`)
68+
* If you are using a library (ev3dev-lang, python-ev3, ev3dev-c, etc.) please
69+
state which library. Most, if not all, of these have their own issues tracker.
70+
You may have better luck posting there instead.
71+
* If the issue is with detection of a sensor or motor: unplug and plug in the
72+
device and include the output of `dmsg | tail`.
73+
* If the issue is with an USB device like a WiFi dongle: include the output of `lsusb`.
74+
* If the issue is with the Brick Manager (brickman): include the output of
75+
`systemctl status brickman.service -l`.
76+
* If a screenshot of the EV3 would be helpful, run `fbgrab <some-name>.png`
77+
on the EV3 and include the picture in your comments.
78+
<p />
79+
80+
We also expect you to clean up after yourself. Please close the issue when
81+
you feel that it is resolved.
82+
83+
Some additional things to take into consideration:
84+
85+
* If you are posting logs that are more than 5-10 lines long, please use
86+
<http://pastebin.com> or <https://gist.github.com> or something similar
87+
instead of posting long logs in comments.
88+
89+
* If you are copying and pasting information from a terminal, use "code fences"
90+
to make the text more readable.
91+
92+
```
93+
A code fence is three backtick (`) characters before and after the text.
94+
95+
Just like you see here.
96+
```
97+
98+
Learn more about [writing on GitHub]{:target="_blank"}.
3199

32-
* Then search the existing issues (open and closed) to make sure someone else has
33-
not already reported the same problem or asked the same question. Please only
34-
comment on an existing issue if you are fairly sure your problem/question is
35-
*exactly* the same. When in doubt, open a new issue instead.
36-
37-
<p>
38-
<form id="search-issue-form" onSubmit="window.open('https://github.com/ev3dev/ev3dev/issues?q=is%3Aissue+'
39-
+ document.getElementById('search-issues').value.replace(' ', '+')); return false;">
40-
<input id="search-issues" type="search" placeholder="Example: hitechnic ir receiver" />
41-
<input type="submit" value="Search Issues" />
42-
</form>
43-
</p>
44-
45-
__Note:__ The [ev3dev-lang]{:target="_blank"} repository has its own
46-
[issues][ev3dev-lang-issues]{:target="_blank"} tracker.
47-
48-
* If you don't find anything helpful by searching, then create a [new issue]{:target="_blank"}
49-
(only __one__ problem, question or suggestion per issue please).
50-
51-
__Most importantly for problems, we need to know the *exact* steps need to reproduce the
52-
issue. If you are writing a program, post the code. If you are following
53-
a tutorial, which step failed? Be as detailed as possible.__
54-
55-
In the description of your issue, be sure to also include:
56-
57-
* The image file that you used to flash your SD card (e.g. `ev3dev-jessie-2015-02-24.img`).
58-
* Your kernel version (output of `uname -rv`)
59-
* If you are using a library (ev3dev-lang, python-ev3, ev3dev-c, etc.) please
60-
state which library. Most, if not all, of these have their own issues tracker.
61-
You may have better luck posting there instead.
62-
* If the issue is with detection of a sensor or motor: unplug and plug in the
63-
device and include the output of `dmsg | tail`.
64-
* If the issue is with an USB device like a WiFi dongle: include the output of `lsusb`.
65-
* If the issue is with the Brick Manager (brickman): include the output of
66-
`systemctl status brickman.service -l`.
67-
* If a screenshot of the EV3 would be helpful, run `fbgrab <some-name>.png`
68-
on the EV3 and include the picture in your comments.
69-
<p />
70-
71-
We also expect you to clean up after yourself. Please close the issue when
72-
you feel that it is resolved.
73-
74-
Some additional things to take into consideration:
75-
76-
* If you are posting logs that are more than 5-10 lines long, please use
77-
<http://pastebin.com> or <https://gist.github.com> or something similar
78-
instead of posting long logs in comments.
79-
80-
* If you are copying and pasting information from a terminal, use "code fences"
81-
to make the text more readable.
82-
83-
```
84-
A code fence is three backtick (`) characters before and after the text.
85-
86-
Just like you see here.
87-
```
88-
89-
* Learn more about [writing on GitHub]{:target="_blank"}.
100+
</div>
101+
</div>
90102

91103
IRC
92104
---
@@ -107,7 +119,7 @@ Also, #ev3dev is logged by `ev3devlogbot`. You can find the logs at <http://ev3d
107119
If you don't already have an IRC client program, you can connect right in your
108120
browser. Just enter a nickname and click start below.
109121

110-
<iframe src="https://kiwiirc.com/client/irc.freenode.net/?&theme=cli#ev3dev" class="button" style="width:100%; height:450px;" />
122+
<iframe src="https://kiwiirc.com/client/irc.freenode.net/?&theme=cli#ev3dev" class="button" style="width:100%; height:450px; border: none;" />
111123
112124
[GitHub Issues]: https://help.github.com/articles/about-issues/
113125
[ev3dev-lang]: https://github.com/ev3dev/ev3dev-lang

0 commit comments

Comments
 (0)