Commit 4c78a871 authored by DJ Mountney's avatar DJ Mountney
Browse files

Add a bit more information to the Readme

Fix the codeblock html output by using proper input and highlighting
libs

Once the docs are updated on docs.gitlab, I think we should basically
just have the Usage section point to the docs
parent 09bb29ea
......@@ -18,7 +18,7 @@ pages:
- helm lint charts/*
- mkdir -p public
- bundle install --jobs 4 --path vendor
- bundle exec kramdown --template document README.md > public/index.html
- bundle exec kramdown --input GFM --template document --syntax-highlighter rouge README.md > public/index.html
- for chart in charts/*; do helm dep up $chart; done
- (cd public; helm package ../charts/*)
- helm repo index public --url https://charts.gitlab.io
......
source 'https://rubygems.org'
gem 'kramdown', '~> 1.13.0'
gem 'rouge', '~> 2.0.0'
......@@ -2,12 +2,14 @@ GEM
remote: https://rubygems.org/
specs:
kramdown (1.13.2)
rouge (2.0.7)
PLATFORMS
ruby
DEPENDENCIES
kramdown (~> 1.13.0)
rouge (~> 2.0.0)
BUNDLED WITH
1.12.5
## GitLab Helm Charts
This repo is a collection of help charts (currently just `gitlab-ce` and `gitlab-runner`).
This repo is a collection of GitLab Helm charts
The repo automatically publishes to our chart repo, [charts.gitlab.io](https://charts.gitlab.io) via GitLab Pages.
To use the charts, the Helm tool must be installed and initialized. The best
place to start is by reviewing the [Helm Quick Start Guide](https://github.com/kubernetes/helm/blob/master/docs/quickstart.md).
### Usage
Add GitLab Chart Repo:
......@@ -16,3 +19,13 @@ Then you can install charts using the `gitlab` repo:
```bash
$ helm install gitlab/gitlab
```
The charts currently available to install can be found here: <https://gitlab.com/charts/charts.gitlab.io/tree/master/charts>
### GitLab Helm Charts Issue Tracker
Issues related to the Charts can be logged at: <https://gitlab.com/charts/charts.gitlab.io/issues>
### Contributing to the Charts
We welcome contributions and improvements. The source repo for our Helm Charts can be found here: <https://gitlab.com/charts/charts.gitlab.io>
Supports Markdown
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