hack/doc: Autogen CLI Documentation #2099
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
openshift-ci-robot
added
the
do-not-merge/work-in-progress
openshift-ci-robot
added
the
size/XXL
jmccormick2001
previously approved these changes
Oct 30, 2019
estroz
reviewed
Oct 30, 2019
asmacdo
reviewed
Oct 30, 2019
Makefile
Outdated
| @@ -56,6 +56,9 @@ tidy: ## Update dependencies | |||
| clean: ## Clean up the build artifacts | |||
| $(Q)rm -rf build | |||
|
|
|||
| doc: ## Generate CLI Documentation | |||
There was a problem hiding this comment.
[Optional] Could this be cli-doc?
estroz
previously approved these changes
Nov 6, 2019
Co-Authored-By: Eric Stroczynski <estroczy@redhat.com>
Co-Authored-By: Eric Stroczynski <estroczy@redhat.com>
Co-Authored-By: Eric Stroczynski <estroczy@redhat.com>
… into autogen-cli-docs
theishshah
changed the title
openshift-ci-robot
removed
the
do-not-merge/work-in-progress
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.
Description of the change:
Adds
make doccommand to generate CLI documentationMotivation for the change:
Reduce developer friction when making changes to the CLI
Includes sample generated documentation