Commit 9e060b04 authored by Matt Butcher's avatar Matt Butcher

docs(*): fixed minor issues with the docs.

parent b98d3488
...@@ -44,6 +44,13 @@ If you are familiar with the Chart.yaml file format for Helm Classic, you will ...@@ -44,6 +44,13 @@ If you are familiar with the Chart.yaml file format for Helm Classic, you will
notice that fields specifying dependencies have been removed. That is because notice that fields specifying dependencies have been removed. That is because
the new Chart format expresses dependencies using the `charts/` directory. the new Chart format expresses dependencies using the `charts/` directory.
### Charts and Versioning
Every chart must have a version number. A version must follow the
[SemVer 2](http://semver.org/) standard. Unlike Helm Classic, Kubernetes
Helm uses version numbers as release markers. Packages in repositories
are identified by name plus version.
## Chart Dependencies ## Chart Dependencies
In Helm, one chart may depend on any number of other charts. These In Helm, one chart may depend on any number of other charts. These
...@@ -71,10 +78,14 @@ The example above shows how the Wordpress chart expresses its dependency ...@@ -71,10 +78,14 @@ The example above shows how the Wordpress chart expresses its dependency
on Apache and MySQL by including those charts inside of its `charts/` on Apache and MySQL by including those charts inside of its `charts/`
directory. directory.
**TIP:** _To drop a dependency into your `charts/` directory, use the
`helm fetch` command._
## Templates and Values ## Templates and Values
In Helm Charts, templates are written in the Go template language, with the In Helm Charts, templates are written in the Go template language, with the
addition of 50 or so add-on template functions. addition of 50 or so [add-on template
functions](https://github.com/Masterminds/sprig).
All template files are stored in a chart's `templates/` folder. When All template files are stored in a chart's `templates/` folder. When
Helm renders the charts, it will pass every file in that directory Helm renders the charts, it will pass every file in that directory
......
...@@ -33,7 +33,7 @@ To run Helm and Tiller locally, you can run `bin/helm` or `bin/tiller`. ...@@ -33,7 +33,7 @@ To run Helm and Tiller locally, you can run `bin/helm` or `bin/tiller`.
## gRPC and Protobuf ## gRPC and Protobuf
Tiller uses gRPC. To get started with gRPC, you will need to... Helm and Tiller communicate using gRPC. To get started with gRPC, you will need to...
- Install `protoc` for compiling protobuf files. Releases are - Install `protoc` for compiling protobuf files. Releases are
[here](https://github.com/google/protobuf/releases) [here](https://github.com/google/protobuf/releases)
...@@ -67,6 +67,10 @@ remains consistent, and (c) contributions follow the open source legal ...@@ -67,6 +67,10 @@ remains consistent, and (c) contributions follow the open source legal
requirements. Our intent is not to burden contributors, but to build requirements. Our intent is not to burden contributors, but to build
elegant and high-quality open source code so that our users will benefit. elegant and high-quality open source code so that our users will benefit.
Make sure you have read and understood the main CONTRIBUTING guide:
https://github.com/kubernetes/helm/blob/master/CONTRIBUTING.md
We follow the coding standards and guidelines outlined by the Deis We follow the coding standards and guidelines outlined by the Deis
project: project:
......
...@@ -29,10 +29,10 @@ $ helm init ...@@ -29,10 +29,10 @@ $ helm init
To install an existing chart, you can run the `helm install` command: To install an existing chart, you can run the `helm install` command:
_TODO:_ Update this to the correct URL. _TODO:_ Might need instructions about repos.
```console ```console
$ helm install https://helm.sh/charts/nginx-0.1.0.tgz $ helm install nginx-1.0.0
Released smiling-penguin Released smiling-penguin
``` ```
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment