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.

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

wants to merge 3 commits into from

Conversation

AlannaBurke
Copy link

Updating Helm Charts repo readme.
I think this one is okay being a little slimmer, thoughts?

I would like to update the project description, though.

README.md Outdated Show resolved Hide resolved
Alanna Burke and others added 2 commits March 31, 2022 18:56
Co-authored-by: Toby Bellwood <toby.bellwood@amazee.io>
@@ -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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants