Docs

Information on the Kubeflow docs and how to contribute to them

Welcome to the Kubeflow documentation!

Introduction

The Kubeflow docs are published atwww.kubeflow.org.

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

Versioning

www.kubeflow.org points to the master branch of the docs. You can accessother versions by clicking the version dropdown at top right of the websitemenu 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 thev0.2 website, whichcorresponds to thev0.2-branch onGitHub.

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 theREADME.
  • For guidance on writing effective documentation, see thestyle guide.

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Last modified 16.05.2019: Adds a style guide for the Kubeflow docs (#696) (351a4080)