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

Extend troubleshooting doc #2072

Merged
merged 4 commits into from
Jun 4, 2024
Merged

Extend troubleshooting doc #2072

merged 4 commits into from
Jun 4, 2024

Conversation

sjberman
Copy link
Contributor

Problem: As a user, I want to know how to collect info to diagnose and get support when failures occur.

Solution: Extend the troubleshooting doc to contain info about collecting status, events, and logs.

Closes #1929

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.

NONE

Problem: As a user, I want to know how to collect info to diagnose and get support when failures occur.

Solution: Extend the troubleshooting doc to contain info about collecting status, events, and logs.
@sjberman sjberman requested review from a team as code owners May 31, 2024 16:38
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 31, 2024
@sjberman sjberman requested a review from ADubhlaoich May 31, 2024 16:38
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

@bjee19
Copy link
Contributor

bjee19 commented May 31, 2024

👍

Copy link
Contributor

@pleshakov pleshakov left a comment

Choose a reason for hiding this comment

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

👍

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, added a handful of my usual nitpicks.

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
sjberman and others added 2 commits June 4, 2024 08:22
@sjberman sjberman enabled auto-merge (squash) June 4, 2024 14:22
@sjberman sjberman merged commit f8810cb into nginxinc:main Jun 4, 2024
39 of 40 checks passed
@sjberman sjberman deleted the docs/logs branch June 4, 2024 14:50
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
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Extend the Troubleshooting document with how and what logs should be collected
5 participants