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

docs: generate kubectl plugin docs #422

Merged
merged 4 commits into from
Mar 4, 2020

Conversation

cronik
Copy link
Contributor

@cronik cronik commented Feb 29, 2020

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 #327

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
Copy link

codecov bot commented Feb 29, 2020

Codecov Report

Merging #422 into master will not change coverage by %.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b8d30c5...704ce9b. Read the comment docs.

Copy link
Member

@dthomson25 dthomson25 left a 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!

@dthomson25
Copy link
Member

Unless you have any other changes, I'll merge it in!

@cronik
Copy link
Contributor Author

cronik commented Mar 3, 2020

@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.

@dthomson25
Copy link
Member

The docs are published by running mkdocs gh-deploy, but it makes a git commit so only committors can run it.

The docs site depend on generated plugin docs. The new `make release-docs` target will generate the plugin docs before running `mkdocs gh-deploy`.
@cronik
Copy link
Contributor Author

cronik commented Mar 3, 2020

I added a new make target to release-docs which will generate the docs before running the gh-deploy.

@dthomson25
Copy link
Member

dthomson25 commented Mar 3, 2020

@cronik I noticed that the CI failed with

+ tee /tmp/test-results/go-test.out
Makefile:127: *** missing separator.  Stop.

Are you able to run make test locally?

@dthomson25
Copy link
Member

Great CI is now passing! I'll merge it in unless you have any other changes you want!

@cronik
Copy link
Contributor Author

cronik commented Mar 4, 2020

no more changes, merge away.

@dthomson25 dthomson25 merged commit ac9123f into argoproj:master Mar 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Auto-generate kubectl argo rollouts docs for website
2 participants