Update Troubleshooting guide #2141
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
github-actions
bot
added
the
documentation
salonichf5
force-pushed
the
docs/troubleshooting
branch
from
328f364
to
f3b103b
Compare
salonichf5
commented
Jun 14, 2024
sjberman
reviewed
Jun 17, 2024
kate-osborn
requested changes
Jun 20, 2024
There was a problem hiding this comment.
Nice work @salonichf5!
Couple things that I think we could add.
- A table like below with common issues:
- What to do if there is no status written to resources. Check to see if the referenced resources exist and belong to NGF.
- A section on the N+ Dashboard with a link to our dashboard doc.
sarthyparty
reviewed
Jun 27, 2024
sjberman
reviewed
Jun 27, 2024
There was a problem hiding this comment.
@ADubhlaoich There have been quite a few changes so may need a re-review.
kate-osborn
requested changes
Jun 27, 2024
salonichf5
force-pushed
the
docs/troubleshooting
branch
from
f731702
to
aa36ce2
Compare
salonichf5
force-pushed
the
docs/troubleshooting
branch
from
a27b126
to
0c63a17
Compare
kate-osborn
requested changes
Jul 1, 2024
salonichf5
force-pushed
the
docs/troubleshooting
branch
from
b58ddb0
to
4d58403
Compare
kate-osborn
reviewed
Jul 1, 2024
salonichf5
force-pushed
the
docs/troubleshooting
branch
from
4d58403
to
d5a1eb0
Compare
kate-osborn
requested changes
Jul 1, 2024
kate-osborn
reviewed
Jul 1, 2024
Co-authored-by: Saylor Berman <[email protected]>
Co-authored-by: Saylor Berman <[email protected]>
Co-authored-by: Saylor Berman <[email protected]>
Co-authored-by: Saylor Berman <[email protected]>
Co-authored-by: Saylor Berman <[email protected]>
jputrino
reviewed
Jul 8, 2024
jputrino
reviewed
Jul 8, 2024
jputrino
reviewed
Jul 8, 2024
jputrino
reviewed
Jul 8, 2024
ADubhlaoich
approved these changes
Jul 9, 2024
Co-authored-by: Jodie Putrino <[email protected]>
Co-authored-by: Jodie Putrino <[email protected]>
Co-authored-by: Jodie Putrino <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Jodie Putrino <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2141 +/- ##
=======================================
Coverage 87.62% 87.62%
=======================================
Files 96 96
Lines 6715 6715
Branches 50 50
=======================================
Hits 5884 5884
Misses 774 774
Partials 57 57 ☔ View full report in Codecov by Sentry. |
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.
Proposed changes
Problem: As a user, I want more detailed guide to troubleshoot if an error occurs with NGF
Solution: Updates existing troubleshooting with detailed overview
Testing: N/A
Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.
Closes #551
Closes #2187
Checklist
Before creating a PR, run through this checklist and mark each as complete.
Release notes
If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.