Replace the path with XDG_ prefix with helm env variables in docs #790
Conversation
Signed-off-by: Yuchen Cheng <rudeigerc@gmail.com>
@marckhouzam Can you review this PR? Thanks. |
|
I feel uncomfortable adding UNIX-specific commands into the documentation in this way. Why not just change it to $HELM_CACHE_HOME and explain once how a user can get that information. |
| @@ -308,5 +308,5 @@ latest chart information. | |||
|
|
|||
| *Under the hood, the `helm repo add` and `helm repo update` commands are | |||
| fetching the index.yaml file and storing them in the | |||
| `$XDG_CACHE_HOME/helm/repository/cache/` directory. This is where the `helm | |||
| `$(helm env HELM_CACHE_HOME)/repository` directory. This is where the `helm | |||
There was a problem hiding this comment.
Helm is used in non-POSIX systems like Windows. Commands that generally target that Linux like environments are something we try to avoid. In #780 I changed the variable name to the Helm one. This isn't the best solution those environment variables may be empty and using the defaults.
Can we get a solution that works for both Windows and Linux/Mac? It could possible tell people who to get the value for the environment variables and then show where something is.
Signed-off-by: Yuchen Cheng rudeigerc@gmail.com
Fixes #336
According to helm/helm#8638, I replace the path with
XDG_prefix withhelm envvariables in the docs.I discovered that the cached index files were installed in
$(helm env HELM_CACHE_HOME)/repositoryinstead of$XDG_CACHE_HOME/helm/repository/cache/mentioned in the original docs, so I'm not quite sure which path is correct.