Reinstate the helm command docs#401
Conversation
172421c to
8283cc3
Compare
|
Minor note: Looks like those docs were auto-generated with cobra: https://github.com/spf13/cobra/blob/master/doc/md_docs.md which even has an example for kubectl. Update: helm has a hidden command |
|
Originally, we removed this section from the documentation as it was a massive blocker for users wishing to contribute documentation to Helm. In order to re-build the CLI reference, you required the ability to build the helm CLI from source, which for many users is a major blocker for contributing to the docs... There very few users who are comfortable with Go, and even fewer comfortable with Go and Hugo. How do we reconcile those concerns? The only way I can imagine we address that is by setting up a netlify script that pulls the latest version of Helm down and re-generates the CLI reference every build. Perhaps that's an option here? |
That would be a good option, I think, though there would need to be some minor massaging before it'd be good to go, namely: the header information (title and description) need to be grabbed from the first three lines of the generated docs, and the SEE ALSO links at the bottom need to be redirected to |
|
|
|
html output would be good, though I didn't see that as an option when I ran The links would still need to be adjusted. |
|
I stand corrected. Either way, we were able to work around it in Helm 2's documentation; I'm sure we can take a similar approach here as well. |
|
@flynnduism where does this stand? I see one final task in the checkboxes. |
|
@mattfarina this PR reinstates that section to the site, updates menus etc. However the uncertain part is extracting the latest In v2, |
|
Actually I can do this with the info @bacongobbler provided - running |
1f1f53c to
f1fca54
Compare
|
Ok the latest help text content has been imported and indexed. This is ready for review: |
|
I noted that two of the CLI commands from v2 are not documented here. Assuming these are depreciated? |
|
they weren't ported over I think. I believe they're open issues for Helm 3 to bring back |
|
We can add them to the CLI reference once they've been reintroduced |
|
Hey @flynnduism! Is this PR ready for another review? Let me know and I can take another look. Thanks! |
|
@bacongobbler yep this is good to review. I was unsure about the missing content - we can follow up separately with the docs for |
f1fca54 to
140be6e
Compare
|
@bacongobbler thanks, I've updated the readme |
Signed-off-by: flynnduism <[email protected]>
Signed-off-by: flynnduism <[email protected]>
Signed-off-by: flynnduism <[email protected]>
Signed-off-by: flynnduism <[email protected]>
Signed-off-by: flynnduism <[email protected]>
23868bc to
f0539e1
Compare
|
The links from the |
Signed-off-by: flynnduism <[email protected]>
cfb56ac to
f515641
Compare
|
Good catch @StephenBrown2. I added a fix to correct those |
|
LGTM, should there also be a step in the README to fix them on update? |
Yep, this PR updates the Readme to do so here. |
|
Yes, that's what I linked[1], but there isn't a step to fix the SEE ALSO links. |
D'oh, I'm sorry. That makes total sense @StephenBrown2. I will amend with a follow up PR. |

Needs help before review
Issue #383 flagged some content that we're missing since we moved rom v2 to v3 docs. Changes in where the docs are stored and how they're built has impacted on their inclusion, but IMO we should display them here if at all possible.
I've made a start on that here, but with content that is out of date. This PR contains contains content from v2. Before this PR is mergeable I need to run
make docs(or whatever the new process is) to extract the latest markdown content from helm/helm.Checklist:
helm _____commands