Rework troubleshooting section, add basic explainer #2517
Merged
Conversation
This file contains hidden or 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
This is an attempt to make the troubleshooting doc a bit better structured. It's a bit lacking in concrete details for some of the common problems (because I forget exactly how they mainfest), but I hope that we can beef this up as things come up. I also added a short explainer doc which explains some of the key concepts.
|
(reminder that there's a link to a preview of the rendered docs in the PR statuses) |
jneira
approved these changes
Dec 20, 2021
fendor
reviewed
Dec 20, 2021
jneira
reviewed
Dec 20, 2021
pepeiborra
reviewed
Dec 20, 2021
pepeiborra
reviewed
Dec 20, 2021
|
[skip circleci] |
|
Solves #491. |
11 tasks
Anrock
reviewed
Dec 21, 2021
Anrock
reviewed
Dec 21, 2021
Co-authored-by: Pepe Iborra <pepeiborra@me.com>
|
More to do, but I think this is an improvement and we can add more stuff over time. |
|
Thank you @michaelpj for these updates, especially troubleshooting guidance for the community. It would be easier after this. |
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.
This is an attempt to make the troubleshooting doc a bit better
structured. It's a bit lacking in concrete details for some of the
common problems (because I forget exactly how they mainfest), but I hope
that we can beef this up as things come up.
I also added a short explainer doc which explains some of the key
concepts.