UI for Kubernetes examples
Created as an alternative to examples plugin:
- Each kubernetes example files can be found using the Search input, clicking on results will go to the specific page and scroll to section/heading anchor point (current default search.heading_level: is 3)
- Each Resource type page contains all the related resources per sections
- Each code fragment is displayed using prismJS and on hover a button appears that copies the code block to the clipboard when clicked.
- Heading anchor links appear on hover over h1-h6 tags in page content allowing users to deep link to a particular heading on a page.
broken-* - yamls that exemplify broken kubernetes yaml states
[A-Z][a-zA-Z]* - Example yamls that correspond to resource types.
Within those folders are either simple/canonical examples, or examples in subfolders that expose particular items of functionality that are highlighted by their yaml path, eg Pod/spec.initContainers/.
If an example is an exemplar of a particular feature but tightly related to another resource, then an absolute folder might be added eg in Service there is Service/Pod.spec.subdomain.
To update the examples folder with the newest resources from the master branch we use git subtree pull --prefix examples https://github.com/ContainerSolutions/kubernetes-examples.git master --squash
In immediate children of the Examples/ folder there is a .md file which imports a list of all elements in the folder generator called deepChildrenList. Each .md file is named after the folder and has same title in its frontMatter (ex. StorageClass.md located in StorageClass folder) deepChildrenList looks for all the folders and files inside same folder and sections each content by child folder, It turns yaml into code and .md files without title or Frontmatter variable into parsed markdown.
To create pages that appear at the top navigation, always use the nav_order parameter in your pages’ YAML front matter. Using nav-order you can also decide the order of appearance in the menu. For more information check the base theme mentioned below.
If a new folder, child of Examples/ has been created on the master branch and pulled into this branch, to create a new page for the resource follow the steps:
- copy the .md file from any of the previous folders located at its root (ex. StorageClass.md located in StorageClass folder),
- rename and replace the title inside the file with the current folder name