Creating and updating the Kubeflow docs

Welcome to the GitHub repository for Kubeflow's public website. The docs are hosted at https://www.kubeflow.org.

We use Hugo to format and generate our website, the Docsy theme for styling and site structure, and Netlify to manage the deployment of the site. Hugo is an open-source static site generator that provides us with templates, content organization in a standard directory structure, and a website generation engine. You write the pages in Markdown, and Hugo wraps them up into a website.

Quickstart

Here's a quick guide to updating the docs. It assumes you're familiar with the GitHub workflow and you're happy to use the automated preview of your doc updates:

1. Fork the kubeflow/website repo on GitHub.
2. Make your changes and send a pull request (PR).
3. If you're not yet ready for a review, add "WIP" to the PR name to indicate it's a work in progress. Alternatively, you can also add /hold in a comment to mark the PR as not ready for merge. (Don't add the Hugo property "draft = true" to the page front matter, because that prevents the auto-deployment of the content preview described in the next point.) See the Prow guide for help with the commands that you can use in a PR comment.
4. Wait for the automated PR workflow to do some checks. When it's ready, you should see a comment like this: deploy/netlify — Deploy preview ready!
5. Click Details to the right of "Deploy preview ready" to see a preview of your updates.
6. Continue updating your doc and pushing your changes until you're happy with the content.
7. When you're ready for a review, add a comment to the PR, remove any holds or "WIP" markers, and assign a reviewer/approver. See the Kubeflow contributor guide.

If you need help with the GitHub workflow, take a look at the quick guide near the bottom of this page.

Previewing your changes on a local website server

If you'd like to preview your doc updates as you work, you can install Hugo and run a local server to host your website. This section shows you how.

Install Hugo and other dependencies

The Kubeflow website uses the Docsy theme, which requires that you have Hugo version 0.45 or later, and it must be the extended version of Hugo.

To get the extended version of Hugo:

1. Go to the Hugo releases.
2. In the most recent release, scroll down until you find a list of extended versions.
3. Download the relevant file for your operating system.
4. Unzip the downloaded file into a location of your choice.

For example, to install Hugo on Linux:

1. Download hugo_extended_0.53_Linux-64bit.tar.gz (or the latest version).

2. Create a new directory:

   mkdir $HOME/hugo
   

3. Extract the file you downloaded to $HOME/hugo.

   tar -zxvf hugo_extended_0.53_Linux-64bit.tar.gz
   

For more details about installing Hugo, See the Hugo installation guide.

If you plan to make changes to the site styling, you need to install some CSS libraries as well. Follow the instructions in the Docsy theme's setup guide.

Fork and clone the website repo and run a local website server

Follow the usual GitHub workflow to fork the repo on GitHub and clone it to your local machine, then use your local repo as input to your Hugo web server:

1. Fork the kubeflow/website repo in the GitHub UI.

2. Clone your fork locally. This example uses SSH cloning:

   mkdir kubeflow
   cd kubeflow/
   git clone [email protected]:<your-github-username>/website.git
   cd website/
   

3. Start your website server. Make sure you run this command from the /website/ directory, so that Hugo can find the config files it needs:

   hugo server -D
   

4. You can access your website at http://localhost:1313/.

5. Continue with the usual GitHub workflow to edit files, commit them, push the changes up to your fork, and create a pull request. (There's some help with the GitHub workflow near the bottom of this page.)

6. While making the changes, you can preview them on your local version of the website at http://localhost:1313/. Note that if you have more than one local git branch, when you switch between git branches the local website reflects the files in the current branch.

Useful docs:

• User guide for the Docsy theme
• Hugo installation guide
• Hugo basic usage
• Hugo site directory structure
• hugo server reference

Menu structure

The site theme has one Hugo menu (main), which defines the top navigation bar. You can find and adjust the definition of the menu in the site configuration file.

The left-hand navigation panel is defined by the directory structure under the docs directory.

A weight property in the front matter of each page determines the position of the page relative to the others in the same directory. The lower the weight, the earlier the page appears in the section. A weight of 1 appears before a a weight of 2, and so on. For example, see the front matter of the requirements page in the guides section. The page front matter looks like this:

+++
title = "Requirements"
description = "Requirements for Kubeflow"
weight = 1
+++

Working with the theme

The theme files are in the themes/docsy directory. Do not change these files, because they are overwritten each time we update the website to a later version of the theme, and your changes will be lost.

Documentation style guide

For guidance on writing effective documentation, see the style guide for the Kubeflow docs.

Styling your content

The theme holds its styles in the assets/scss directory. Do not change these files, because they are overwritten each time we update the website to a later version of the theme, and your changes will be lost.

You can override the default styles and add new ones:

• In general, put your files in the project directory structure under website rather than in the theme directory. Use the same file name as the theme does, and put the file in the same relative position. Hugo looks first at the file in the main project directories, if present, then at the files under the theme directory. For example, the Kubeflow website's layouts/partials/navbar.html overrides the theme's layouts/partials/navbar.html.
• You can update the Kubeflow website's project variables in the _variables_project.scss file. Values in that file override the Docsy variables. You can also use _variables_project.scss to specify your own values for any of the default Bootstrap 4 variables.

Styling of images:

• To see some examples of styled images, take a look at the OAuth setup page in the Kubeflow docs. Search for .png in the page source.
• For more help, see the guide to Bootstrap image styling.
• Also see the Bootstrap utilities, such as borders.

The site's front page:

• See the page source.
• The CSS styles are in the project variables file.
• The page uses the cover block defined by the theme.
• The page also uses the linkdown block.

Using Hugo shortcodes

Sometimes it's useful to define a snippet of information in one place and reuse it wherever we need it. For example, we want to be able to refer to the minimum version of various frameworks/libraries throughout the docs, without causing a maintenance nightmare.

For this purpose, we use Hugo's "shortcodes". Shortcodes are similar to Django variables. You define a shortcode in a file, then use a specific markup to invoke the shortcode in the docs. That markup is replaced by the content of the shortcode file when the page is built.

To create a shortcode:

1. Add an HTML file in the /website/themes/kf/layouts/shortcodes/ directory. The file name must be short and meaningful, as it determines the shortcode you and others use in the docs.

2. For the file content, add the text and HTML markup that should replace the shortcode markup when the web page is built.

To use a shortcode in a document, wrap the name of the shortcode in braces and percent signs like this:

{{% shortcode-name %}}

The shortcode name is the file name minus the .html file extension.

Example: The following shortcode defines the minimum required version of Kubernetes:

• File name of the shortcode:

  kubernetes-min-version.html
  

• Content of the shortcode:

  1.8
  

• Usage in a document:

  You need Kubernetes version {{% kubernetes-min-version %}} or later.
  

Useful Hugo docs:

• Shortcode templates
• Shortcodes

Versioning of the docs

For each stable release, we create a new branch for the relevant documentation. For example, the documentation for the v0.2 stable release is maintained in the v0.2-branch. Each branch has a corresponding Netlify website that automatically syncs each merged PR.

The versioned sites follow this convention:

• www.kubeflow.org always points to the current master branch
• master.kubeflow.org always points to GitHub head
• vXXX-YYY.kubeflow.org points to the release at vXXX.YYY-branch

We also hook up each version to the dropdown on the website menu bar. To update the website to a new version, edit config.toml as follows:

1. Add a params.versions entry. For example, to add v0.5, add this entry:

   [[params.versions]]
     version = "v0.5"
     githubbranch = "v0.5-branch"
     url = "https://v0-5.kubeflow.org"
   

2. Update the version number in the text for the master version on two lines. For example, to update to v0.5, the text on both lines should be:

   version = "master (v0.5)"
   

Whenever any documents reference any source code, you should use the version shortcode in the links, like so:

https://github.com/kubeflow/kubeflow/blob/{{< params "githubbranch" >}}/scripts/gke/deploy.sh

This ensures that all the links in a versioned webpage point to the correct branch.

Quick guide to working with a GitHub repo

Here's a quick guide to a fairly standard GitHub workflow. This section is handy for people who don't use git or GitHub often, and just need a quick guide to get going:

1. Fork the kubeflow/website repo:

   • Go to the kubeflow/website repo on GitHub.
   • Click Fork to make your own copy of the repo. GitHub creates a copy at https://github.com/<your-github-username>/website.

2. Open a command window on your local machine.

3. Clone your forked repo, to copy the files down to your local machine. This example creates a directory called kubeflow and uses SSH cloning to download the files:

   mkdir kubeflow
   cd kubeflow/
   git clone [email protected]:<your-github-username>/website.git
   cd website/
   

4. Add the upstream repo as a git remote repo:

   git remote add upstream https://github.com/kubeflow/website.git
   

5. Check your remotes:

   git remote -vv
   

   You should have 2 remote repos:

   • origin - points to your own fork of the repo on gitHub - that is, the one you cloned my local repo from.
   • upstream - points to the actual repo on gitHub.

6. Create a branch. In this example, replace doc-updates with any branch name you like. Choose a branch name that helps you recognise the updates you plan to make in that branch:

   git checkout -b doc-updates
   

7. Add and edit the files as you like. The doc pages are in the /website/content/docs/ directory.

8. Run git status at any time, to check the status of your local files. Git tells you which files need adding or committing to your local repo.

9. Commit your updated files to your local git repo. Example commit:

   git commit -a -m "Fixed some doc errors."
   

   Or:

   git add add-this-doc.md
   git commit -a -m "Added a shiny new doc."
   

10. Push from your branch (for example, doc-updates) to the relevant branch on your fork on GitHub:

    git checkout doc-updates
    git push origin doc-updates
    

11. When you're ready to start the review process, create a pull request (PR) in the branch on your fork on the GitHub UI, based on the above push. The PR is auto-sent to the upstream repo - that is, the one you forked from.

12. If you need to make changes to the files in your PR, continue making them locally in the same branch, then push them again in the same way. GitHub automatically sends them through to the same PR on the upstream repo!

13. Hint: If you're authenticating to GitHub via SSH, use ssh-add to add your SSH key passphrase to the managing agent, so that you don't have to keep authenticating to GitHub. You need to do this again after every reboot.