search

helm / helm-www

The Helm website for docs, blog and project info.
https://helm.sh
MIT License
204 stars 514 forks source link

Poor documentation for `helm repo index --merge` #1343

Open dannysauer opened 2 years ago

dannysauer commented 2 years ago

The current behavior seems correct but could be documented better. Originally posted by @zdw in https://github.com/helm/helm/issues/4482#issuecomment-451682976

The behavior is written down in https://github.com/helm/helm/issues/4482#issuecomment-449513835, but that explanation would be a bit more useful if it was in the command's documentation instead of a closed ticket. I've been sitting here for a while trying to figure out why my new index is created adjacent to the new chart instead of in the index file I specified as an argument to --merge as the document implies. :D

Suggestion: Switch "merge the generated index into the given index" to "merge the given index into the generated index", and replace the second sentence in the synopsis at https://helm.sh/docs/helm/helm_repo_index/ with a description of what actually happens. :)

hickeyma commented 2 years ago

@dannysauer Push a PR with the changes if you feel like it.