updated kubernetes daemon man docs #10419
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These docs are not autogenerated. They are generated from specially formated markdown files that need to be updated when flags are changed but nobody knows about this so it is not enforced. Thus the man page generation is not useful. For the sake of having up to date docs up to date for v1, I am manually udating the markdown files and removing the md2man generation. After v1 we need to gen this man pages with the rest of our generated docs in a pre commit hook so that they are not able to become out of date. We can do this by converting our daemons to use cobra cmd like kubectl.
mikedanese
changed the title
|
GCE e2e build/test passed for commit ff6d67e. |
|
LGTM |
bgrant0607
added
lgtm
|
doc change |
|
so maybe no man page is better than a bad man page, but why is it so hard to gen the 'right' .md ? |
|
It was what I could do in 10 minutes with sed. I'm following this up with a PR that will gen this md and the man pages but I want to fix this ASAP. |
roberthbailey
added a commit
that referenced
this pull request
Jun 27, 2015
updated kubernetes daemon man docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These man pages are not autogenerated. They are generated from specially formatted
markdown files that need to be updated when flags are changed but nobody knows
about this so it is not enforced. Thus the man page generation is not useful.
For the sake of having up to date docs up to date for v1, I am manually updating
the markdown files and removing the md2man generation (because it doesn't work
with the format I'm updating them to). After v1 we need to gen this man pages with
the rest of our generated docs in a pre-commit hook so that they are not able to become
out of date. We can do this by converting our daemons to use cobra cmd like kubectl, or
better, using config objects (from files or etcd) instead of command line opts.