Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #413

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update README.md #413

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f8122d9
Update README.md
Mar 28, 2022
1cf61f8
Update README.md
Mar 31, 2022
27731ba
Merge branch 'main' into readme-update
Mar 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 23 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,32 @@

This repository contains [Helm](https://helm.sh/) charts related to [Lagoon](https://github.com/amazeeio/lagoon/).

## Table of Contents
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Github auto-generates a TOC (although it's a bit hidden). This one being in-line is more discoverable, but does it duplicate the existing functionality?
https://github.blog/changelog/2021-04-13-table-of-contents-support-in-markdown-files/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tobybellwood / @AlannaBurke any thoughts on this?

1. Project Description
2. Usage
3. Tips & Tricks
4. Contribution

## Project Description
This repository provides the helm charts needed to install the various Lagoon components. It hosts the chart configurations and the chart repository itself (via GitHub pages)

## Usage

See [here](https://uselagoon.github.io/lagoon-charts/).
`helm repo add lagoon https://uselagoon.github.io/lagoon-charts/`

See individual chart directories for READMEs and usage instructions.


## Tips & Tricks

### Run chart-testing (lint) locally

```
$ docker run --rm --interactive --detach --network host --name ct "--volume=$(pwd):/workdir" "--workdir=/workdir" --volume=$(pwd)/default.ct.yaml:/etc/ct/ct.yaml quay.io/helmpack/chart-testing:latest cat
$ docker exec ct ct lint
```

## Contribute
## Contribution

Branch/fork and add/edit a chart in the `charts/` directory.
When you create a PR your change will be automatically linted and tested.
Expand Down Expand Up @@ -37,12 +58,3 @@ Please ensure that any new chart:
The CI runs in a [constrained environment](https://docs.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners#supported-runners-and-hardware-resources) which makes it a good place to test how your chart handles slow-starting pods.
Ideally pods should never be killed due to failing probes during chart-install, even if they do eventually start and the chart installation succeeds.
Documentation on probes for pod startup is [here](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes).

## Development tips

### Run chart-testing (lint) locally

```
$ docker run --rm --interactive --detach --network host --name ct "--volume=$(pwd):/workdir" "--workdir=/workdir" --volume=$(pwd)/default.ct.yaml:/etc/ct/ct.yaml quay.io/helmpack/chart-testing:latest cat
$ docker exec ct ct lint
```