-
Notifications
You must be signed in to change notification settings - Fork 904
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
docs: generate kubectl plugin docs #422
docs: generate kubectl plugin docs #422
Conversation
add new `make plugin-docs` command that generates kubectl plugin docs to `docs/generated`. a new navigation item is added under the 'Kubectl Plugin' section that points to generated docs. closes argoproj#327
Codecov Report
@@ Coverage Diff @@
## master #422 +/- ##
=======================================
Coverage 84.28% 84.28%
=======================================
Files 70 70
Lines 6667 6667
=======================================
Hits 5619 5619
Misses 761 761
Partials 287 287 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! This is awesome!
Unless you have any other changes, I'll merge it in! |
@dthomson25 I wasn't sure exactly how the docs were built and published. That process now requires an additional step of "make plugin-docs", if that's something I can update let me know. |
The docs are published by running |
The docs site depend on generated plugin docs. The new `make release-docs` target will generate the plugin docs before running `mkdocs gh-deploy`.
I added a new make target to |
@cronik I noticed that the CI failed with
Are you able to run |
Great CI is now passing! I'll merge it in unless you have any other changes you want! |
no more changes, merge away. |
add new
make plugin-docs
command that generates kubectl plugin docs todocs/generated
. a new navigation item is added under the 'Kubectl Plugin'section that points to generated docs.
closes #327