Skip to content

docs: add values.yaml descriptions to README.md#281

Merged
yonahd merged 4 commits intoyonahd:mainfrom
kvanzuijlen:add-values-description-to-readme
May 22, 2024
Merged

docs: add values.yaml descriptions to README.md#281
yonahd merged 4 commits intoyonahd:mainfrom
kvanzuijlen:add-values-description-to-readme

Conversation

@kvanzuijlen
Copy link
Copy Markdown
Contributor

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
Copy link
Copy Markdown

codecov-commenter commented May 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #281   +/-   ##
=======================================
  Coverage   40.84%   40.84%           
=======================================
  Files          58       58           
  Lines        2904     2904           
=======================================
  Hits         1186     1186           
  Misses       1530     1530           
  Partials      188      188           

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

Copy link
Copy Markdown
Owner

@yonahd yonahd left a comment

Choose a reason for hiding this comment

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

Small suggestion.
Also please regenerate the readme so it has the 0.1.6

@kvanzuijlen
Copy link
Copy Markdown
Contributor Author

Good catch! Thanks!

Comment thread charts/kor/Chart.yaml Outdated
Co-authored-by: Yonah Dissen <47282577+yonahd@users.noreply.github.com>
@yonahd
Copy link
Copy Markdown
Owner

yonahd commented May 22, 2024

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

@kvanzuijlen
Copy link
Copy Markdown
Contributor Author

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!

Copy link
Copy Markdown
Owner

@yonahd yonahd left a comment

Choose a reason for hiding this comment

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

Lgtm
Thank you!

@yonahd yonahd merged commit 7f35c0a into yonahd:main May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants