Docs

Information on the Kubeflow docs and how to contribute to them

Welcome to the Kubeflow documentation!

Introduction

The Kubeflow docs are published at www.kubeflow.org.

The source for the docs is in the kubeflow/website repo on GitHub. We use Hugo to format and generate our website, and Netlify to manage the deployment of the site.

Versioning

www.kubeflow.org points to the master branch of the docs. You can access other versions by clicking the version dropdown at top right of the website menu bar:

Version dropdown

We create a new branch of the docs for each stable release of Kubeflow. For example, the docs for the v0.2 stable release are on published on the v0.2 website, which corresponds to the v0.2-branch on GitHub.

Contributing to the docs

We welcome updates to the docs! Please help us make them better. Small fixes, typos, bug fixes, plugging gaps—all are useful.

  • For help with getting started, take a look at the README.
  • For guidance on writing effective documentation, see the style guide.