Skip to content

Commit

Permalink
Merge pull request #3520 from chrislovecnm/api-docs-updates
Browse files Browse the repository at this point in the history
Automatic merge from submit-queue.

API docs updates

- tweak to .gitignore
- updating api docs
- updated docs/apireference/README.md with how to generate docs

@justinsb any idea what happened to the hack script? `hack/make-gendocs.sh` did not work last time I tried to do this, but I updated the instructions in the `docs/apireference/README.md` for how to get it to work now.
  • Loading branch information
Kubernetes Submit Queue committed Oct 28, 2017
2 parents e38f2a5 + b3a93bb commit 8885c6d
Show file tree
Hide file tree
Showing 154 changed files with 2,640 additions and 2,748 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,5 @@ bazel-genfiles
bazel-kops
bazel-out
bazel-testlogs
# Ignore default apiserver config
apiserver.local.config
3 changes: 3 additions & 0 deletions docs/apireference/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/...

go get -u k8s.io/code-generator/...
# Install the code generation commands (apiserver-builder commands invoke these)
go install k8s.io/code-generator/cmd/openapi-gen
go install k8s.io/code-generator/cmd/deepcopy-gen
go install k8s.io/code-generator/cmd/informer-gen
```

## Update the `pkg/openapi/openapi_generated.go`
Expand Down
2 changes: 1 addition & 1 deletion docs/apireference/build/brodoc.js
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ function generateNestedNav(parent, nest) {

function generateNavJson(data) {
var navJson = JSON.stringify(data);
navScript = `(function(){navData = ${navJson}})();`;
navScript = `(function(){navData = ${navJson};})();`;
fs.writeFile('./navData.js', navScript, function(err) {
if (err) {
return console.log(err);
Expand Down
5 changes: 0 additions & 5 deletions docs/apireference/build/documents/_definitions.md

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading

0 comments on commit 8885c6d

Please sign in to comment.