Skip to content

Commit 2309413

Browse files
authored
Merge pull request #31344 from chalin/patch-1
Copyedits to API ref building instructions in README
2 parents 030cc57 + 91df90d commit 2309413

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,19 +65,19 @@ This will start the local Hugo server on port 1313. Open up your browser to <htt
6565

6666
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>.
6767

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

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

7272
```bash
7373
git submodule update --init --recursive --depth 1
7474
```
7575

7676
2. Update the Swagger specification:
7777

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

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

0 commit comments

Comments
 (0)