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 master 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.

Init

Initially, that is, the first time when you git clone this repo you will have to carry out the following steps to set up the publishing workflow:

• in public/ do:
  • git init followed by a
  • git remote add origin https://github.com/openshift-evangelists/kbe.git and finally a
  • git checkout -b gh-pages
• in public/ create a file CNAME with the content kubernetesbyexample.com
• from this moment on the publish workflow is the same as described below

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 "publishes site"
$ 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/