Mirrors
/
ARDEN-documentation
mirror of https://github.com/aredn/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add help for handling issues

This commit is contained in:
AB7PA 2022-06-17 18:26:05 -07:00 committed by WU2S
parent 2913254067
commit 34b89c283e
3 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
arednGettingStarted/_images/github-issues.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB

30
arednGettingStarted/handle_issues.rst Normal file
View File

@ -0,0 +1,30 @@
============================
Handling Problems and Issues
============================
If you experience issues with building or using AREDN |trade| devices, there are several sources of help. There is an active user community that regularly contributes to the AREDN |trade| `Forum <https://www.arednmesh.org/forum>`_, and you can post your experience there to receive help and feedback.
However, if you have issues that you think should be investigated by the AREDN |trade| development team, you can follow the steps below for engaging with the software developers.
Create a GitHub account
To open an issue on GitHub you first must create your own GitHub account. This is free and easy to do by following these steps:
1. Open your web browser and navigate to the `GitHub URL <https://github.com>`_.
2. Click the ``Sign Up`` button and enter the required information. We suggest using your callsign as the username.
3. On the GitHub website, click the ``Sign In`` button and authenticate to GitHub with the credentials you created.
4. Navigate on GitHub to the AREDN |trade| code repository: ``https://github.com/aredn/aredn``
Open a new issue on GitHub
.. image:: _images/github-issues.png
:alt: GitHub Issues menu item
:align: right
There are several sections in the *aredn/aredn* code repository, and you can navigate to the issues area by clicking **Issues** in the top horizontal menu.
1. To open a new issue click the **New Issue** button on the upper right side.
2. Enter a meaningful title in the *Title* field.
3. Use the edit box to describe your issue fully. You should include the exact hardware model and firmware version on which you saw the issue.
4. You can attach screenshots or support data files by dragging and dropping them into the text window.
5. Click the **Submit New Issue** button to submit the issue for review.
Once the issue is submitted you can click the title in the issues list to see the details. You can enter additional information as a new comment on the existing issue. When any future comments or questions are posted to your issue you will receive notifications of those updates. If the issue has been resolved, you can then close your issue if you desire.

1
index.rst
View File

@ -35,6 +35,7 @@ If you would like to see the documentation for a specific AREDN |trade| release,
arednGettingStarted/node_status
arednGettingStarted/mesh_status
arednGettingStarted/advanced_config
arednGettingStarted/handle_issues
.. toctree::
:maxdepth: 1