docs: cleanup SPIRE & Envoy values in helm reference #26039
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mhofstetter
added
area/documentation
This commit cleans up the helm reference documentation of the SPIRE related values, by removing the comments of "objects" from the documentation and replacing them by commenting the properties of the objects if not already present. Signed-off-by: Marco Hofstetter <marco.hofstetter@isovalent.com>
mhofstetter
force-pushed
the
pr/mhofstetter/helm-auth-docu-fix
branch
from
5cce86d
to
61fac2a
Compare
mhofstetter
requested review from
tommyp1ckles,
kaworu,
zacharysarah and
youngnick
The helm value properties related to the Envoy DaemonSet doesn't use the proper comment syntax which is the reason why the properties doesn't show up in the documentation. This commit fixes this by using the proper syntax starting with `# --`. Signed-off-by: Marco Hofstetter <marco.hofstetter@isovalent.com>
mhofstetter
changed the title
kaworu
approved these changes
Jun 9, 2023
youngnick
approved these changes
Jun 9, 2023
|
removed review-request for @tommyp1ckles as sig-k8s is already covered by @youngnick & @sayboras |
|
documentation changes only. marking as ready-to-merge |
mhofstetter
added
the
ready-to-merge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR cleans up the helm reference documentation of the SPIRE & Envoy related values, by removing the comments of "objects" from the documentation and replacing them with comments on the object properties if not already present.
This removes objects like the following from the docu
