Contributing to this repository
Welcome, Kubeflow users! This website contains the latest documentation for Kubeflow on Google Cloud. It is hosted at https://googlecloudplatform.github.io/kubeflow-gke-docs. Before contributing, please read these guidelines.
Running locally
-
This website is being generated with Hugo, a popular open-source static site generator. You will need to install the
extended
version of Hugo to be able to generate a website locally.You can install Hugo using
brew
:brew install hugo
Alternatively, you can also use
snap
:snap install hugo --channel=extended
Check the official documentation on other installation options. See more details on how to deploy GitHub pages static website using Hugo.
-
We use Docsy theme, which has its prerequisites.
npm install --save-dev autoprefixer npm install --save-dev postcss-cli npm install -D postcss
If you don't have
npm
, install it using:sudo apt-get install npm
-
To run the website locally:
hugo server
Contributing
See CONTRIBUTING.md.
Releasing a new version
See RELEASE.md.