Skip to content

Commit

Permalink
docs: fix markdownlint errors
Browse files Browse the repository at this point in the history
Fixed all errors `markdownlint` threw like using emphasis as headings, not specifying code block languages, etc.
  • Loading branch information
mvprowess committed Jun 26, 2024
1 parent def07a1 commit edaf332
Show file tree
Hide file tree
Showing 12 changed files with 60 additions and 63 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,25 @@
[![CI Status](https://github.com/fmjstudios/helm/actions/workflows/release.yaml/badge.svg)](https://github.com/fmjstudios/helm/blob/main/.github/workflows/ci-pipeline.yml)
[![Renovate](https://img.shields.io/badge/Renovate-enabled-brightgreen?logo=renovatebot&logoColor=1DDEDD)](https://renovatebot.com/)

A collection of open-source [MIT][license]-licensed _Helm Charts_ written and maintained by `FMJ Studios` for use
with [Kubernetes][kubernetes] `v1.26` and above. Have a look [at the table below](#-overview) to get a list of the
included charts, their versions and the default container images. This repository relies on the _GNU Make_ build
system. The [`Makefile`](Makefile) also includes `targets` to set up the development environment. Refer to
the [CONTRIBUTING.md](docs/CONTRIBUTING.md) for more information.
A collection of open-source [MIT][license]-licensed [_Helm Charts_][helm] written and maintained by `FMJ Studios` for
use with [Kubernetes][kubernetes] `v1.26` and above. Have a look [at the table below](#-overview) to get a list of the
included charts, their versions and the default container images. The charts are also published
to [ArtifactHub][artifacthub], where they can be found in
the [`fmjstudios`](https://artifacthub.io/packages/search?repo=fmjstudios&sort=relevance) repository. This GitHub
repository relies on the _GNU Make_ build system to ease the development workflows. The [`Makefile`](Makefile) also
includes `targets` to set up the development environment. Refer to the [CONTRIBUTING.md](docs/CONTRIBUTING.md) for more
information.

## ✨ TL;DR

_Repository-based installation_
### Helm Repository Installation

```shell
helm repo add fmjstudios https://fmjstudios.github.io/helm
helm install <RELEASE_NAME> fmjstudios/<CHART_NAME>
```

_OCI-Registry-based installation_
### OCI Installation

```shell
helm install oci://ghcr.io/fmjstudios/helm/<CHART_NAME>:<VERSION>
Expand Down Expand Up @@ -76,8 +79,6 @@ contact details to reach out directly.

[license]: LICENSE

[makefile]: Makefile

<!-- General links -->

[kubernetes]: https://kubernetes.io
Expand Down
8 changes: 4 additions & 4 deletions charts/cachet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ on [Docker Hub](https://hub.docker.com/r/cachethq/docker/).
## ✨ TL;DR

__Helm Repository Installation__
### Helm Repository Installation

```shell
helm repo add fmjstudios https://fmjstudios.github.io/helm
helm install cachet fmjstudios/cachet --version 0.1.3
helm install cachet fmjstudios/cachet --version X.Y.Z
```

__OCI Installation__
### OCI Installation

```shell
helm install oci://ghcr.io/fmjstudios/helm/cachet:0.1.3
helm install oci://ghcr.io/fmjstudios/helm/cachet:X.Y.Z
```

## Introduction
Expand Down
8 changes: 4 additions & 4 deletions charts/gotenberg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@ on [Docker Hub](https://hub.docker.com/r/gotenberg/gotenberg).
## ✨ TL;DR

__Helm Repository Installation__
### Helm Repository Installation

```shell
helm repo add fmjstudios https://fmjstudios.github.io/helm
helm install gotenberg fmjstudios/gotenberg --version 0.1.3
helm install gotenberg fmjstudios/gotenberg --version X.Y.Z
```

__OCI Installation__
### OCI Installation

```shell
helm install oci://ghcr.io/fmjstudios/helm/gotenberg:0.1.3
helm install oci://ghcr.io/fmjstudios/helm/gotenberg:X.Y.Z
```

## Introduction
Expand Down
16 changes: 8 additions & 8 deletions charts/kubenav/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ through our [contribution guidelines](https://github.com/kubenav/kubenav/blob/ma
## ✨ TL;DR

__Helm Repository Installation__
### Helm Repository Installation

```shell
helm repo add fmjstudios https://fmjstudios.github.io/helm
helm install kubenav fmjstudios/kubenav --version 0.1.0
helm install kubenav fmjstudios/kubenav --version X.Y.Z
```

__OCI Installation__
### OCI Installation

```shell
helm install oci://ghcr.io/fmjstudios/helm/kubenav:0.1.0
helm install oci://ghcr.io/fmjstudios/helm/kubenav:X.Y.Z
```

## Introduction
Expand All @@ -40,28 +40,28 @@ and [ClusterRoleBinding](https://kubernetes.io/docs/reference/kubernetes-api/aut
### Name overrides

| Name | Description | Value |
| ------------------ | ----------------------------------------------- | ----- |
|--------------------|-------------------------------------------------|-------|
| `nameOverride` | String to partially override linkstack.fullname | `""` |
| `fullnameOverride` | String to fully override linkstack.fullname | `""` |

### Secret parameters

| Name | Description | Value |
| -------------------- | -------------------------------------------------- | ----- |
|----------------------|----------------------------------------------------|-------|
| `secret.annotations` | Annotations for the `service-account-token` Secret | `{}` |
| `secret.labels` | Labels for the `service-account-token` Secret | `{}` |

### RBAC parameters

| Name | Description | Value |
| ------------- | -------------------------------- | ------ |
|---------------|----------------------------------|--------|
| `rbac.create` | Whether to create RBAC resources | `true` |
| `rbac.rules` | Extra rules to add to the Role | `[]` |

### Service Account parameters

| Name | Description | Value |
| ---------------------------- | ------------------------------------------------------------------------- | ------- |
|------------------------------|---------------------------------------------------------------------------|---------|
| `serviceAccount.create` | Whether a service account should be created | `true` |
| `serviceAccount.automount` | Whether to automount the service account token | `false` |
| `serviceAccount.annotations` | Annotations to add to the service account | `{}` |
Expand Down
8 changes: 4 additions & 4 deletions charts/linkstack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ Docker image available on [Docker Hub](https://hub.docker.com/r/linkstackorg/lin
## ✨ TL;DR

__Helm Repository Installation__
### Helm Repository Installation

```shell
helm repo add fmjstudios https://fmjstudios.github.io/helm
helm install linkstack fmjstudios/linkstack --version 0.1.3
helm install linkstack fmjstudios/linkstack --version X.Y.Z
```

__OCI Installation__
### OCI Installation

```shell
helm install oci://ghcr.io/fmjstudios/helm/linkstack:0.1.3
helm install oci://ghcr.io/fmjstudios/helm/linkstack:X.Y.Z
```

## Introduction
Expand Down
8 changes: 4 additions & 4 deletions charts/linkwarden/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ the [GitHub Container Registry](https://github.com/linkwarden/linkwarden/pkgs/co
## ✨ TL;DR

__Helm Repository Installation__
### Helm Repository Installation

```shell
helm repo add fmjstudios https://fmjstudios.github.io/helm
helm install linkwarden fmjstudios/linkwarden --version 0.1.3
helm install linkwarden fmjstudios/linkwarden --version X.Y.Z
```

__OCI Installation__
### OCI Installation

```shell
helm install oci://ghcr.io/fmjstudios/helm/linkwarden:0.1.3
helm install oci://ghcr.io/fmjstudios/helm/linkwarden:X.Y.Z
```

## Introduction
Expand Down
8 changes: 4 additions & 4 deletions charts/ntfy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ on [Docker Hub](https://hub.docker.com/r/binwiederhier/ntfy).
## ✨ TL;DR

__Helm Repository Installation__
### Helm Repository Installation

```shell
helm repo add fmjstudios https://fmjstudios.github.io/helm
helm install ntfy fmjstudios/ntfy --version 0.1.3
helm install ntfy fmjstudios/ntfy --version X.Y.Z
```

__OCI Installation__
### OCI Installation

```shell
helm install oci://ghcr.io/fmjstudios/helm/ntfy:0.1.3
helm install oci://ghcr.io/fmjstudios/helm/ntfy:X.Y.Z
```

## Introduction
Expand Down
8 changes: 4 additions & 4 deletions charts/paperless-ngx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ on [GitHub Container Registry](https://github.com/paperless-ngx/paperless-ngx/pk
## ✨ TL;DR

__Helm Repository Installation__
### Helm Repository Installation

```shell
helm repo add fmjstudios https://fmjstudios.github.io/helm
helm install paperless-ngx fmjstudios/paperless-ngx --version 0.1.3
helm install paperless-ngx fmjstudios/paperless-ngx --version X.Y.Z
```

__OCI Installation__
### OCI Installation

```shell
helm install oci://ghcr.io/fmjstudios/helm/paperless-ngx:0.1.3
helm install oci://ghcr.io/fmjstudios/helm/paperless-ngx:X.Y.Z
```

## Introduction
Expand Down
8 changes: 4 additions & 4 deletions charts/uptime-kuma/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@ on [Docker Hub](https://hub.docker.com/r/louislam/uptime-kuma).
## ✨ TL;DR

__Helm Repository Installation__
### Helm Repository Installation

```shell
helm repo add fmjstudios https://fmjstudios.github.io/helm
helm install uptime-kuma fmjstudios/uptime-kuma --version 0.1.3
helm install uptime-kuma fmjstudios/uptime-kuma --version X.Y.Z
```

__OCI Installation__
### OCI Installation

```shell
helm install oci://ghcr.io/fmjstudios/helm/uptime-kuma:0.1.3
helm install oci://ghcr.io/fmjstudios/helm/uptime-kuma:X.Y.Z
```

## Introduction
Expand Down
8 changes: 4 additions & 4 deletions charts/vaultwarden/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ on [Docker Hub](https://hub.docker.com/r/vaultwarden/server).
## ✨ TL;DR

__Helm Repository Installation__
### Helm Repository Installation

```shell
helm repo add fmjstudios https://fmjstudios.github.io/helm
helm install vaultwarden fmjstudios/vaultwarden --version 0.1.3
helm install vaultwarden fmjstudios/vaultwarden --version X.Y.Z
```

__OCI Installation__
### OCI Installation

```shell
helm install oci://ghcr.io/fmjstudios/helm/vaultwarden:0.1.3
helm install oci://ghcr.io/fmjstudios/helm/vaultwarden:X.Y.Z
```

## Introduction
Expand Down
18 changes: 9 additions & 9 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ This format leads to **easier to read commit history**.

Each commit message consists of a **header**, a **body**, and a **footer**.

```
```text
<header>
<BLANK LINE>
<body>
Expand All @@ -99,9 +99,9 @@ the [Commit Message Body](#commit-body) format.
The `footer` is optional. The [Commit Message Footer](#commit-footer) format describes what the footer is used for and
the structure it must have.

#### <a name="commit-header"></a>Commit Message Header
### <a name="commit-header"></a>Commit Message Header

```
```text
<type>(<scope>): <short summary>
│ │ │
│ │ └─⫸ Summary in present tense. Not capitalized. No period at the end.
Expand All @@ -113,7 +113,7 @@ the structure it must have.

The `<type>` and `<summary>` fields are mandatory, the `(<scope>)` field is optional.

##### Type
#### Type

Must be one of the following:

Expand All @@ -126,7 +126,7 @@ Must be one of the following:
* **build**: Changes or improvements to the build system or to the projects dependencies (_supported Scopes_: `make`)
* **ci**: Changes to CI configuration files and scripts (_supported Scopes_: `actions`)

##### Scopes
#### Scopes

The following is the list of supported scopes:

Expand All @@ -137,7 +137,7 @@ The following is the list of supported scopes:
* `scripts` - Changes to scripts
* `config` - Changes to configuration files

##### Summary
#### Summary

Use the summary field to provide a succinct description of the change:

Expand All @@ -160,7 +160,7 @@ The footer can contain information about breaking changes and deprecations and i
issues, Jira tickets, and other PRs that this commit closes or is related to.
For example:

```
```text
BREAKING CHANGE: <breaking change summary>
<BLANK LINE>
<breaking change description + migration instructions>
Expand All @@ -171,7 +171,7 @@ Fixes #<issue number>

or

```
```text
DEPRECATED: <what is deprecated>
<BLANK LINE>
<deprecation description + recommended update path>
Expand All @@ -186,7 +186,7 @@ blank line, and a detailed description of the breaking change that also includes
Similarly, a Deprecation section should start with "DEPRECATED: " followed by a short description of what is deprecated,
a blank line, and a detailed description of the deprecation that also mentions the recommended update path.

### Revert commits
#### Revert commits

If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit.

Expand Down
6 changes: 1 addition & 5 deletions docs/TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- [ ] [BookStack](https://www.bookstackapp.com/) chart
- [ ] [Maildev](https://github.com/maildev/maildev) chart
- [ ] [GoBackup](https://gobackup.github.io/) chart
- [ ] [Kubenav](https://github.com/kubenav/kubenav) chart
- [X] [Kubenav](https://github.com/kubenav/kubenav) chart
- [ ] [Shopware 6](https://github.com/shopware/shopware) chart
- [ ] [Shlink](https://shlink.io/) chart
- [ ] [AnonAddy](https://addy.io/) chart
Expand All @@ -30,8 +30,4 @@

## 💡 Ideas

_None_

## 🔗 Links

_None_

0 comments on commit edaf332

Please sign in to comment.