docs: add Troubleshooting page #18181
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
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
JoshuaKGoldberg
force-pushed
the
docs-troubleshooting
branch
from
4c76315
to
1a67fc9
Compare
JoshuaKGoldberg
commented
Mar 9, 2024
JoshuaKGoldberg
force-pushed
the
docs-troubleshooting
branch
from
1a67fc9
to
19908ce
Compare
JoshuaKGoldberg
force-pushed
the
docs-troubleshooting
branch
from
19908ce
to
ee186eb
Compare
JoshuaKGoldberg
force-pushed
the
docs-troubleshooting
branch
from
ee186eb
to
468c20f
Compare
|
Hi everyone, it looks like we lost track of this pull request. Please review and see what the next steps are. This pull request will auto-close in 7 days without an update. |
Tanujkanti4441
added
documentation
nzakas
requested changes
Mar 22, 2024
There was a problem hiding this comment.
Thanks for getting this section started.
Overall, I think the pages need a bit more structure, maybe headings like:
- Symptoms - describe the problem and error message
- Cause - explain the most likely cause(s) of the problem
- Resolution - what to do to try and fix the problem
- Further Reading - for any additional resources
docs/src/use/troubleshooting/couldnt-determine-the-plugin-uniquely.md
Outdated
Show resolved
Hide resolved
|
Can you check the lint error? |
|
It was from the merge from |
nzakas
reviewed
Apr 1, 2024
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
nzakas
approved these changes
Apr 1, 2024
|
URLs are good for tomorrow's release, so merging. |
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.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Adds a
/use/troubleshootingpage with sub-pages for three commonly asked-about areas.Fixes #17986.
Is there anything you'd like reviewers to focus on?
I can't shake the feeling that these pages are much more contextual explanation than actual troubleshooting... but couldn't think of any other troubleshooting tips to add in.