-
Notifications
You must be signed in to change notification settings - Fork 441
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated links and instructions for Katib API docs. (#1022)
- Loading branch information
1 parent
c30e960
commit 39fd75d
Showing
3 changed files
with
25 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,27 @@ | ||
# Katib API | ||
This is APIs for Katib. | ||
Manager service is an API for core component. | ||
Suggestion service is an API for Suggestion services. | ||
EarlyStopping service is an API for EarlyStopping services. | ||
Katib offers the following APIs: | ||
* Manager service is an API for core component. | ||
* Suggestion service is an API for Suggestion services. | ||
* EarlyStopping service is an API for EarlyStopping services. | ||
|
||
## Documentation | ||
Please refer to the `api.md`: | ||
* [v1alpha3 documentation](./v1alpha3/gen-doc/api.md) | ||
See the [Katib API reference docs](https://www.kubeflow.org/docs/reference/katib/). | ||
|
||
## Update API and generate documents | ||
When you want to edit the API, please only edit the corresponding `api.proto` and generate other files from it: | ||
* [v1alpha3/api.proto](./v1alpha3/api.proto) | ||
|
||
Documents are also generated from `api.proto` by [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc). | ||
Running `build.sh` can update every file from `api.proto` and generate docs: | ||
We use [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc) to | ||
generate the API docs from `api.proto`. | ||
|
||
Run `build.sh` to update every file from `api.proto` and generate the docs: | ||
* [v1alpha3/build.sh](./v1alpha3/build.sh) | ||
|
||
After running `build.sh`, follow these steps to update the docs: | ||
|
||
1. Copy the updated content from your generated file | ||
`pkg/apis/manager/v1alpha3/gen-doc/api.md` to the doc page in the | ||
`kubeflow/website` repository: | ||
`kubeflow/website/blob/master/content/docs/reference/katib/v1alpha3/katib.md`. | ||
1. Create a PR in the `kubeflow/website` repository. | ||
(See [example PR](https://github.com/kubeflow/website/pull/1531).) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters