Skip to content

Commit

Permalink
Updated links and instructions for Katib API docs. (#1022)
Browse files Browse the repository at this point in the history
  • Loading branch information
sarahmaddox authored and k8s-ci-robot committed Jan 20, 2020
1 parent c30e960 commit 39fd75d
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 10 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,9 @@ You can visualize general trend of Hyper parameter space and each training histo
[other examples](https://github.com/kubeflow/katib/blob/master/examples/v1alpha3) to generate a similar UI.
![katibui](./docs/images/katib-ui.png)

## API Documentation
## API documentation

Please refer to [api.md](./pkg/apis/manager/v1alpha3/gen-doc/api.md).
See the [Katib API reference docs](https://www.kubeflow.org/docs/reference/katib/).

## Installation

Expand Down
26 changes: 18 additions & 8 deletions pkg/apis/manager/README.md
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).)
5 changes: 5 additions & 0 deletions pkg/apis/manager/v1alpha3/gen-doc/api.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@

# Latest version of the docs

## For the most up-to-date docs, see the [Katib API reference docs](https://www.kubeflow.org/docs/reference/katib/).

# Protocol Documentation
<a name="top"></a>

Expand Down

0 comments on commit 39fd75d

Please sign in to comment.