Skip to content

fix(helm): update helm command docs to v3.0.3#485

Merged
bacongobbler merged 1 commit intohelm:masterfrom
bacongobbler:update-helm-command-docs
Feb 4, 2020
Merged

fix(helm): update helm command docs to v3.0.3#485
bacongobbler merged 1 commit intohelm:masterfrom
bacongobbler:update-helm-command-docs

Conversation

@bacongobbler
Copy link
Member

@bacongobbler bacongobbler commented Feb 4, 2020

commands like helm home and helm init are no longer present in Helm 3.

Signed-off-by: Matthew Fisher matt.fisher@microsoft.com

Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
@flynnduism
Copy link
Member

Thanks @bacongobbler. LGTM, ready to merge.


Non-blocking questions:

  • I see this also restores the helm get notes command docs, which had been missing. Do you know if helm inspect readme is depreciated like init and home?
  • The docs you brought over have the See Also: urls edited, which saves a step. Is this now changed at the source?

@bacongobbler
Copy link
Member Author

bacongobbler commented Feb 4, 2020

helm show is an alias for helm inspect now, so if you run helm inspect readme, it will invoke helm show readme. Check out the last line in the output below:

><> helm help inspect

This command consists of multiple subcommands to display information about a chart

Usage:
  helm show [command]

The docs you brought over have the See Also: urls edited, which saves a step. Is this now changed at the source?

Nah. I had to manually edit these links as well as the YAML front matter. We should probably figure out a better solution going forward, but it'll do for now :)

@zackbrown
Copy link
Contributor

zackbrown commented Feb 4, 2020

Hey @bacongobbler related to our convo over at helm/helm#6996 I noticed that the "copy over generated docs" workflow doesn't seem to well address deletions

So I went together and spun up a script which makes the doc-copying a one-line yarn update-docs, and uses rsync along the way to delete files that should be deleted. More info in that PR: #486

(Edit) hope that's helpful! Feel free to do what you want with it.

@bacongobbler
Copy link
Member Author

Approved offline by @flynnduism. Merging!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants