Make the Troubleshooting guide more usable #12074
Merged
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
ptgott
force-pushed
the
paul.gottschling/11841-5
branch
from
57d6d8f to
ba30d53
Compare
zmb3
approved these changes
Apr 20, 2022
ulysseskan
approved these changes
Apr 27, 2022
See #11841 - Make Cloud instructions smoother by using ScopedBlocks (this component was not available during the first round of Cloud-specific edits). - Add a Prerequisites section - Use steps in H2 headers. The idea is that a user would follow each step to collect diagnostic information, then pose a question in the final "Ask for help" section. - Add more detailed examples of debug logs and a goroutine dump, and explain a bit more how you would use this information. - Remove the text about resetting teleport's state by deleting the data directory. This is a general-purpose guide to investigating issues,so it seemed more appropriate to reserve that kind of action for when a user determined what the issue was. - Add instructions for getting your Teleport version in order to ask for help. - Add a further reading section.
ptgott
force-pushed
the
paul.gottschling/11841-5
branch
from
ba30d53 to
b89371e
Compare
This was referenced May 4, 2022
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.
See #11841
Make Cloud instructions smoother by using ScopedBlocks (this
component was not available during the first round of Cloud-specific
edits).
Add a Prerequisites section
Use steps in H2 headers. The idea is that a user would follow
each step to collect diagnostic information, then pose a question
in the final "Ask for help" section.
Add more detailed examples of debug logs and a goroutine dump, and
explain a bit more how you would use this information.
Remove the text about resetting teleport's state by deleting the
data directory. This is a general-purpose guide to investigating
issues,so it seemed more appropriate to reserve that kind of action
for when a user determined what the issue was.
Add instructions for getting your Teleport version in order to
ask for help.
Add a further reading section.