docs: add values.yaml descriptions to README.md

kvanzuijlen commented 6 months ago

Please read CONTRIBUTING.md for additional information on contributing to this repository!

What this PR does / why we need it

This PR adds the descriptions from the values.yaml file to the README.md using Helm docs. I bumped the Chart version since I made changes to the Chart's docs. I also cleaned up the Chart.yaml file and improved the description.

PR Checklist

[ ] This PR adds K8s exceptions (false positives)
[ ] This PR adds new code
[ ] This PR includes test for any new code

Github Issue

[XX-XX]

Notes for your reviewers

codecov-commenter commented 6 months ago

Codecov Report

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

Project coverage is 40.84%. Comparing base (710239d) to head (b63d173). Report is 2 commits behind head on main.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #281 +/- ## ======================================= Coverage 40.84% 40.84% ======================================= Files 58 58 Lines 2904 2904 ======================================= Hits 1186 1186 Misses 1530 1530 Partials 188 188 ```

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

kvanzuijlen commented 6 months ago

Good catch! Thanks!

yonahd commented 6 months ago

Sorry to bother, but the Readme needs to be regenerated 😬

kvanzuijlen commented 6 months ago

Sorry to bother, but the Readme needs to be regenerated 😬

No bother, laughing out loud... Should've catched that myself. Thanks for taking the review seriously!

yonahd / kor