Skip to content

[NET-6232] docs: Update consul-k8s Helm chart docs (1.2.x)#19698

Merged
zalimeni merged 1 commit intorelease/1.16.xfrom
zalimeni/update-k8s-docs-1.16.x
Nov 27, 2023
Merged

[NET-6232] docs: Update consul-k8s Helm chart docs (1.2.x)#19698
zalimeni merged 1 commit intorelease/1.16.xfrom
zalimeni/update-k8s-docs-1.16.x

Conversation

@zalimeni
Copy link
Member

Sync docs for recent changes to the Helm chart from consul-k8s.

Description

Updates docs for backport of hashicorp/consul-k8s#3180 following #19577.

Also includes another minor previous change that wasn't synced.

PR Checklist

  • updated test coverage
  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

@zalimeni zalimeni added type/docs Documentation needs to be created/updated/clarified pr/no-changelog PR does not need a corresponding .changelog entry pr/no-backport labels Nov 20, 2023
@zalimeni zalimeni requested review from a team and blake November 20, 2023 20:38
@zalimeni zalimeni requested a review from a team as a code owner November 20, 2023 20:38
@zalimeni zalimeni enabled auto-merge (squash) November 27, 2023 14:53
@zalimeni zalimeni requested a review from david-yu November 27, 2023 22:14
@david-yu
Copy link
Contributor

@zalimeni I didn't realize these merged right after approval so approved one of these PRs. These are docs for un-released functionality is that correct? If so, we should only merge upon release.

@david-yu
Copy link
Contributor

Also typically it is a customary for the release engineer to run the make-docs make command to help create a PR against the consul core repo based on the Helm chart comments, not sure if that is a better way to handle things.

@zalimeni zalimeni disabled auto-merge November 27, 2023 22:50
@zalimeni
Copy link
Member Author

@zalimeni I didn't realize these merged right after approval so approved one of these PRs. These are docs for un-released functionality is that correct? If so, we should only merge upon release.

@david-yu good point, that was my mistake 🤦🏻‍♂️ I hadn't considered that after #19577 was merged and misinterpreted your backport label addition there; I really should have only synced over the old content that was missing.

I'll open a PR to revert the merged change, and update this one to just address the un-synced content, then allow the normal process to take care of the new docs. (TIL we had that in place already, though I should have guessed so)

Also typically it is a customary for the release engineer to run the make-docs make command to help create a PR against the consul core repo based on the Helm chart comments, not sure if that is a better way to handle things.

Makes sense. I did use make gen-helm-docs consul=../consul from consul-k8s to sync these, but I agree it's probably best to let this remain part of the release process w.r.t. timing.

@david-yu
Copy link
Contributor

Thanks I appreciate the follow up here, sorry for leading you originally down the wrong path.

@zalimeni
Copy link
Member Author

@david-yu of course, thanks for catching and educating me!

Sync changes not yet represented in docs and relevant before the next
patch release.
@zalimeni zalimeni force-pushed the zalimeni/update-k8s-docs-1.16.x branch from e71e31c to 25a58a1 Compare November 27, 2023 23:05
@zalimeni zalimeni enabled auto-merge (squash) November 27, 2023 23:05
@zalimeni
Copy link
Member Author

Ok @david-yu , this one is ready for review.

@zalimeni zalimeni merged commit 712802f into release/1.16.x Nov 27, 2023
@zalimeni zalimeni deleted the zalimeni/update-k8s-docs-1.16.x branch November 27, 2023 23:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr/no-backport pr/no-changelog PR does not need a corresponding .changelog entry type/docs Documentation needs to be created/updated/clarified

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants