https://github.com/openshift-evangelists/kbe

Kubernetes By Example
https://github.com/openshift-evangelists/kbe

kubernetes

Last synced: 4 days ago
JSON representation

Kubernetes By Example

• Host: GitHub
• URL: https://github.com/openshift-evangelists/kbe
• Owner: openshift-evangelists
• License: apache-2.0
• Created: 2017-04-23T17:41:13.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2022-05-12T08:51:49.000Z (over 2 years ago)
• Last Synced: 2024-08-02T20:47:39.419Z (3 months ago)
• Topics: kubernetes
• Language: HTML
• Homepage: https://kubernetesbyexample.com
• Size: 1.4 MB
• Stars: 429
• Watchers: 21
• Forks: 175
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Kubernetes By Example (KBE)

This repository contains the source code for website [`kubernetesbyexample.com`](http://kubernetesbyexample.com) using [Hugo](https://gohugo.io) as the website engine.

## Contribute

To contribute, please either raise an [issue](https://github.com/openshift-evangelists/kbe/issues)

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/](content/page/)

for the content in Markdown and [specs/](specs/) for respective YAML specifications.

## Build locally

1. Install `hugo` following the installation [guide](https://gohugo.io/overview/installing)

1. Get your local preview by running following command in the top-level dir:

```bash

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:

```bash

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

```

### Updates

To update the live site with new content:

```bash

# 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/