kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
website/static/css/README.md

13 lines
259 B
Markdown
Raw Normal View History

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
2020-07-05 05:41:19 +00:00
# NOTE
Address review feedbacks
2020-07-05 22:52:46 +00:00
This directory contains stylesheet files referenced by different sections of
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
2020-07-05 05:41:19 +00:00
the website. Please use caution when moving/renaming them.
## Style Sheets used by API reference
- bootstrap-4.3.1.min.css
- fontawesome-4.7.0.min.css
- style_apiref.css