* Revise Pod concept
Adapt the existing Pod documentation to suit the Docsy theme, by
promoting the Pod concept itself to /docs/concepts/workloads/pods/
Following on from this, update the Pod Lifecycle page to cover the
lifecycle of a Pod and follow on directly from the Pod concept,
for readers keen to understand things in detail.
This change also removes the automatic contents list from the Pod
overview page. Instead, the new page links to all the pages
inside the Pod section.
* Update links to Pod concept
Link to updated content
* Incorporate Pod concept suggestions
Co-authored-by: Celeste Horgan <celeste@cncf.io>
* Revise StatefulSet suggestion for Pod concept
Co-authored-by: Celeste Horgan <celeste@cncf.io>
Co-authored-by: Celeste Horgan <celeste@cncf.io>
The AnchorsJS module has been killed recently in #22311 prematurely. Now we don't
have a global variable 'anchors' to customize. This PR removes the related code
in script.js in hope everything else is still working correctly.
* Separate system logs from Logging Architecture as it mainly covers application logging
* Rename "Metics For The Kubernetes Control Plane" to "Metrics For The Kubernetes System Components" as it covers non-control plane components
* Rename files to `system-logs.md` and `system-metrics.md`
* Remove trailing whitespaces
* Add sections about Klog and Structured Logging
Co-authored-by: Celeste Horgan <celeste@cncf.io>
Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
Co-authored-by: Paweł Kępka <pkepka@google.com>
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
After docsy theme got merged these scripts aren't needed anymore. Confirmed
after removing it (and all `<script>` references to it) the tooltip
functionality is still there.
Also removed the reference in `config.toml` to it, which may have stripped some
dangling whitespace.
Where an existing Concept section has an index and the first page is
“Overview of X”, move the content of that overview into the index page
itself.
Also, configure redirects accordingly.
* Add Docsy, required packages and config
* Apply Docsy integration work to k8s website
This encompasses significant changes to the style system, layout files,
as well as changes to some of the static assets. To examine this work
and the iterations that were performed, the original repository can be
found at https://github.com/gearbox-built/kubernetes-hugo.git
* Address issues found in review
The styling and positioning of the header, footer, some shortcodes and
main container elements are improved. A new partial is added for
favicons. The sidebars, as well as inner table of contents, have been
altered for better positioning and rendering of content. Localization
has also been addressed.
* Enable announcements
The recent Black Lives Matter announcement surfaced issues which have
been addressed.
* Moved "Assigning Pods to Nodes" article to Concepts -> Scheduling and Eviction
* Moved "Taints and Tolerations" article to Concepts -> Scheduling and Eviction
* Updated weight of the "Kubernetes Scheduler" article so it appears first
* Updated redirects
* Replaced links to "Assigning Pods to Nodes" and "Taints and Tolerations" articles
to avoid redirects.
Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
* Create index.html
* add logos
* fix logo file name
* add booking.com images
* remove Nav from featured
* add booz allen featured logo
* make Booz Allen featured
* remove spotify from featured
* fix booz allen front matter
* add correct logo
* add correct booz allen logo
* Reword resource limits section about ephemeral local storage
Co-Authored-By: Celeste Horgan <celeste@cncf.io>
* Move troubleshooting section to foot of page
It's OK to hyperlink to this section; in fact, I recommend it.
* Tweak section about monitoring key Pod resources
Monitoring reports memory use as well as CPU
* Fold 2 displayed headings into 1
Add a 2nd-level heading to cover two related headings, that I'm moving
to 3rd level. This change shortens the table of contents and still
leaves an entry there for readers to click on.
* Reword What's next section
* Revise punctuation
* Change page path to match title
Co-authored-by: Celeste Horgan <celeste@cncf.io>
* Rename `docs/concepts/scheduling` to `docs/concepts/scheduling-eviction`
* Retitle concept header to "Scheduling and Eviction"
* Update redirects
* Update internal links (en only)
Part of proposal #19081
Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
* Fix home page name
* Remove untranslated
* Localize left panel in Getting Started
* Fix left menu button on mobile and add redirect
* Implement review suggestions
Co-authored-by: Anastasiya Kulyk <nastya.kulyk@gmail.com>
Co-authored-by: Maksym Vlasov <MaxymVlasov@users.noreply.github.com>
Anna Jung
Karen Bradshaw
M. Habib Rosyad
Savitha Raghunathan
Kubernetes Prow Robot
Tim Bannister
TAKAHASHI Shuuji
Qiming Teng
Marek Siarkowicz
Arhell
Wei Huang
Aldo Culquicondor
Saba Zubair
Jorge Gallegos
ZhiFeng1993
Zhang Yong
Sai Harsha Kottapalli
Prasad Katti
zacharysarah
Aidan Ranney
Celeste Horgan
Bradley Weston
Sascha Grunert
KoukiNishihara
Ihor Dvoretskyi
Alex Contini
Adam Kaplan
jkld11
Wei Huang
Rick Ducott
Daniel Lipovetsky
Jim Angel
MaxymVlasov
Rémy Léone
Paul Burt