Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Try adding header to generated CLI docs #2944

Merged
merged 1 commit into from
Jul 15, 2017

Conversation

justinsb
Copy link
Member

@justinsb justinsb commented Jul 15, 2017

This should stop me changing the wrong place!

Fixes: #2834

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 15, 2017
@justinsb justinsb force-pushed the mark_autogen_docs branch from d797eb1 to 1b04aa9 Compare July 15, 2017 16:18
Copy link
Contributor

@chrislovecnm chrislovecnm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A comment about adding where. Let me know what you think.

@@ -21,6 +21,11 @@ import (
"github.com/spf13/cobra/doc"
)

const fileHeader = `
<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
Copy link
Contributor

@chrislovecnm chrislovecnm Jul 15, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

go CLI command code

Should we say where the code is? cmd/pkg/?

There are a lot of first timers that are making these changes. Make it simple for them.

@chrislovecnm
Copy link
Contributor

I added the issue #2834 that this will close.

@justinsb justinsb force-pushed the mark_autogen_docs branch 2 times, most recently from d4739c1 to a325bc7 Compare July 15, 2017 16:56
@justinsb
Copy link
Member Author

Done!

@justinsb justinsb force-pushed the mark_autogen_docs branch from a325bc7 to 17b3fa3 Compare July 15, 2017 17:14
@chrislovecnm
Copy link
Contributor

/assign
/lgtm

you can self merge if you beat me to it

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 15, 2017
@justinsb justinsb merged commit a1cba7a into kubernetes:master Jul 15, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants