From 63125f1849a923f337196fe6955cdb99e84bc5c3 Mon Sep 17 00:00:00 2001 From: Markus Pesch Date: Tue, 27 May 2025 22:25:51 +0200 Subject: [PATCH] docs(README): be compliant with markdownlint MD044 --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6465117..cecbe52 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ helm chart is tested for deployment scenarios with **ArgoCD**. ## Helm: configuration and installation 1. A helm chart repository must be configured, to pull the helm charts from. -2. All available parameters are [here](#parameters) in detail documented. The parameters can be defined via the helm +2. All available [parameters](#parameters) are documented in detail below. The parameters can be defined via the helm `--set` flag or directly as part of a `values.yaml` file. The following example defines the `prometheus-exporter` repository and use the `--set` flag for a basic deployment. @@ -70,7 +70,8 @@ available. As this is a Golang application, this can be implemented using `GOMAX of defining `GOMAXPROCS` automatically based on the defined CPU limit like `1000m`. Please keep in mind, that the CFS rate of `100ms` - default on each kubernetes node, is also very important to avoid CPU throttling. -Further information about this topic can be found [here](https://kanishk.io/posts/cpu-throttling-in-containerized-go-apps/). +Further information about this topic can be found in one of Kanishk's blog +[posts](https://kanishk.io/posts/cpu-throttling-in-containerized-go-apps/). > [!NOTE] > The environment variable `GOMAXPROCS` is set automatically, when a CPU limit is defined. An explicit configuration is