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

[Page feedback]: Missing cmd to add helm repo #5922

Closed
ryan-pfizer opened this issue Jan 13, 2025 · 4 comments · Fixed by #5977
Closed

[Page feedback]: Missing cmd to add helm repo #5922

ryan-pfizer opened this issue Jan 13, 2025 · 4 comments · Fixed by #5977
Labels
good first issue Good for newcomers help wanted Extra attention is needed sig:demo sig:helm

Comments

@ryan-pfizer
Copy link

URL

https://opentelemetry.io/docs/kubernetes/helm/demo/

Description

There is a helm repo add command on https://opentelemetry.io/docs/demo/kubernetes-deployment/ that is not replicated on the page for the chart iteself.

@tiffany76
Copy link
Contributor

@ryan-pfizer, thanks very much for the clear and actionable feedback.

@open-telemetry/docs-approvers, it looks like the K8s demo is documented in two places. Perhaps we should keep the content in one section and just link to it from the other?

@cartermp
Copy link
Contributor

@tiffany76 this seems like a good use case for a shortcode I think. I still think it's valuable to have the demo chart node under the k8s docs separate from the demo docs, though.

@tiffany76
Copy link
Contributor

@ryan-pfizer, would you like to submit a PR to add the helm repo add command where it's missing?

We can work on adding a shortcode later.

@chalin
Copy link
Contributor

chalin commented Jan 15, 2025

It might be better to consider refactoring the docs a bit (if necessary), and have a canonical "install" page or section that can be linked into? I agree with @tiffany76 that this issue can be used to get a fix in and we can have another to track possible rework (that may or may not involve a shortcode).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed sig:demo sig:helm
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants