API docs updates #3520
API docs updates #3520
Conversation
k8s-ci-robot
added
cncf-cla: yes
|
@pwittrock is there an easy way to host these docs files? Any instructions? Also, who knows how we are generating docs for kubectl now? |
|
/approve |
k8s-github-robot
added
the
approved
|
Marked as blocks next, as we need to release updated api docs with every release. |
|
@chrislovecnm PR needs rebase |
k8s-github-robot
added
the
needs-rebase
|
@chrislovecnm uploaded the missing hack script - sorry. #3567 |
|
LGTM but there's a conflict on .gitignore (because of the bazel ignores - sorry!), and let's call the hack script once we merge #3567 :-) |
Makefile
Outdated
| # Follow procedure in docs/apireference/README.md | ||
| hack/make-gendocs.sh | ||
| # hack/make-gendocs.sh |
There was a problem hiding this comment.
We do want this. Sorry I left it off before.
| @@ -13,8 +13,11 @@ go get -u github.com/kubernetes-incubator/apiserver-builder/cmd/... | |||
| # Install the reference docs commands (apiserver-builder commands invoke these) | |||
| go get -u github.com/kubernetes-incubator/reference-docs/gen-apidocs/... | |||
There was a problem hiding this comment.
We should also mention here that we expect make gen-api-docs to work, presuming we think it now works!
There was a problem hiding this comment.
Another PR? We need to figure out the install instructions. I installed this differently than you did ...
I had to install lister-gen. @pwittrock any ideas?
go install k8s.io/code-generator/cmd/lister-gen
chrislovecnm
force-pushed
the
api-docs-updates
branch
from
58a55b1
to
7299b9f
Compare
k8s-github-robot
removed
the
needs-rebase
chrislovecnm
force-pushed
the
api-docs-updates
branch
from
7299b9f
to
b483582
Compare
chrislovecnm
added
the
do-not-merge/work-in-progress
|
@justinsb before we merge, should we make this as part of the release process?? |
chrislovecnm
force-pushed
the
api-docs-updates
branch
from
b483582
to
51a64e8
Compare
chrislovecnm
force-pushed
the
api-docs-updates
branch
from
51a64e8
to
b3a93bb
Compare
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
|
/assign @andrewsykim @andrewsykim / @justinsb PTAL New docs. @pwittrock is going to be out of the office for awhile. When he gets back we can check on the question we have about |
|
@chrislovecnm putting this into the release doc is a great idea, as I think that's the right time to publish these. I don't necessarily want to be regenerating these on every PR, depending on how stable the output is... Looking at the PR itself now! |
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: chrislovecnm, justinsb The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these OWNERS Files:
You can indicate your approval by writing |
|
/test all [submit-queue is verifying that this PR is safe to merge] |
|
Automatic merge from submit-queue. |
@justinsb any idea what happened to the hack script?
hack/make-gendocs.shdid not work last time I tried to do this, but I updated the instructions in thedocs/apireference/README.mdfor how to get it to work now.