Skip to content

Commit

Permalink
README: copyedits to API ref building instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin authored Jan 14, 2022
1 parent 2a55433 commit 91df90d
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,19 +65,19 @@ This will start the local Hugo server on port 1313. Open up your browser to <htt

The API reference pages located in `content/en/docs/reference/kubernetes-api` are built from the Swagger specification, using <https://github.com/kubernetes-sigs/reference-docs/tree/master/gen-resourcesdocs>.

To update the reference pages for a new Kubernetes release (replace v1.20 in the following examples with the release to update to):
To update the reference pages for a new Kubernetes release follow these steps:

1. Pull the `kubernetes-resources-reference` submodule:
1. Pull in the `api-ref-generator` submodule:

```bash
git submodule update --init --recursive --depth 1
```

2. Update the Swagger specification:

```
curl 'https://raw.githubusercontent.com/kubernetes/kubernetes/master/api/openapi-spec/swagger.json' > api-ref-assets/api/swagger.json
```
```bash
curl 'https://raw.githubusercontent.com/kubernetes/kubernetes/master/api/openapi-spec/swagger.json' > api-ref-assets/api/swagger.json
```

3. In `api-ref-assets/config/`, adapt the files `toc.yaml` and `fields.yaml` to reflect the changes of the new release.

Expand Down

0 comments on commit 91df90d

Please sign in to comment.