Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Troubleshooting guide #2141

Merged
merged 28 commits into from
Jul 9, 2024
Merged

Conversation

salonichf5
Copy link
Contributor

@salonichf5 salonichf5 commented Jun 14, 2024

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.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

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.

A more detailed troubleshooting guide

@salonichf5 salonichf5 requested review from a team as code owners June 14, 2024 13:45
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 14, 2024
@salonichf5 salonichf5 force-pushed the docs/troubleshooting branch from 328f364 to f3b103b Compare June 14, 2024 13:46
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
@salonichf5 salonichf5 requested a review from sjberman June 17, 2024 20:49
Copy link
Contributor

@kate-osborn kate-osborn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work @salonichf5!

Couple things that I think we could add.

  1. A table like below with common issues:
Screenshot 2024-06-20 at 3 44 34 PM
  1. What to do if there is no status written to resources. Check to see if the referenced resources exist and belong to NGF.
  2. A section on the N+ Dashboard with a link to our dashboard doc.

site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
@salonichf5 salonichf5 requested a review from kate-osborn June 26, 2024 21:15
Copy link
Contributor

@sjberman sjberman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ADubhlaoich There have been quite a few changes so may need a re-review.

site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
@salonichf5 salonichf5 force-pushed the docs/troubleshooting branch from b58ddb0 to 4d58403 Compare July 1, 2024 22:32
@salonichf5 salonichf5 requested a review from kate-osborn July 1, 2024 22:33
@salonichf5 salonichf5 force-pushed the docs/troubleshooting branch from 4d58403 to d5a1eb0 Compare July 1, 2024 22:37
@salonichf5 salonichf5 requested a review from kate-osborn July 1, 2024 22:38
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
@salonichf5 salonichf5 requested a review from kate-osborn July 1, 2024 23:04
Copy link
Contributor

@kate-osborn kate-osborn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

salonichf5 and others added 6 commits July 2, 2024 09:48
Co-authored-by: Saylor Berman <s.berman@f5.com>
Co-authored-by: Saylor Berman <s.berman@f5.com>
Co-authored-by: Saylor Berman <s.berman@f5.com>
Co-authored-by: Saylor Berman <s.berman@f5.com>
Co-authored-by: Saylor Berman <s.berman@f5.com>
@salonichf5 salonichf5 requested a review from sjberman July 2, 2024 16:56
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM: Made edit suggestions for sentence case and informal language.

site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
salonichf5 and others added 13 commits July 9, 2024 13:39
Co-authored-by: Jodie Putrino <jputrino@users.noreply.github.com>
Co-authored-by: Jodie Putrino <jputrino@users.noreply.github.com>
Co-authored-by: Jodie Putrino <jputrino@users.noreply.github.com>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Jodie Putrino <jputrino@users.noreply.github.com>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
Copy link

codecov bot commented Jul 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.62%. Comparing base (8884c70) to head (a403b7f).

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.
📢 Have feedback on the report? Share it here.

@salonichf5 salonichf5 enabled auto-merge (squash) July 9, 2024 19:46
@salonichf5 salonichf5 merged commit 4980266 into nginxinc:main Jul 9, 2024
37 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation release-notes
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Incorrect link in developer docs Troubleshooting Guide
7 participants