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.

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

Move helm docs into values files #2196

Closed
Tracked by #1618
mowies opened this issue Sep 28, 2023 · 6 comments · Fixed by #2281
Closed
Tracked by #1618

Move helm docs into values files #2196

mowies opened this issue Sep 28, 2023 · 6 comments · Fixed by #2281
Assignees
Labels
good first issue Good for newcomers helm
Milestone

Comments

@mowies
Copy link
Member

mowies commented Sep 28, 2023

Goal

Refactor the helm docs annotation comments that are currently in separate doc.yaml files under the several chart helm chart folders and put the comments back next to each of their corresponding values in the various values.yaml files.
Since we don't use helmify anymore, this can now finally be done.

Details

  • as described above plus
  • adjust helm check pipeline to check the docs for each of the charts
  • adjust the generate-helm-docs.sh script so that it can generate all the docs for each of the helm charts in the repo

DoD

  • docs comments next to helm values
  • doc.yml files are all deleted
  • generation script is adjusted
  • helm check pipeline is adjusted and green

Notes

⚠️ This ticket depends on

@mowies mowies added good first issue Good for newcomers status: ready-for-refinement Issue is relevant for the next backlog refinment helm labels Sep 28, 2023
@mowies mowies added this to the 0.9 milestone Sep 28, 2023
@prakrit55
Copy link
Member

Hey @mowies, I would like to work on it.

@RealAnna
Copy link
Contributor

RealAnna commented Oct 4, 2023

Hi @prakrit55 we will refine the issue today, after that it is all yours 😃

@thisthat thisthat moved this to 🎟️ Refined in Keptn Lifecycle Toolkit Oct 4, 2023
@thisthat thisthat removed the status: ready-for-refinement Issue is relevant for the next backlog refinment label Oct 4, 2023
@mowies
Copy link
Member Author

mowies commented Oct 4, 2023

the dependency issue is closed now, so you can now start working on this @prakrit55 !

@prakrit55
Copy link
Member

Hey @mowies, it couldn't generate the readme on ./.github/scripts/generate-helm-docs.sh and I have already configured the generate-helm-docs.sh script at that instant.

It gives if (prelude[i + 1]?.[0] !== '#') as an error in their composer.js, I tried to remove the . but it kept giving me other syntax error.

@mowies
Copy link
Member Author

mowies commented Oct 16, 2023

What version of Node.js are you using? I have Node 16 and for it works perfectly. Do you have a PR or a link to the changes you made to the script?

@prakrit55
Copy link
Member

What version of Node.js are you using? I have Node 16 and for it works perfectly. Do you have a PR or a link to the changes you made to the script?

yes, it made a trouble because, my wsl installed node v12 by default, will raise a pr here soon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers helm
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants