From df8aa7db70f56bfa56eed914dfc624f91c27e32f Mon Sep 17 00:00:00 2001 From: Michelle Noorali Date: Tue, 1 Mar 2016 17:23:02 -0700 Subject: [PATCH 1/2] chore(docs): add a getting started guide --- docs/usage_docs/getting-started-guide.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/usage_docs/getting-started-guide.md diff --git a/docs/usage_docs/getting-started-guide.md b/docs/usage_docs/getting-started-guide.md new file mode 100644 index 000000000..7ef4d6534 --- /dev/null +++ b/docs/usage_docs/getting-started-guide.md @@ -0,0 +1,22 @@ +#Under Construction + +#Getting Started Guide + +[Helm](https://helm.sh) helps you find and use software built for Kubernetes. With a few Helm commands you can quickly and easily deploy software packages like: + +- Postgres +- etcd +- HAProxy +- redis + +All of the Helm charts live at [github.com/kubernetes/charts](https://github.com/kubernetes/charts). If you want to make your own charts we have a guide for [authoring charts](authoring_charts.md). Charts should follow the defined [chart format](/docs/deisgn/chart_format.md). + +Get started with the following steps: + +1. [Clone](github.com/kubernetes/helm) this project. + +2. Then, run `make build`. This will install all the binaries you need in `bin/` in the root of the directory. + +3. To start playing with helm, run `./bin/helm` + +4. `helm dm install` to install the server side component. From c06dd37aaa99df76fe2493f653a7f9c9467c7709 Mon Sep 17 00:00:00 2001 From: Michelle Noorali Date: Tue, 1 Mar 2016 18:20:08 -0700 Subject: [PATCH 2/2] ref(*): fix spelling error and links * Also, make step 3 clearer --- docs/usage_docs/authoring_charts.md | 1 + docs/usage_docs/getting-started-guide.md | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) create mode 100644 docs/usage_docs/authoring_charts.md diff --git a/docs/usage_docs/authoring_charts.md b/docs/usage_docs/authoring_charts.md new file mode 100644 index 000000000..1f52b5cac --- /dev/null +++ b/docs/usage_docs/authoring_charts.md @@ -0,0 +1 @@ +#Coming Soon diff --git a/docs/usage_docs/getting-started-guide.md b/docs/usage_docs/getting-started-guide.md index 7ef4d6534..24f0b43a6 100644 --- a/docs/usage_docs/getting-started-guide.md +++ b/docs/usage_docs/getting-started-guide.md @@ -9,7 +9,7 @@ - HAProxy - redis -All of the Helm charts live at [github.com/kubernetes/charts](https://github.com/kubernetes/charts). If you want to make your own charts we have a guide for [authoring charts](authoring_charts.md). Charts should follow the defined [chart format](/docs/deisgn/chart_format.md). +All of the Helm charts live at [github.com/kubernetes/charts](https://github.com/kubernetes/charts). If you want to make your own charts we have a guide for [authoring charts](authoring_charts.md). Charts should follow the defined [chart format](/docs/design/chart_format.md). Get started with the following steps: @@ -17,6 +17,6 @@ Get started with the following steps: 2. Then, run `make build`. This will install all the binaries you need in `bin/` in the root of the directory. -3. To start playing with helm, run `./bin/helm` +3. To see a list of helm commands, run `./bin/helm` 4. `helm dm install` to install the server side component.