Skip to content

Commit 162e5ed

Browse files
tengqmtengqm
committed
Clean up shared assets for API reference
This PR promotes the CSS, JS and FONTS files used by API reference to the `static/css`, `static/js` and `static/fonts` directories respectively. The intent is that for future releases, when generating API reference docs, only the `index.html` and `navData.js` files need to be copied from the generator tools. Details of changes: - `jquery-3.2.1.min.js` file is replaced by `jquery-3.3.1.min.js` to align with the version used by Docsy. We can investigate in the future whether this can be shared. Converging to the same version at least can reduce the risks of compatibility. - `jquery.scrollTo.min.js` moved to `static/js` file and renamed to `jquery.scrollTo-2.1.2.min.js` so we know the version from file name. - `scroll.js` moved to `static/js` and renamed to `scroll-apiref.js` to siginify that it is used by API reference. - A `README.md` file is added to `static/js` directory for describing the purposes of the these files. - `bootstrap.min.css` moved to `static/css` and renamed to `bootstrap-4.3.1.min.css` so that it can be shared and its version can be easily discovered. - `font-awesome.min.css` moved to `static/css` and renamed to `fontawesome-4.7.0.min.css` for the same reason. - `stylesheet.css` moved to `static/css` and renamed to `style_apiref.css` to siginify its purpose. - A `README.md` file is added to `static/css` directory for describing the purposes of the these files. - FontAwesome fonts files moved to `static/fonts` so that they can be shared across API reference versions. - Current API reference (1.18) is modified to reference the relocated files. Upstream generator change on the way (kubernetes-sigs/reference-tools/#161). Related: #22016, #22023, #22041, #22024, #22064
1 parent ece2888 commit 162e5ed

20 files changed

+32
-10
lines changed

‎static/css/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# NOTE
2+
3+
4+
This directory contains stylesheet files reference by different sections of
5+
the website. Please use caution when moving/renaming them.
6+
7+
## Style Sheets used by API reference
8+
9+
- bootstrap-4.3.1.min.css
10+
- fontawesome-4.7.0.min.css
11+
- style_apiref.css
12+
13+

‎static/docs/reference/generated/kubernetes-api/v1.18/css/bootstrap.min.css renamed to ‎static/css/bootstrap-4.3.1.min.css

File renamed without changes.

‎static/docs/reference/generated/kubernetes-api/v1.18/css/font-awesome.min.css renamed to ‎static/css/fontawesome-4.7.0.min.css

File renamed without changes.

‎static/docs/reference/generated/kubernetes-api/v1.18/css/stylesheet.css renamed to ‎static/css/style_apiref.css

File renamed without changes.

‎static/css/style_blablacar.css

100755100644
File mode changed.

‎static/css/style_buffer.css

100755100644
File mode changed.

‎static/css/style_wink.css

100755100644
File mode changed.

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
<META charset="UTF-8">
55
<TITLE>Kubernetes API Reference Docs</TITLE>
66
<LINK rel="shortcut icon" href="favicon.ico" type="image/vnd.microsoft.icon">
7-
<LINK rel="stylesheet" href="css/bootstrap.min.css">
8-
<LINK rel="stylesheet" href="css/font-awesome.min.css" type="text/css">
9-
<LINK rel="stylesheet" href="css/stylesheet.css" type="text/css">
7+
<LINK rel="stylesheet" href="/css/bootstrap-4.3.1.min.css">
8+
<LINK rel="stylesheet" href="/css/fontawesome-4.7.0.min.css" type="text/css">
9+
<LINK rel="stylesheet" href="/css/style_apiref.css" type="text/css">
1010
</HEAD>
1111
<BODY>
1212
<DIV id="wrapper" class="container-fluid">
@@ -47944,10 +47944,10 @@ <H1 id="webhookclientconfig-v1alpha1-auditregistration-k8s-io">WebhookClientConf
4794447944
</DIV>
4794547945
</DIV>
4794647946
</DIV>
47947-
<SCRIPT src="/js/jquery-3.2.1.min.js"></SCRIPT>
47948-
<SCRIPT src="js/jquery.scrollTo.min.js"></SCRIPT>
47947+
<SCRIPT src="/js/jquery-3.3.1.min.js"></SCRIPT>
47948+
<SCRIPT src="/js/jquery.scrollTo-2.1.2.min.js"></SCRIPT>
4794947949
<SCRIPT src="/js/bootstrap-4.3.1.min.js"></SCRIPT>
4795047950
<SCRIPT src="js/navData.js"></SCRIPT>
47951-
<SCRIPT src="js/scroll.js"></SCRIPT>
47951+
<SCRIPT src="/js/scroll-apiref.js"></SCRIPT>
4795247952
</BODY>
4795347953
</HTML>

‎static/docs/reference/generated/kubernetes-api/v1.18/fonts/FontAwesome.otf renamed to ‎static/fonts/FontAwesome.otf

File renamed without changes.

‎static/docs/reference/generated/kubernetes-api/v1.18/fonts/fontawesome-webfont.eot renamed to ‎static/fonts/fontawesome-webfont.eot

File renamed without changes.

0 commit comments

Comments
 (0)