Skip to content

Commit 0821165

Browse files
authored
Merge pull request #27866 from kubernetes/dev-1.22
Official 1.22 Release Docs
2 parents a54e81e + 6e33dfd commit 0821165

File tree

147 files changed

+142763
-1581
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

147 files changed

+142763
-1581
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,4 +96,4 @@ clean-api-reference: ## Clean all directories in API reference directory, preser
9696

9797
api-reference: clean-api-reference ## Build the API reference pages. go needed
9898
cd api-ref-generator/gen-resourcesdocs && \
99-
go run cmd/main.go kwebsite --config-dir config/v1.21/ --file api/v1.21/swagger.json --output-dir ../../content/en/docs/reference/kubernetes-api --templates templates
99+
go run cmd/main.go kwebsite --config-dir ../../api-ref-assets/config/ --file ../../api-ref-assets/api/swagger.json --output-dir ../../content/en/docs/reference/kubernetes-api --templates ../../api-ref-assets/templates

README.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -73,23 +73,15 @@ To update the reference pages for a new Kubernetes release (replace v1.20 in the
7373
git submodule update --init --recursive --depth 1
7474
```
7575

76-
2. Create a new API revision into the submodule, and add the Swagger specification:
76+
2. Update the Swagger specification:
7777

78-
```bash
79-
mkdir api-ref-generator/gen-resourcesdocs/api/v1.20
80-
curl 'https://raw.githubusercontent.com/kubernetes/kubernetes/master/api/openapi-spec/swagger.json' > api-ref-generator/gen-resourcesdocs/api/v1.20/swagger.json
81-
```
82-
83-
3. Copy the table of contents and fields configuration for the new release from a previous one:
84-
85-
```bash
86-
mkdir api-ref-generator/gen-resourcesdocs/api/v1.20
87-
cp api-ref-generator/gen-resourcesdocs/api/v1.19/* api-ref-generator/gen-resourcesdocs/api/v1.20/
88-
```
78+
```
79+
curl 'https://raw.githubusercontent.com/kubernetes/kubernetes/master/api/openapi-spec/swagger.json' > api-ref-assets/api/swagger.json
80+
```
8981

90-
4. Adapt the files `toc.yaml` and `fields.yaml` to reflect the changes between the two releases
82+
3. In `api-ref-assets/config/`, adapt the files `toc.yaml` and `fields.yaml` to reflect the changes of the new release.
9183

92-
5. Next, build the pages:
84+
4. Next, build the pages:
9385

9486
```bash
9587
make api-reference
@@ -104,7 +96,7 @@ To update the reference pages for a new Kubernetes release (replace v1.20 in the
10496

10597
In a web browser, go to <http://localhost:1313/docs/reference/kubernetes-api/> to view the API reference.
10698

107-
6. When all changes of the new contract are reflected into the configuration files `toc.yaml` and `fields.yaml`, create a Pull Request with the newly generated API reference pages.
99+
5. When all changes of the new contract are reflected into the configuration files `toc.yaml` and `fields.yaml`, create a Pull Request with the newly generated API reference pages.
108100

109101
## Troubleshooting
110102

api-ref-assets/api/swagger.json

Lines changed: 90274 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)