Add script to sync generated docs from helm#master

[zackbrown]

Signed-off-by: Zachary Brown z@charybrown.com

• Adds yarn update-docs command
• Adds a git submodule pointing to github.com:helm/helm.git for the purpose of pulling the latest docs
• Uses rsync to delete extraneous files, resolving an issue which has led to staleness e.g. as documented here helm init is not recognized helm#6996 (comment)

To take it for a spin, pull down this branch and run yarn update-docs

Admittedly an opinionated approach: assumes presence of bash and rsync, willingness to use git submodules, and rsync — but perhaps suitable for maintainers. Feel free to use, modify, or discard.

[bacongobbler]

Hi @zackbrown.

As @flynnduism and I discovered earlier today, there are a few more steps than a helm docs. Some URLs have to be fixed, some configuration flags have to strip out personal information (like --registry-config defaulting to /home/bacongobbler/...), and YAML front-matter has to be added back.

Can you please test this PR against the docs and see what needs to be adjusted for this script to work?

Thanks for working on this!

[bacongobbler]

FYI as a general practice, we don't use git submodules. We've had way too much trouble with them in the past. It's usually easier to git clone the project temporarily then clean up afterwards.

[zackbrown]

Sounds like someone better-steeped in the domain would be better off handling this, then. I went ahead and closed out this PR.

@bacongobbler would it be helpful to your team for me to file the underlying issues in an Issue?

They were:

• The manual .md-file-copying process is prone to missing deletions, leading to stale docs
• The manual .md-file-copying process would benefit from scripting

[bacongobbler]

Feel free to open an issue! It would be incredibly helpful to track that work. Thanks!

[zackbrown]

Kk, filed #487 — thanks for your swift collab & communication 😄

[flynnduism]

Automating this would be wonderful. @zackbrown thank you getting the ball rolling here!