openshift-evangelists / kbe

Kubernetes By Example

Kubernetes By Example (KBE)

This repository contains the source code for website kubernetesbyexample.com using Hugo as the website engine.

Contribute

To contribute, please either raise an issue describing what you want to see covered here or send in a PR to the main branch. If you plan to contribute content, check out content/page/ for the content in Markdown and specs/ for respective YAML specifications.

Build locally

1. Install hugo following the installation guide
2. Get your local preview by running following command in the top-level dir:

hugo server --theme=beautifulhugo --buildDrafts

Publish

For site admins only, requires push access to this repo.

Setup

After cloning the repo, add the gh-pages branch as a submodule under the public folder:

git submodule add -f -b gh-pages [e-mail]:openshift-evangelists/kbe.git public

Updates

To update the live site with new content:

# still in top-level dir build the content in public/ dir:
hugo --theme=beautifulhugo
# add generated content (which lives in the gh-pages branch):
cd public/
git add --all
git commit -m "release notes go here..."
git push -f origin gh-pages

References

• https://themes.gohugo.io/beautifulhugo/
• https://gohugo.io/overview/configuration/
• https://gohugo.io/overview/quickstart/
• https://gohugo.io/tutorials/github-pages-blog/