Kubernetes Contributor Site
This repository contains the Hugo site and generator scripts for the Kubernetes Contributor site. Much of the content is generated from the kubernetes/community repo directly and care should be taken when working within the content directory. The hugo theme being used is a slimmed down derivative of the docdock theme.
The heavy lifting occurs within the gen-site.sh script. If not being called externally, it will clone the kubernetes/community within the build directory then sync specific directories and files to the content directory.
Content is synced following the below rules:
committee-steeringis moved to
committee-code-of-conductdirectory is moved to
github-managementis moved to
governance.mdis moved to
governance/README.mdand will become the default index page for the governance section.
community-membership.mdare moved to the root of
- Directories prefixed with
wg-will be synced to the
sig-list.mdis moved to
sigs/README.mdand will become the default index page for the sigs section
- Other directories not included in the exclude.list are copied to the root of the content directory.
- Files at the root of the directory will only be copied over if they are listed in the
include.list with the exclusion of
sig-list.mdis copied to both the
working-groupsand renamed to
README.mdfrom the root of the community repository is copied over to the root of the content directory for now.
Next it will go through all the files within the content directory and search for any links that may need to be corrected to function outside of github along with inserting a front-matter header (if needed).
README.md files are renamed to
_index.md. These function similarly to
files within a GitHub repository, but are what Hugo is expecting.
At that point the site can be previewed locally with
hugo serve, or the site built with
If it is built, the default location is
Building the Site
After the script completes, the site can be previewed by executing
hugo serve from the project
directory. If satisfied with your changes, the site can be fully rendered with the
Note to MAC Users
OSX by default ships with an outdated version of bash that does not support all the functionality used by the site generator script. Bash can be safely updated via homebrew. Once installed, execute the below commands to install a newer version of bash.
$ brew install bash $ sudo bash -c 'echo /usr/local/bin/bash >> /etc/shells' $ chsh -s /usr/local/bin/bash
You may need to restart or log out and log back in again to have it fully apply.
Community, discussion, contribution, and support
You can reach the maintainers of this project at:
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.