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

Docs: Update support referencing support package tool #2789

Merged
merged 11 commits into from
Nov 22, 2024
Merged

Docs: Update support referencing support package tool #2789

merged 11 commits into from
Nov 22, 2024

Conversation

mrajagopal
Copy link
Contributor

@mrajagopal mrajagopal commented Nov 21, 2024 •
edited
Loading

Proposed changes

Troubleshooting in Kubernetes requires collecting data from various sources of the kubernetes API.
The nginx-supportpkg-for-k8s is such a tool that NGINX has created to make this data collection as easy as possible.

  • This PR updates the support page of NGF docs referencing this tool in a similar manner to what was added to NIC docs

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

@mrajagopal
Docs: Update support referencing support package tool
ccc18f1 
* This is similar to what was added to NIC docs
@mrajagopal mrajagopal requested review from a team as code owners November 21, 2024 01:34
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 21, 2024
@codecov Codecov
Copy link

codecov bot commented Nov 21, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.86%. Comparing base (975653a) to head (36080d5).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #2789   +/-   ##
=======================================
  Coverage   89.86%   89.86%           
=======================================
  Files         107      107           
  Lines       10997    10997           
  Branches       50       50           
=======================================
  Hits         9883     9883           
  Misses       1054     1054           
  Partials       60       60

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚨 Try these New Features:

ADubhlaoich
ADubhlaoich requested changes Nov 21, 2024
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.

Needs some small fixes for style: fine to approve if my suggestions are accepted.

site/content/support.md Outdated Show resolved Hide resolved
site/content/support.md Outdated Show resolved Hide resolved
@mrajagopal
Copy link
Contributor Author

Hi @ADubhlaoich , thanks for reviewing the material.
I have accepted your suggestions.
Please, let me know of any others.
Otherwise, please update branch and merge as I don't have permissions for this.

sjberman
sjberman reviewed Nov 22, 2024
View reviewed changes
Copy link
Collaborator

@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.

If we want to publish this right away, then once this is merged into main, we'll need to create a cherry-pick commit and pull request to the release-1.5 branch.

site/content/support.md Outdated Show resolved Hide resolved
@mrajagopal
Copy link
Contributor Author

If we want to publish this right away, then once this is merged into main, we'll need to create a cherry-pick commit and pull request to the release-1.5 branch.

Thanks for the suggestion @sjberman, yes please, if possible.

ADubhlaoich
ADubhlaoich approved these changes Nov 22, 2024
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.

Approved.

@sjberman I can create a cherry-pick once merged: I can also include the small link fix from #2803 .

kate-osborn
kate-osborn approved these changes Nov 22, 2024
View reviewed changes
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.

Thanks for the work on this @mrajagopal! The plugin works great. @sjberman we should start using this in our pipeline to help with debugging.

@sjberman sjberman enabled auto-merge (squash) November 22, 2024 17:45
@sjberman sjberman merged commit 1eeafe5 into nginx:main Nov 22, 2024
42 checks passed
ADubhlaoich pushed a commit to ADubhlaoich/ngf-doc-work that referenced this pull request Nov 25, 2024
@mrajagopal @ADubhlaoich
Docs: Update support referencing support package tool (nginx#2789)
507c258 
Troubleshooting in Kubernetes requires collecting data from various sources of the kubernetes API.
The nginx-supportpkg-for-k8s is such a tool that NGINX has created to make this data collection as easy as possible.

This PR updates the support page of NGF docs referencing this tool in a similar manner to what was added to NIC docs
@ADubhlaoich ADubhlaoich mentioned this pull request Nov 25, 2024
Merged
6 tasks
ADubhlaoich added a commit that referenced this pull request Nov 25, 2024
@ADubhlaoich @mrajagopal
@sjberman @nginx-aoife
Cherry pick recent documentation changes (#2815)
4ad7473 
This commit cherry-picks changes from 3 recent documentation PRs from
main to the 1.5 release branch. More specifically, the work in the following PRs:

-  Update support referencing support package tool #2789
- Docs: remove () typo from troubleshooting doc #2803
- Clear up installation language #2808

---------

Co-authored-by: Madhu Rajagopal <[email protected]>
Co-authored-by: Saylor Berman <[email protected]>
Co-authored-by: nginx-aoife <[email protected]>
salonichf5 pushed a commit to salonichf5/nginx-gateway-fabric that referenced this pull request Dec 5, 2024
@mrajagopal @salonichf5
Docs: Update support referencing support package tool (nginx#2789)
4691133 
Troubleshooting in Kubernetes requires collecting data from various sources of the kubernetes API.
The nginx-supportpkg-for-k8s is such a tool that NGINX has created to make this data collection as easy as possible.

This PR updates the support page of NGF docs referencing this tool in a similar manner to what was added to NIC docs
miledxz added a commit to miledxz/nginx-gateway-fabric that referenced this pull request Jan 14, 2025
@miledxz
Docs: Update support referencing support package tool (nginx#2789)
dcc9029 
Troubleshooting in Kubernetes requires collecting data from various sources of the kubernetes API.
The nginx-supportpkg-for-k8s is such a tool that NGINX has created to make this data collection as easy as possible.

This PR updates the support page of NGF docs referencing this tool in a similar manner to what was added to NIC docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ADubhlaoich ADubhlaoich ADubhlaoich approved these changes

@kate-osborn kate-osborn kate-osborn approved these changes

@sjberman sjberman sjberman approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
NGINX Gateway Fabric
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mrajagopal @ADubhlaoich @sjberman @kate-osborn