Skip to content

Template for a tutorial

Sarah Maddox edited this page Jun 14, 2019 · 1 revision
+++
title = "My Title for This Page"
description = "My subtitle for this page"
weight = 10
+++

TODO: Add an introductory paragraph. For example: 
This guide walks you through an end-to-end example of Kubeflow on Google
Cloud Platform (GCP). By working through the guide, you'll learn
how to deploy Kubeflow on Kubernetes Engine (GKE), train an MNIST machine
learning model for image classification, and use the model for online inference
(also known as online prediction).

## Introductions

TODO: Add any introductory material, such as overviews of the platform (GCP/AWS/etc)
and the ML model this tutorial uses.

## Set up your environment

TODO: Add setup instructions.

## TODO: Add appropriate section title

TODO: Add a section for each part of the tutorial. 
Within each part, start with an introductory sentence. 
Then use a numbered list for the steps to follow. For example:

To deploy your code to Kubernetes, you must first build your local project into
a Docker container image and push the image to
Container Registry so that it's available in the cloud.

1. Create a version tag from the current UNIX timestamp, to be associated with
   your model each time it runs:

    ```
    export VERSION_TAG=$(date +%s)
    ```

1. Set the path in Container Registry that you want to push the image to:

    ```
    export TRAIN_IMG_PATH=gcr.io/${PROJECT}/${DEPLOYMENT_NAME}-train:${VERSION_TAG}
    ```

1. And so on...

## Clean up your environment

TODO: If necessary, tell the reader which steps they must follow to delete your deployment and related resources.

## Next steps

TODO: Suggest some followup guides. Otherwise, readers come to the end of a page and don't know what to do next.
For example (GCP):

* Run a full ML workflow on Kubeflow, using the
  [end-to-end MNIST tutorial](/docs/gke/gcp-e2e/) or the
  [GitHub issue summarization 
  example](https://github.com/kubeflow/examples/tree/master/github_issue_summarization).
* See how to [customize](/docs/gke/customizing-gke) your Kubeflow 
  deployment.
* [Troubleshoot](/docs/gke/troubleshooting-gke) any issues you may
  find.