Enhanced Troubleshooting Guides #1884
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rth2_troubleshooting # Conflicts: # source/docs/software/troubleshooting/index.rst
sciencewhiz
reviewed
Aug 28, 2022
|
|
||
| In the case of most FRC robot troubleshooting, the hypothesis will be relatively small. A valid hypothesis could simply be "If I add a `* -1` to line 354 of my code, it should fix the motor that's running backward". The experiment would then be to make the change, upload the code, and attempt to reproduce the backward motor issue. If the motor is now running the correct direction, it is reasonable to assume the hypothesis was correct, and no further action is needed. However, if the issue persists, one could assume the hypothesis was not entirely correct, and the process must be repeated with a new hypothesis. | ||
|
|
||
| Change One Variable at a Time |
There was a problem hiding this comment.
It may also be useful here to say that if a troubleshooting step did not change the observed symptom, it should be undone.
| @@ -0,0 +1,83 @@ | |||
| Introduction to Troubleshooting | |||
There was a problem hiding this comment.
It's probably worth mentioning keeping a written record of the steps that were taken (why they were taken), and what the observations were.
| - Perhaps the rio <-> radio connection came unplugged | ||
| - Perhaps the ethernet cord is bad (can be identified by looking at the light indicators on the Rio/Radio for network activity) | ||
| - Is the firewall disabled? | ||
| - It is recommended that the firewall is always disabled when at an events |
There was a problem hiding this comment.
add reference to DS diagnostics tab and which of these can be seen through it
|
For the problem/solution portions, the "problem" should be written in the first person from the perspective of a student so that it is easier to google. On example, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Attempting to bite off the following issues:
#1796
#1794
#1793
#1797
#1795
New
Troubleshootingsection to be added, with some general debug advice, pages for high-level "classes" of issues to be addressed.General advice should include both good "mindsets" to have for effective troubleshooting, as well as an introduction to the tools and sources of information to use to gather info about the problem
Each class of issues should have a list of "common symptoms" associated with them, and common root causes to check.