Skip to content

Commit 5b983d1

Browse files
authored
Merge pull request #52739 from lavishpal/update-api-ref-docs-workflow
Modernize API reference docs: remove GOPATH workflow and outdated `api-index.md` file
2 parents cc36eef + d5d08de commit 5b983d1

File tree

1 file changed

+18
-28
lines changed

1 file changed

+18
-28
lines changed

content/en/docs/contribute/generate-ref-docs/kubernetes-api.md

Lines changed: 18 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -38,37 +38,39 @@ export GOPATH=$HOME/<workspace>
3838
Get a local clone of the following repositories:
3939

4040
```shell
41-
go get -u github.com/kubernetes-sigs/reference-docs
42-
41+
git clone github.com/kubernetes-sigs/reference-docs
42+
```
43+
Move into the `gen-apidocs` directory of the `reference-docs` repository and install the required Go packages:
44+
```shell
4345
go get -u github.com/go-openapi/loads
4446
go get -u github.com/go-openapi/spec
4547
```
4648

4749
If you don't already have the kubernetes/website repository, get it now:
4850

4951
```shell
50-
git clone https://github.com/<your-username>/website $GOPATH/src/github.com/<your-username>/website
52+
git clone https://github.com/<your-username>/website
5153
```
5254

53-
Get a clone of the kubernetes/kubernetes repository as k8s.io/kubernetes:
55+
Get a clone of the kubernetes/kubernetes repository:
5456

5557
```shell
56-
git clone https://github.com/kubernetes/kubernetes $GOPATH/src/k8s.io/kubernetes
58+
git clone https://github.com/kubernetes/kubernetes
5759
```
5860

5961
* The base directory of your clone of the
6062
[kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) repository is
61-
`$GOPATH/src/k8s.io/kubernetes.`
63+
`<your-path-to>/kubernetes/kubernetes.`
6264
The remaining steps refer to your base directory as `<k8s-base>`.
6365

6466
* The base directory of your clone of the
6567
[kubernetes/website](https://github.com/kubernetes/website) repository is
66-
`$GOPATH/src/github.com/<your username>/website`.
68+
`<your-path-to>/website`.
6769
The remaining steps refer to your base directory as `<web-base>`.
6870

6971
* The base directory of your clone of the
7072
[kubernetes-sigs/reference-docs](https://github.com/kubernetes-sigs/reference-docs)
71-
repository is `$GOPATH/src/github.com/kubernetes-sigs/reference-docs`.
73+
repository is `<your-path-to>/reference-docs`.
7274
The remaining steps refer to your base directory as `<rdocs-base>`.
7375

7476
## Generate the API reference docs
@@ -86,8 +88,8 @@ This section shows how to generate the
8688
For example:
8789

8890
```shell
89-
export K8S_WEBROOT=${GOPATH}/src/github.com/<your-username>/website
90-
export K8S_ROOT=${GOPATH}/src/k8s.io/kubernetes
91+
export K8S_WEBROOT=<your-path-to>/website
92+
export K8S_ROOT=<your-path-to>/kubernetes
9193
export K8S_RELEASE=1.17.0
9294
```
9395

@@ -150,26 +152,14 @@ static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/js/navDat
150152
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/js/scroll.js
151153
```
152154

153-
## Update the API reference index pages
154-
155-
When generating reference documentation for a new release, update the file,
156-
`<web-base>/content/en/docs/reference/kubernetes-api/api-index.md` with the new
157-
version number.
158-
159-
* Open `<web-base>/content/en/docs/reference/kubernetes-api/api-index.md` for editing,
160-
and update the API reference version number. For example:
161-
162-
```
163-
---
164-
title: v1.17
165-
---
155+
## API reference location and versioning
166156

167-
[Kubernetes API v1.17](/docs/reference/generated/kubernetes-api/v1.17/)
168-
```
157+
The generated API reference files (HTML version) are copied to `<web-base>/static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/`. This directory contains the standalone HTML API documentation.
169158

170-
* Open `<web-base>/content/en/docs/reference/_index.md` for editing, and add a
171-
new link for the latest API reference. Remove the oldest API reference version.
172-
There should be five links to the most recent API references.
159+
{{< note >}}
160+
The Markdown version of the API reference located at `<web-base>/content/en/docs/reference/kubernetes-api/`
161+
is generated separately using the [gen-resourcesdocs](https://github.com/kubernetes-sigs/reference-docs/tree/master/gen-resourcesdocs) generator.
162+
{{< /note >}}
173163

174164
## Locally test the API reference
175165

0 commit comments

Comments
 (0)