9. Start a README#

Many great projects are documented in the README.md file in the root of a GitHub repository. Knowing how to read and write a README.md file is a great asset. To complete this milestone you will update the README.md file by adding information about each of the settings in your application and how to launch it on a Kubernetes cluster.

Writing Markdown#

The .md is for Markdown. Markdown is an easy to use text-based way to write richly formatted documents. Markdown lets you write great documents for the web without needing any proprietary software.

In Markdown you make a table like this:

| Header | Header | Header |
| --- | --- | --- | 
| Body1 | Body2 | Body3 | 
| More | More | More |

and the table becomes:

Header

Header

Header

Body1

Body2

Body3

More

More

More

You can see a complete set of examples on GitHub.

Required Documentation#

Your README.md file should have the following information:

  1. Documentation of all of the environment variables in your config.yaml and secret.yaml files in a table. The table should have the these columns:

    1. Variable Name

    2. Default Value (from your Dockerfile)

    3. Short description

  2. Step by step instructions for how to deploy your application on a Kubernetes cluster. You don’t need to provide instructions on how to setup a Kubernetes cluster or how to check out your code with git.

  3. Step by step instructions for how to delete your application.

Submit#

A link to your repository. There’s no need to make a release. Review two other student’s documentation and give them feedback.