How to use this site

The left sidebar mirrors the folder structure of the openshift-cheatsheet repo. Each top-level entry corresponds to one folder, and any .md file inside that folder shows up automatically as a sub-page underneath it.

Search

Hit / or Ctrl + K (⌘ + K on macOS) to open the full-text search. It indexes every page in the site, including the code examples — so searching for oc adm must-gather or etcdctl endpoint health jumps straight to the relevant snippet.

Page structure

Every page generally follows the same layout:

Title at the top (from the .md file’s frontmatter, or the # H1 in the file)
Inline oc commands in fenced code blocks (bash)
YAML manifests in yaml-tagged blocks
Notes / context as plain prose between blocks
“Edit this page on GitHub” link in the right rail — fixes go straight to the source repo

Copy-paste workflow

Click the copy icon on the top-right of any code block to copy the snippet to your clipboard. The site preserves multi-line shell pipelines verbatim, so what you paste into your terminal is exactly what’s documented.

Contributing

This site rebuilds automatically on every push to main. To add a command, fix a typo, or add an entire new section:

Edit the relevant .md file in the repo (or click “Edit this page” at the bottom of any page)
Commit and push to main
The GitHub Action rebuilds and republishes the site within ~1 minute

Reporting issues

Found an outdated command or a broken example? Open an issue at gitlab.com/helloiamgio/openshift-cheatsheet/-/issues.