Cherry-pick troubleshooting documentation from main branch #4078
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
* 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]>
Dependency Review✅ No vulnerabilities or license issues found.Scanned Manifest Files |
Codecov Report
@@ Coverage Diff @@
## release-3.2 #4078 +/- ##
============================================
Coverage 51.83% 51.83%
============================================
Files 59 59
Lines 16705 16705
============================================
Hits 8659 8659
Misses 7747 7747
Partials 299 299 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
vepatel
approved these changes
Jul 4, 2023
haywoodsh
approved these changes
Jul 4, 2023
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
This commit cherry-picks the documentation changes merged into main as part of commit 27e574b.
Currently, the live website appears to have missing documentation because of drift between the main branch and the release branch. Once this has been merged, I will redeploy the documentation website to disseminate the change.
Checklist
Before creating a PR, run through this checklist and mark each as complete.