Skip to content

Conversation

@ibakshay
Copy link
Contributor

@ibakshay ibakshay commented Mar 7, 2025

Signed-off-by: IB Akshay akshay.iyyadurai.balasundaram@sap.com

Submit a pull request

Thank you for submitting a pull request!
To speed up the review process, please ensure that everything below
is true:

  1. This is not a duplicate of an existing Plugin.
  2. No existing features have been broken without good reason.
  3. The Documentation has been updated to reflect your changes.
  4. Tests have been added or updated to reflect your changes.
  5. All tests pass.

Replace any ":question:" below with information about your pull request.

Pull Request Details

Provide details about your pull request and what it adds, fixes, or changes.

Breaking Changes

Describe what features are broken by this pull request and why, if any.

Issues Fixed

Enter the issue numbers resolved by this pull request below, if any.

Other Relevant Information

Provide any other important details below.

Signed-off-by: IB Akshay <akshay.iyyadurai.balasundaram@sap.com>
… 0.5.1 + cleanup

Signed-off-by: IB Akshay <akshay.iyyadurai.balasundaram@sap.com>
@ibakshay ibakshay requested a review from a team as a code owner March 7, 2025 06:37
@github-actions
Copy link
Contributor

github-actions bot commented Mar 7, 2025

✅ All README.md files are up to date! Great job keeping documentation up to date! 🎉📖

ibakshay added 3 commits March 7, 2025 07:43
Signed-off-by: IB Akshay <akshay.iyyadurai.balasundaram@sap.com>
Signed-off-by: IB Akshay <akshay.iyyadurai.balasundaram@sap.com>
…s and greenhouse.defaultDashboards

Signed-off-by: IB Akshay <akshay.iyyadurai.balasundaram@sap.com>
@ibakshay ibakshay requested a review from richardtief March 7, 2025 09:57
Copy link
Member

@richardtief richardtief left a comment

Choose a reason for hiding this comment

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

I like the quality of the Readme now. Just the object rendering as json can be messy. 😄

For e.g. perses.config

Thanks!

Signed-off-by: IB Akshay <akshay.iyyadurai.balasundaram@sap.com>
@ibakshay
Copy link
Contributor Author

ibakshay commented Mar 7, 2025

I like the quality of the Readme now. Just the object rendering as json can be messy. 😄

For e.g. perses.config

Thanks!

Yes, for sure. This can be messy. We don't have to add big objects such as perses.config. The helm-docs tool renders the properties only when the comment for the property starts with # -- foo foo foo. It is explained in their documentation - https://github.com/norwoodj/helm-docs/tree/master?tab=readme-ov-file#valuesyaml-metadata.

@ibakshay ibakshay merged commit 585fe43 into main Mar 10, 2025
7 checks passed
@ibakshay ibakshay deleted the ibakshay/add-helm-docs branch March 10, 2025 15:55
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.

2 participants