Skip to content

Commit 59a42b1

Browse files
kbhawkeyk8s-ci-robot
authored andcommitted
updated assets, regen refs (#18466)
* updated assets, regenerated refs * update version checks * rebuilt api ref, versioning updates
1 parent 32fe4b4 commit 59a42b1

File tree

10 files changed

+371
-260
lines changed

10 files changed

+371
-260
lines changed

static/docs/reference/generated/kubectl/kubectl-commands.html

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

static/docs/reference/generated/kubernetes-api/v1.17/css/stylesheet.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ body > #wrapper {
8383
left: 0;
8484
background-color: whitesmoke;
8585
border-right: 2px solid slategrey;
86-
overflow-x: hidden;
86+
overflow-x: auto;
8787
padding-top: 60px;
8888
}
8989

static/docs/reference/generated/kubernetes-api/v1.17/index.html

Lines changed: 227 additions & 149 deletions
Large diffs are not rendered by default.

update-imported-docs/Makefile_temp

Lines changed: 72 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,69 @@
11
WEBROOT=${K8S_WEBROOT}
22
K8SROOT=${K8S_ROOT}
3-
MINOR_VERSION=${K8S_RELEASE}
3+
K8SRELEASE=${K8S_RELEASE}
44

5-
APISRC=gen-apidocs/generators
6-
APIDST=$(WEBROOT)/static/docs/reference/generated/kubernetes-api/v1.$(MINOR_VERSION)
7-
APISRCFONT=$(APISRC)/build/node_modules/font-awesome
8-
APIDSTFONT=$(APIDST)/node_modules/font-awesome
5+
# change <major>.<minor> to <major>_<minor>
6+
getversion:
7+
echo $(K8SRELEASE) | sed "s/\./_/g" > b.tmp
8+
9+
K8SVERDIR=$(shell cat b.tmp)
10+
11+
sepversion: getversion
12+
echo $(K8SVERDIR) | sed "s/[0-9]_//g" > minor.tmp
13+
echo $(K8SVERDIR) | sed "s/_[0-9]*//g" > major.tmp
14+
15+
MINOR_VERSION := $(shell cat minor.tmp)
16+
MAJOR_VERSION := $(shell cat major.tmp)
17+
ONE := 1
18+
PREV_MINOR_VERSION := $(shell echo $$(( $(MINOR_VERSION) - $(ONE) )))
19+
20+
cleantmp:
21+
rm minor.tmp; rm major.tmp; rm b.tmp
22+
23+
APISRC=gen-apidocs
24+
APIDST=$(WEBROOT)/static/docs/reference/generated/kubernetes-api/v$(K8SRELEASE)
925

1026
CLISRC=gen-kubectldocs/generators/build
1127
CLIDST=$(WEBROOT)/static/docs/reference/generated/kubectl
1228
CLISRCFONT=$(CLISRC)/node_modules/font-awesome
1329
CLIDSTFONT=$(CLIDST)/node_modules/font-awesome
1430

1531
default:
16-
@echo "Support commands:\ncli api comp copycli copyapi copycomp updateapispec"
32+
@echo "Support commands:\ncli api comp copycli copyapi updateapispec"
33+
34+
# Set up versioned directories for new release
35+
# kubectl-command static-includes, toc.yaml
36+
createkubectldir: sepversion
37+
@echo version $(K8SVERDIR)
38+
mkdir -p $(shell pwd)/gen-kubectldocs/generators/v$(K8SVERDIR)
39+
if ! [ -f "$(shell pwd)/gen-kubectldocs/generators/v1_$(PREV_MINOR_VERSION)/config.yaml" ]; then \
40+
cp -r $(shell pwd)/gen-kubectldocs/generators/v1_15/* $(shell pwd)/gen-kubectldocs/generators/v$(K8SVERDIR)/; \
41+
else \
42+
cp -r $(shell pwd)/gen-kubectldocs/generators/v1_$(PREV_MINOR_VERSION)/* $(shell pwd)/gen-kubectldocs/generators/v$(K8SVERDIR)/; \
43+
fi
44+
45+
# api-ref versioned dir, swagger.json, config.yaml
46+
createapidir: sepversion
47+
@echo version $(K8SVERDIR)
48+
mkdir -p $(shell pwd)/gen-apidocs/config/v$(K8SVERDIR)
49+
# config.yaml
50+
if ! [ -f "$(APISRC)/config/v1_$(MINOR_VERSION)/config.yaml" ]; then \
51+
if [ -f "$(shell pwd)/gen-apidocs/config/v1_$(PREV_MINOR_VERSION)/config.yaml" ]; then \
52+
cp $(shell pwd)/gen-apidocs/config/v1_$(PREV_MINOR_VERSION)/config.yaml $(APISRC)/config/v1_$(MINOR_VERSION)/config.yaml; \
53+
echo "Using config file: $(shell pwd)/gen-apidocs/config/v1_$(PREV_MINOR_VERSION)/config.yaml"; \
54+
else \
55+
cp $(APISRC)/config/config.yaml $(APISRC)/config/v1_$(MINOR_VERSION)/config.yaml; \
56+
fi \
57+
fi
58+
# swagger.json
59+
if ! [ -f "$(APISRC)/config/v1_$(MINOR_VERSION)/swagger.json" ]; then \
60+
cp $(K8SROOT)/api/openapi-spec/swagger.json $(APISRC)/config/v1_$(MINOR_VERSION)/swagger.json; \
61+
fi
62+
63+
# copy versioned files to the base config dir before generating api ref
64+
stageapifiles: createapidir
65+
cp $(APISRC)/config/v1_$(MINOR_VERSION)/config.yaml $(APISRC)/config/config.yaml
66+
cp $(APISRC)/config/v1_$(MINOR_VERSION)/swagger.json $(APISRC)/config/swagger.json
1767

1868
# Build kubectl docs
1969
cleancli:
@@ -22,9 +72,7 @@ cleancli:
2272
sudo rm -rf $(shell pwd)/gen-kubectldocs/generators/build
2373
sudo rm -rf $(shell pwd)/gen-kubectldocs/generators/manifest.json
2474

25-
cli: cleancli
26-
mkdir -p $(shell pwd)/gen-kubectldocs/generators/v1_$(MINOR_VERSION)
27-
cp -r $(shell pwd)/gen-kubectldocs/generators/v1_15/* $(shell pwd)/gen-kubectldocs/generators/v1_$(MINOR_VERSION)
75+
cli: createkubectldir cleancli
2876
go run gen-kubectldocs/main.go --kubernetes-version v1_$(MINOR_VERSION)
2977
docker run -v $(shell pwd)/gen-kubectldocs/generators/includes:/source -v $(shell pwd)/gen-kubectldocs/generators/build:/build -v $(shell pwd)/gen-kubectldocs/generators/:/manifest pwittrock/brodocs
3078

@@ -40,7 +88,7 @@ copycli: cli
4088
cp $(CLISRC)/node_modules/jquery/dist/jquery.min.js $(CLIDST)/node_modules/jquery/dist/jquery.min.js
4189
cp $(CLISRCFONT)/css/font-awesome.min.css $(CLIDSTFONT)/css/font-awesome.min.css
4290

43-
# Build kube component docs
91+
# Build kube component,tool docs
4492
cleancomp:
4593
rm -rf $(shell pwd)/gen-compdocs/build
4694

@@ -55,46 +103,26 @@ comp: cleancomp
55103
go run gen-compdocs/main.go gen-compdocs/build kubeadm
56104
go run gen-compdocs/main.go gen-compdocs/build kubectl
57105

58-
copycomp:
59-
cp $(shell pwd)/gen-compdocs/build/* $(WEBROOT)/docs/reference/generated/
60-
61106
# Build api docs
62107
updateapispec:
63-
cp $(K8SROOT)/api/openapi-spec/swagger.json gen-apidocs/generators/openapi-spec/swagger.json
108+
cp $(K8SROOT)/api/openapi-spec/swagger.json gen-apidocs/config/swagger.json
64109

65-
api: cleanapi
66-
go run gen-apidocs/main.go --config-dir=gen-apidocs/generators --munge-groups=false
110+
api: cleanapi stageapifiles
111+
go run gen-apidocs/main.go --work-dir=gen-apidocs --munge-groups=false
67112

68-
# NOTE: The following "sudo" may go away when we remove docker based api doc generator
69113
cleanapi:
70-
sudo rm -rf $(shell pwd)/gen-apidocs/generators/build
71-
sudo rm -rf $(shell pwd)/gen-apidocs/generators/includes
114+
rm -rf $(shell pwd)/gen-apidocs/build
72115

73-
copyapi:
116+
copyapi: api
117+
mkdir -p $(APIDST)
74118
cp $(APISRC)/build/index.html $(APIDST)/index.html
75-
cp $(APISRC)/build/navData.js $(APIDST)/navData.js
76-
cp $(APISRC)/static/scroll.js $(APIDST)/scroll.js
119+
# copy scroll.js, jquery.scrollTo.min.js and the new navData.js
120+
mkdir -p $(APIDST)/js
121+
cp $(APISRC)/build/navData.js $(APIDST)/js/
122+
cp $(APISRC)/static/js/* $(APIDST)/js/
123+
# copy stylesheet.css, bootstrap.min.css, font-awesome.min.css
77124
mkdir -p $(APIDST)/css
78-
cp $(APISRC)/static/stylesheet.css $(APIDST)/css/stylesheet.css
79-
cp $(APISRC)/static/bootstrap.min.css $(APIDST)/css/bootstrap.min.css
80-
cp $(APISRC)/static/jquery.scrollTo.min.js $(APIDST)/jquery.scrollTo.min.js
81-
cp $(APISRC)/static/font-awesome.min.css $(APIDST)/css/font-awesome.min.css
125+
cp $(APISRC)/static/css/* $(APIDST)/css/
126+
# copy fonts data
82127
mkdir -p $(APIDST)/fonts
83-
cp $(APISRC)/static/FontAwesome.otf $(APIDST)/fonts/FontAwesome.otf
84-
cp $(APISRC)/static/fontawesome-webfont.eot $(APIDST)/fonts/fontawesome-webfont.eot
85-
cp $(APISRC)/static/fontawesome-webfont.svg $(APIDST)/fonts/fontawesome-webfont.svg
86-
cp $(APISRC)/static/fontawesome-webfont.ttf $(APIDST)/fonts/fontawesome-webfont.ttf
87-
cp $(APISRC)/static/fontawesome-webfont.woff $(APIDST)/fonts/fontawesome-webfont.woff
88-
cp $(APISRC)/static/fontawesome-webfont.woff2 $(APIDST)/fonts/fontawesome-webfont.woff2
89-
90-
# Build resource docs
91-
resource: cleanapi
92-
go run gen-apidocs/main.go --build-operations=false --munge-groups=false --config-dir=gen-apidocs/generators
93-
docker run -v $(shell pwd)/gen-apidocs/generators/includes:/source -v $(shell pwd)/gen-apidocs/generators/build:/build -v $(shell pwd)/gen-apidocs/generators/:/manifest pwittrock/brodocs
94-
95-
copyresource: resource
96-
rm -rf gen-apidocs/generators/build/documents/
97-
rm -rf gen-apidocs/generators/build/runbrodocs.sh
98-
rm -rf gen-apidocs/generators/build/manifest.json
99-
rm -rf $(WEBROOT)/docs/resources-reference/v1.$(MINOR_VERSION)/*
100-
cp -r gen-apidocs/generators/build/* $(WEBROOT)/docs/resources-reference/v1.$(MINOR_VERSION)/
128+
cp $(APISRC)/static/fonts/* $(APIDST)/fonts/

update-imported-docs/README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1-
# Update imported docs
1+
### Update Kubernetes reference docs
22

3-
This tool updates the reference docs generated from the Kubernetes repository.
3+
This `update-imported-docs.py` script generates the Kubernetes reference docs (component/tool pages, kubectl-command, Kubernetes API reference).
44

5+
<!-- TODO: Update this information -->
56
[Generating Reference Pages for Kubernetes Components and Tools](https://kubernetes.io/docs/contribute/generate-ref-docs/kubernetes-components/) contains detailed instructions for using this tool.
7+
8+
### General Usage
9+
10+
```shell
11+
python3 update-imported-docs.py <config_file> <k8s_release>
12+
```

update-imported-docs/reference.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ repos:
88
cd $GOPATH
99
git clone https://github.com/kubernetes/kubernetes.git src/k8s.io/kubernetes
1010
cd src/k8s.io/kubernetes
11-
git checkout release-1.${K8S_RELEASE}
11+
git checkout release-${K8S_RELEASE}
1212
make generated_files
1313
cp -L -R vendor $GOPATH/src
1414
rm -r vendor/github.com/spf13/cobra
@@ -22,6 +22,8 @@ repos:
2222
go get -v github.com/kubernetes-sigs/reference-docs/gen-kubectldocs
2323
cd src/github.com/kubernetes-sigs/reference-docs/
2424
cp ${K8S_WEBROOT}/update-imported-docs/Makefile_temp ./Makefile
25+
# testing
26+
make sepversion
2527
# generate kubectl cmd reference
2628
make copycli
2729
#
@@ -32,11 +34,8 @@ repos:
3234
go get -u github.com/go-openapi/spec
3335
go get -v github.com/kubernetes-sigs/reference-docs/gen-apidocs
3436
cd src/github.com/kubernetes-sigs/reference-docs/
35-
make updateapispec
36-
make api
3737
make copyapi
3838
39-
4039
files:
4140
- src: gen-compdocs/build/cloud-controller-manager.md
4241
dst: content/en/docs/reference/command-line-tools-reference/
@@ -46,7 +45,7 @@ repos:
4645
dst: content/en/docs/reference/command-line-tools-reference/
4746
# We have problems generating docs for kubelet, it is done manually now
4847
# - src: gen-compdocs/build/kubelet.md
49-
# dst: content/en/docs/reference/command-line-tools-reference/
48+
# dst: content/en/docs/reference/command-line-tools-reference/
5049
- src: gen-compdocs/build/kube-proxy.md
5150
dst: content/en/docs/reference/command-line-tools-reference/
5251
- src: gen-compdocs/build/kube-scheduler.md

update-imported-docs/update-imported-docs.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
# Config files:
2323
# reference.yml use this to update the reference docs
2424
# release.yml use this to auto-generate/import release notes
25-
# K8S_RELEASE: provide the minor release version such as, 17
25+
# K8S_RELEASE: provide the release version such as, 1.17
2626
##
2727

2828
import argparse
@@ -157,16 +157,15 @@ def parse_input_args():
157157
Parse command line argument
158158
'config_file' is the first argument; it should be one of the YAML
159159
files in this same directory
160-
'k8s_release' is the second argument; provide the release minor
161-
version
160+
'k8s_release' is the second argument; provide the release version
162161
:return: parsed argument
163162
"""
164163
parser = argparse.ArgumentParser()
165164
parser.add_argument('config_file', type=str,
166165
help="reference.yml to generate reference docs; "
167166
"release.yml to generate release notes")
168167
parser.add_argument('k8s_release', type=str,
169-
help="k8s release minor version, ex: 17"
168+
help="k8s release version, ex: 1.17"
170169
)
171170
return parser.parse_args()
172171

0 commit comments

Comments
 (0)