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.

Sign up for GitHub

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

Jump to bottom

Small Update to troubleshooting document #3346

Merged
merged 32 commits into from
Jul 4, 2023
Merged

Small Update to troubleshooting document #3346

merged 32 commits into from
Jul 4, 2023

Conversation

jasonwilliams14
Copy link
Contributor

Proposed changes

This is a small update to our troubleshooting guide adding additional information. This will be an ongoing process as we continue to upgrade and provide additional documentation for NGINX Ingress Controller.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

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

@jasonwilliams14 jasonwilliams14 added the documentation Pull requests/issues for documentation label Dec 8, 2022
@jasonwilliams14 jasonwilliams14 requested a review from a team as a code owner December 8, 2022 17:44
@codecov-commenter
Copy link

codecov-commenter commented Dec 8, 2022 •
edited by codecov bot
Loading

Codecov Report

Merging #3346 (0ca8516) into main (b19ceba) will decrease coverage by 0.02%.
The diff coverage is n/a.

❗ Current head 0ca8516 differs from pull request most recent head 55d7b9d. Consider uploading reports for the commit 55d7b9d to get more accurate results

@@            Coverage Diff             @@
##             main    #3346      +/-   ##
==========================================
- Coverage   51.84%   51.83%   -0.02%     
==========================================
  Files          59       59              
  Lines       16710    16705       -5     
==========================================
- Hits         8664     8659       -5     
  Misses       7747     7747              
  Partials      299      299

see 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

lucacome
lucacome reviewed Dec 10, 2022
View reviewed changes
Copy link
Member

@lucacome lucacome left a comment

Choose a reason for hiding this comment

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

We want to remove the other sections about checking the config, etc?

docs/content/troubleshooting/troubleshoot-ingress-controller.md Outdated Show resolved Hide resolved
docs/content/troubleshooting/troubleshoot-ingress-controller.md Outdated Show resolved Hide resolved
docs/content/troubleshooting/troubleshoot-ingress-controller.md Outdated Show resolved Hide resolved
docs/content/troubleshooting/troubleshoot-ingress-controller.md Outdated Show resolved Hide resolved
docs/content/troubleshooting/troubleshoot-ingress-controller.md Outdated Show resolved Hide resolved
docs/content/troubleshooting/troubleshoot-ingress-controller.md Outdated Show resolved Hide resolved
jasonwilliams14 and others added 2 commits February 2, 2023 12:40
@jasonwilliams14 @lucacome
Update docs/content/troubleshooting/troubleshoot-ingress-controller.md
e6e8650 
Co-authored-by: Luca Comellini <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>
@jasonwilliams14 @ADubhlaoich
Update docs/content/troubleshooting/troubleshoot-configmap-policy.md
b02b41b 
Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>
@jasonwilliams14 @ADubhlaoich
Update docs/content/troubleshooting/troubleshoot-ingress.md
a674e81 
Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>
@github-actions
Copy link

github-actions bot commented May 8, 2023

This PR is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 10 days.

@github-actions github-actions bot added the stale Pull requests/issues with no activity label May 8, 2023
@jasonwilliams14 jasonwilliams14 removed the stale Pull requests/issues with no activity label May 8, 2023
@brianehlert brianehlert added this to the v3.2.0 milestone Jun 20, 2023
jjngx
jjngx approved these changes Jun 21, 2023
View reviewed changes
Copy link
Contributor

@jjngx jjngx left a comment

Choose a reason for hiding this comment

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

👍🏻 LGTM, but since new updates arrived to the original PR, it may be a good idea to ask @ADubhlaoich to re-check this PR.

@github-actions
Copy link

github-actions bot commented Jun 21, 2023 •
edited
Loading

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Manifest Files

lucacome
lucacome reviewed Jun 21, 2023
View reviewed changes
docs/content/troubleshooting/troubleshoot-transportserver.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

I think something was supposed to go in this file 🙂

ADubhlaoich
ADubhlaoich requested changes Jun 23, 2023
View reviewed changes
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.

I'm currently working on a commit to add a lot of missing frontmatter from the newest pages, as well as rename the files - we can explicitly hard-code what the URL slugs for a page will look like, but it's better to have clean paths in the first place.

There's also a lot of product naming issues I am addressing at the same time.

ADubhlaoich and others added 2 commits June 26, 2023 11:45
@ADubhlaoich
Restructure, rename and rewrite various troubleshooting documents
241b5e1 
This commit adds the changes I have made thus far to the troubleshooting
section of NGINX Ingress Controller's documentation: there is more to be
done yet, but I am pushing these changes for others to see.

The product naming is inconsistent, as is the layout of the pages -
often, appropriate markdown is not used where it would make sense to,
and formatting is otherwise missing.

I will continue to update the documentation to fix these instances.
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
8be78b8 
for more information, see https://pre-commit.ci
@ADubhlaoich ADubhlaoich marked this pull request as draft June 26, 2023 12:13
ADubhlaoich
ADubhlaoich approved these changes Jun 26, 2023
View reviewed changes
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.

I've made the majority of changes I thought were necessary, but there's still additional work needed yet, as well as a review from Jason - shifting to approved, but keeping the PR as a draft.

@lucacome lucacome marked this pull request as ready for review June 27, 2023 11:44
@tomasohaodha tomasohaodha merged commit 27e574b into main Jul 4, 2023
@tomasohaodha tomasohaodha deleted the doc/troubleshooting-update branch July 4, 2023 14:18
ADubhlaoich added a commit that referenced this pull request Jul 4, 2023
@jasonwilliams14 @pre-commit-ci
@lucacome @ADubhlaoich
Small Update to troubleshooting document (#3346)
9d5cc74 
* Updatng troubleshooting document

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Updating troubleshooting section guides

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Apply suggestions from code review

Co-authored-by: Luca Comellini <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>

* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md

Co-authored-by: Luca Comellini <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>

* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md

Co-authored-by: Luca Comellini <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>

* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md

Co-authored-by: Luca Comellini <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>

* Update docs/content/troubleshooting/troubleshoot-configmap-policy.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>

* Update docs/content/troubleshooting/troubleshoot-configmap-policy.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>

* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>

* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>

* Update docs/content/troubleshooting/troubleshoot-virtualserver-virtualserverroute.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>

* Update docs/content/troubleshooting/troubleshoot-configmap-policy.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>

* Update docs/content/troubleshooting/troubleshoot-virtualserver-virtualserverroute.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>

* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>

* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>

* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>

* Update docs/content/troubleshooting/troubleshoot-ingress.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Jason Williams - NGIИX <[email protected]>

* Apply suggestions from code review

Signed-off-by: Alan Dooley <[email protected]>

* Restructure, rename and rewrite various troubleshooting documents

This commit adds the changes I have made thus far to the troubleshooting
section of NGINX Ingress Controller's documentation: there is more to be
done yet, but I am pushing these changes for others to see.

The product naming is inconsistent, as is the layout of the pages -
often, appropriate markdown is not used where it would make sense to,
and formatting is otherwise missing.

I will continue to update the documentation to fix these instances.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Change instances of names, improve grammar and phrasing.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Remove test content from draft TransportServer document

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Signed-off-by: Jason Williams - NGIИX <[email protected]>
Signed-off-by: Alan Dooley <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Luca Comellini <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
tomasohaodha pushed a commit that referenced this pull request Jul 5, 2023
@ADubhlaoich @jasonwilliams14
@pre-commit-ci @lucacome
Cherry-pick troubleshooting documentation from main branch (#4078)
b9bb0cc 
Small Update to troubleshooting document (#3346)

* Updatng troubleshooting document

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Updating troubleshooting section guides

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Apply suggestions from code review




* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md




* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md




* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md




* Update docs/content/troubleshooting/troubleshoot-configmap-policy.md




* Update docs/content/troubleshooting/troubleshoot-configmap-policy.md




* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md




* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md




* Update docs/content/troubleshooting/troubleshoot-virtualserver-virtualserverroute.md




* Update docs/content/troubleshooting/troubleshoot-configmap-policy.md




* Update docs/content/troubleshooting/troubleshoot-virtualserver-virtualserverroute.md




* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md




* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md




* Update docs/content/troubleshooting/troubleshoot-ingress-controller.md




* Update docs/content/troubleshooting/troubleshoot-ingress.md




* Apply suggestions from code review



* Restructure, rename and rewrite various troubleshooting documents

This commit adds the changes I have made thus far to the troubleshooting
section of NGINX Ingress Controller's documentation: there is more to be
done yet, but I am pushing these changes for others to see.

The product naming is inconsistent, as is the layout of the pages -
often, appropriate markdown is not used where it would make sense to,
and formatting is otherwise missing.

I will continue to update the documentation to fix these instances.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Change instances of names, improve grammar and phrasing.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Remove test content from draft TransportServer document

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Signed-off-by: Jason Williams - NGIИX <[email protected]>
Signed-off-by: Alan Dooley <[email protected]>
Co-authored-by: Jason Williams - NGIИX <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Luca Comellini <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucacome lucacome lucacome left review comments

@jjngx jjngx jjngx approved these changes

@ADubhlaoich ADubhlaoich ADubhlaoich approved these changes

@ciarams87 ciarams87 Awaiting requested review from ciarams87 ciarams87 was automatically assigned from nginxinc/kic

Assignees

@jasonwilliams14 jasonwilliams14

Labels
documentation Pull requests/issues for documentation
Projects
None yet
Milestone
v3.2.0
Development

Successfully merging this pull request may close these issues.
7 participants
@jasonwilliams14 @codecov-commenter @lucacome @ADubhlaoich @jjngx @brianehlert @tomasohaodha