KubeWharf Website

Welcome to the GitHub repository for KubeWharf's public website!

The docs website is hosted at https://kubewharf.github.io.

We use Hugo with the google/docsy theme for styling and site structure.

Quicistart

Here's a quick guide to updating the repo:

1. download repo

   git clone --depth 1 https://github.com/kubewharf/github.io

2. (Optional) If you want to do SCSS edits and want to publish these, you need to install PostCSS

   npm install

Running a container locally (recommended)

You can run docsy-example inside a Docker container, the container runs with a volume bound to the docsy-example folder. This approach doesn't require you to install any dependencies other than Docker Desktop on Windows and Mac, and Docker Compose on Linux.

1. Build the docker image

   docker-compose build

2. Run the built image

   docker-compose up

   NOTE: You can run both commands at once with docker-compose up --build.

3. Verify that the service is working.

   Open your web browser and type http://localhost:1313 in your navigation bar, This opens a local instance of the kubewharf homepage. You can now make changes to the code and those changes will immediately show up in your browser after you save.

Cleanup

To stop Docker Compose, on your terminal window, press Ctrl + C. To remove the produced images run:

docker-compose rm

Running the website locally

Building and running the site locally requires a recent extended version of Hugo. You can find out more about how to install Hugo for your environment in Getting started guide.

Once you've made your working copy of the site repo, from the repo root folder, run:

hugo server

Community

Email: kubewharf.conduct@bytedance.com

License

This project is licensed under the Apache-2.0 License.