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.

Sign up for GitHub

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

Jump to bottom

Docs: Add part on updating the Helm chart #23739

Merged
merged 1 commit into from Feb 15, 2023
Merged

Docs: Add part on updating the Helm chart #23739

merged 1 commit into from Feb 15, 2023

Conversation

meyskens
Copy link
Member

This adds a part to the documentation on how to run the linting an document update for Helm chart.

Signed-off-by: Maartje Eyskens maartje.eyskens@isovalent.com

Document contributor steps to update the Helm chart

I did this on the experience I had in #23719, am i missing something that should be added?

@meyskens meyskens requested review from a team as code owners February 14, 2023 13:20
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Feb 14, 2023
@meyskens meyskens changed the title Add part on updating the Helm chart Docs: Add part on updating the Helm chart Feb 14, 2023
aditighag
aditighag approved these changes Feb 14, 2023
View reviewed changes
Copy link
Member

@aditighag aditighag left a comment

Choose a reason for hiding this comment

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

Thanks! 👍 Please add the missing release note label.

@meyskens meyskens added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. labels Feb 14, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Feb 14, 2023
qmonnet
qmonnet requested changes Feb 14, 2023
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Hi, and thanks!

It's nice to have the different steps covered, but to be honest I find that it's a lot of commands to run, when make -C install/kubernetes runs them all at once (all: update-versions check-values-yaml docs lint, update-versions: update-chart cilium/values.yaml).

I don't mind keeping the details to explain what happens, but for users who aren't interested in those, can we at least mention somewhere at the top that these are all executed as part of the default Makefile target?

Please also find some minor comments below.

Documentation/contributing/development/dev_setup.rst Show resolved Hide resolved
Documentation/contributing/development/dev_setup.rst Show resolved Hide resolved
Documentation/contributing/development/dev_setup.rst Outdated Show resolved Hide resolved
@qmonnet
Copy link
Member

qmonnet commented Feb 14, 2023

One last thing, can you please squash your two commits and force-push to your branch?

@meyskens
Add part on updating the Helm chart
7039635 
This adds a part to the documentation on how to run the linting
an document update for Helm chart.

Signed-off-by: Maartje Eyskens <maartje.eyskens@isovalent.com>
qmonnet
qmonnet approved these changes Feb 15, 2023
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks for addressing all the feedback!

The Netlify preview build failed for some (apparently unrelated) reason, I'm trying to find someone who can re-trigger it.

@qmonnet
Copy link
Member

qmonnet commented Feb 15, 2023

Bill re-triggered the build (thanks!), and the preview looks all good now, even though Netlify didn't update the job status on this page. So we're ready to go!

@qmonnet qmonnet added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Feb 15, 2023
@pchaigno pchaigno merged commit 2548277 into cilium:master Feb 15, 2023
@meyskens meyskens deleted the meykens/doc-helm-changes branch February 16, 2023 08:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aditighag aditighag aditighag approved these changes

@qmonnet qmonnet qmonnet approved these changes

Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@meyskens @qmonnet @aditighag @pchaigno