Skip to content

Commit

Permalink
remove description about updating gRPC API docs in kubeflow website
Browse files Browse the repository at this point in the history
  • Loading branch information
tenzen-y committed Nov 11, 2021
1 parent cae15c6 commit 6f231e8
Showing 1 changed file with 0 additions and 9 deletions.
9 changes: 0 additions & 9 deletions pkg/apis/manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,3 @@ generate the API docs from `api.proto`.
Run `build.sh` to update every file from `api.proto` and generate the docs:

- [v1beta1/build.sh](./v1beta1/build.sh) for v1beta1.

After running `build.sh`, follow these steps to update the docs:

1. Copy the updated content from your generated file
`pkg/apis/manager/<version>/gen-doc/api.md` to the doc page in the
`kubeflow/website` repository:
`kubeflow/website/blob/master/content/docs/reference/katib/<version>/katib.md`.
1. Create a PR in the `kubeflow/website` repository.
(See [example PR](https://github.com/kubeflow/website/pull/1531).)

0 comments on commit 6f231e8

Please sign in to comment.