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

Link helm reference docs on helm installation page #3366

Closed
arkodg opened this issue May 10, 2024 · 5 comments · Fixed by #3370
Closed

Link helm reference docs on helm installation page #3366

arkodg opened this issue May 10, 2024 · 5 comments · Fixed by #3370
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Milestone

Comments

@arkodg
Copy link
Contributor

arkodg commented May 10, 2024

Description:

Describe the issue.

The Helm installation page https://gateway.envoyproxy.io/latest/install/install-helm/ should have a link to the helm reference docs
https://github.com/envoyproxy/gateway/blob/main/charts/gateway-helm/README.md

[optional Relevant Links:]

Any extra documentation required to understand the issue.

@arkodg arkodg added triage documentation Improvements or additions to documentation help wanted Extra attention is needed and removed triage labels May 10, 2024
@arkodg arkodg added this to the v1.1.0 milestone May 10, 2024
@yuluo-yx
Copy link
Contributor

/assign @yuluo-yx

@shahar-h
Copy link
Contributor

@arkodg there is already a link to helm chart values:
image
https://gateway.envoyproxy.io/v1.0.1/install/install-helm/#using-valuesyaml-file-for-complex-installation

However, I noticed that values section in chart README.md is not updated.
The reason is only site/content/en/latest/install/api.md is updated when running make helm-readme-gen:

helm-readme-gen: $(tools/helm-docs)
@$(LOG_TARGET)
@ImageRepository=docker.io/envoyproxy/gateway ImageTag=latest ImagePullPolicy=IfNotPresent envsubst < charts/gateway-helm/values.tmpl.yaml > ./charts/gateway-helm/values.yaml # use production ENV to generate helm api doc
$(tools/helm-docs) charts/gateway-helm/ -f values.yaml -o api.md
mv charts/gateway-helm/api.md site/content/en/latest/install/api.md

@arkodg
Copy link
Contributor Author

arkodg commented May 14, 2024

thanks for finding this @shahar-h, looks like the presentation is not ideal, @yuluo-yx can we move the line right after https://gateway.envoyproxy.io/v1.0.1/install/install-helm/#helm-chart-customizations ?

@yuluo-yx
Copy link
Contributor

thanks for finding this @shahar-h, looks like the presentation is not ideal, @yuluo-yx can we move the line right after https://gateway.envoyproxy.io/v1.0.1/install/install-helm/#helm-chart-customizations ?

got it, I will move.

@yuluo-yx
Copy link
Contributor

done. pls review @arkodg

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants