Docs: Update support referencing support package tool

nginxinc / nginx-gateway-fabric

NGINX Gateway Fabric provides an implementation for the Gateway API using NGINX as the data plane.

Apache License 2.0

510 stars 97 forks source link

Docs: Update support referencing support package tool #2789

Closed mrajagopal closed 3 days ago

mrajagopal commented 5 days ago

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.

[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
[x] 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

codecov[bot] commented 5 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files

```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests
JS Bundle Analysis - Avoid shipping oversized bundles

mrajagopal commented 4 days ago

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.

mrajagopal commented 3 days ago

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.