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

Clarifies documentation on connectAddr (helm chart) #12827

Merged
merged 2 commits into from
Jul 15, 2024
Merged

Clarifies documentation on connectAddr (helm chart) #12827

merged 2 commits into from
Jul 15, 2024

Conversation

djryanj
Copy link
Contributor

@djryanj djryanj commented Jul 10, 2024

The networkValidator.connectAddr helm chart parameter is ambiguously documented which leads to confusion.

This PR amends the documentation to improve comprehension.

Fixes #12797

The networkValidator.connectAddr helm chart parameter
is ambiguously documented which leads to confusion.

This PR amends the documentation to improve comprehension.

Fixes #12797

Signed-off-by: Ryan Jacobs <ryan@ryanjjacobs.com>
@djryanj djryanj requested a review from a team as a code owner July 10, 2024 22:26
@mateiidavid
Copy link
Member

Thanks @djryanj this looks good to me. Can you please run bin/helm-docs from the root of the repository? We might need to generate a doc update.

If it's a no-op, let me know.

With the previous commit, documentation changes were needed to README.md.

This commit and subsequent PR has those changes.

Fixes #12797

Signed-off-by: Ryan Jacobs <ryan@ryanjjacobs.com>
@djryanj
Copy link
Contributor Author

djryanj commented Jul 12, 2024

@mateiidavid - ran bin/helm-docs. Pushed up those changes :)

@mateiidavid
Copy link
Member

Awesome, thank you so much @djryanj! Changes look great to me.

@mateiidavid mateiidavid merged commit aa2a923 into linkerd:main Jul 15, 2024
37 checks passed
@wmorgan
Copy link
Member

wmorgan commented Jul 15, 2024

Thank you @djryanj !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants