docs: fix md style

Fix the following issues raised by markdownlint: - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md004---unordered-list-style - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md005---inconsistent-indentation-for-list-items-at-the-same-level - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md006---consider-starting-bulleted-lists-at-the-beginning-of-the-line - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md009---trailing-spaces - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md010---hard-tabs - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md012---multiple-consecutive-blank-lines - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md013---line-length - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md031---fenced-code-blocks-should-be-surrounded-by-blank-lines - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md032---lists-should-be-surrounded-by-blank-lines - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md040---fenced-code-blocks-should-have-a-language-specified Signed-off-by: Markus Lehtonen <[email protected]>
containers · Oct 24, 2023 · e6fdda5 · e6fdda5
1 parent 1595a69
commit e6fdda5
Show file tree

Hide file tree

Showing 16 changed files with 476 additions and 425 deletions.
diff --git a/deployment/helm/balloons/README.md b/deployment/helm/balloons/README.md
@@ -1,40 +1,44 @@
 # Balloons Policy Plugin
 
-This chart deploys balloons Node Resource Interface (NRI) plugin. The balloons NRI resource
-policy plugin implements workload placement into “balloons” that are disjoint CPU pools.
+This chart deploys balloons Node Resource Interface (NRI) plugin. The balloons
+NRI resource policy plugin implements workload placement into “balloons” that
+are disjoint CPU pools.
 
 ## Prerequisites
 
 - Kubernetes 1.24+
 - Helm 3.0.0+
 - Container runtime:
-    - containerD:
-        - At least [containerd 1.7.0](https://github.com/containerd/containerd/releases/tag/v1.7.0)
-            release version to use the NRI feature.
-
-        - Enable NRI feature by following [these](https://github.com/containerd/containerd/blob/main/docs/NRI.md#enabling-nri-support-in-containerd)
-          detailed instructions. You can optionally enable the NRI in containerd using the Helm chart
-          during the chart installation simply by setting the `nri.patchRuntimeConfig` parameter.
-          For instance,
-
-          ```sh
-          helm install my-balloons nri-plugins/nri-resource-policy-balloons --set nri.patchRuntimeConfig=true --namespace kube-system
-          ```
-
-          Enabling `nri.patchRuntimeConfig` creates an init container to turn on
-          NRI feature in containerd and only after that proceed the plugin installation.
-
-    - CRI-O
-        - At least [v1.26.0](https://github.com/cri-o/cri-o/releases/tag/v1.26.0) release version to
-            use the NRI feature
-        - Enable NRI feature by following [these](https://github.com/cri-o/cri-o/blob/main/docs/crio.conf.5.md#crionri-table) detailed instructions.
-          You can optionally enable the NRI in CRI-O using the Helm chart
-          during the chart installation simply by setting the `nri.patchRuntimeConfig` parameter.
-          For instance,
-
-          ```sh
-          helm install my-balloons nri-plugins/nri-resource-policy-balloons --namespace kube-system --set nri.patchRuntimeConfig=true
-          ```
+  - containerD:
+    - At least [containerd 1.7.0](https://github.com/containerd/containerd/releases/tag/v1.7.0)
+      release version to use the NRI feature.
+
+    - Enable NRI feature by following
+      [these](https://github.com/containerd/containerd/blob/main/docs/NRI.md#enabling-nri-support-in-containerd)
+      detailed instructions. You can optionally enable the NRI in containerd
+      using the Helm chart during the chart installation simply by setting the
+      `nri.patchRuntimeConfig` parameter. For instance,
+
+      ```sh
+      helm install my-balloons nri-plugins/nri-resource-policy-balloons --set nri.patchRuntimeConfig=true --namespace kube-system
+      ```
+
+      Enabling `nri.patchRuntimeConfig` creates an init container to turn on
+      NRI feature in containerd and only after that proceed the plugin
+      installation.
+
+  - CRI-O
+    - At least [v1.26.0](https://github.com/cri-o/cri-o/releases/tag/v1.26.0)
+      release version to use the NRI feature
+    - Enable NRI feature by following
+      [these](https://github.com/cri-o/cri-o/blob/main/docs/crio.conf.5.md#crionri-table)
+      detailed instructions.  You can optionally enable the NRI in CRI-O using
+      the Helm chart during the chart installation simply by setting the
+      `nri.patchRuntimeConfig` parameter. For instance,
+
+      ```sh
+      helm install my-balloons nri-plugins/nri-resource-policy-balloons --namespace kube-system --set nri.patchRuntimeConfig=true
+      ```
 
 ## Installing the Chart
 
@@ -45,11 +49,11 @@ helm repo add nri-plugins https://containers.github.io/nri-plugins
 helm install my-balloons nri-plugins/nri-resource-policy-balloons --namespace kube-system
 ```
 
-The command above deploys balloons NRI plugin on the Kubernetes cluster within the
-`kube-system` namespace with default configuration. To customize the available parameters
-as described in the [Configuration options]( #configuration-options) below, you have two
-options: you can use the `--set` flag or create a custom values.yaml file and provide it
-using the `-f` flag. For example:
+The command above deploys balloons NRI plugin on the Kubernetes cluster within
+the `kube-system` namespace with default configuration. To customize the
+available parameters as described in the [Configuration options](#configuration-options)
+below, you have two options: you can use the `--set` flag or create a custom
+values.yaml file and provide it using the `-f` flag. For example:
 
 ```sh
 # Install the balloons plugin with custom values provided using the --set option
@@ -81,8 +85,8 @@ helm delete my-balloons --namespace kube-system
 
 ## Configuration options
 
-The tables below present an overview of the parameters available for users to customize with their own values,
-along with the default values.
+The tables below present an overview of the parameters available for users to
+customize with their own values, along with the default values.
 
 | Name                     | Default                                                                                                                       | Description                                          |
 | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |

diff --git a/deployment/helm/memory-qos/README.md b/deployment/helm/memory-qos/README.md
@@ -1,41 +1,44 @@
 # Memory-QoS Plugin
 
-This chart deploys memory-qos Node Resource Interface (NRI) plugin. The memory-qos NRI plugin
-adds two methods for controlling cgroups v2 memory.* parameters: QoS class and direct memory
-annotations.
+This chart deploys memory-qos Node Resource Interface (NRI) plugin. The
+memory-qos NRI plugin adds two methods for controlling cgroups v2 memory.*
+parameters: QoS class and direct memory annotations.
 
 ## Prerequisites
 
 - Kubernetes 1.24+
 - Helm 3.0.0+
 - Container runtime:
-    - containerD:
-        - At least [containerd 1.7.0](https://github.com/containerd/containerd/releases/tag/v1.7.0)
-            release version to use the NRI feature.
-
-        - Enable NRI feature by following [these](https://github.com/containerd/containerd/blob/main/docs/NRI.md#enabling-nri-support-in-containerd)
-          detailed instructions. You can optionally enable the NRI in containerd using the Helm chart
-          during the chart installation simply by setting the `nri.patchRuntimeConfig` parameter.
-          For instance,
-
-          ```sh
-          helm install my-memory-qos nri-plugins/nri-memory-qos --set nri.patchRuntimeConfig=true --namespace kube-system
-          ```
-
-          Enabling `nri.patchRuntimeConfig` creates an init container to turn on
-          NRI feature in containerd and only after that proceed the plugin installation.
-
-    - CRI-O
-        - At least [v1.26.0](https://github.com/cri-o/cri-o/releases/tag/v1.26.0) release version to
-            use the NRI feature
-        - Enable NRI feature by following [these](https://github.com/cri-o/cri-o/blob/main/docs/crio.conf.5.md#crionri-table) detailed instructions.
-          You can optionally enable the NRI in CRI-O using the Helm chart
-          during the chart installation simply by setting the `nri.patchRuntimeConfig` parameter.
-          For instance,
-
-          ```sh
-          helm install my-memory-qos nri-plugins/nri-memory-qos --namespace kube-system --set nri.patchRuntimeConfig=true
-          ```
+  - containerD:
+    - At least [containerd 1.7.0](https://github.com/containerd/containerd/releases/tag/v1.7.0)
+      release version to use the NRI feature.
+
+    - Enable NRI feature by following
+      [these](https://github.com/containerd/containerd/blob/main/docs/NRI.md#enabling-nri-support-in-containerd)
+      detailed instructions. You can optionally enable the NRI in containerd
+      using the Helm chart during the chart installation simply by setting the
+      `nri.patchRuntimeConfig` parameter. For instance,
+
+      ```sh
+      helm install my-memory-qos nri-plugins/nri-memory-qos --set nri.patchRuntimeConfig=true --namespace kube-system
+      ```
+
+      Enabling `nri.patchRuntimeConfig` creates an init container to turn on
+      NRI feature in containerd and only after that proceed the plugin
+      installation.
+
+  - CRI-O
+    - At least [v1.26.0](https://github.com/cri-o/cri-o/releases/tag/v1.26.0)
+      release version to use the NRI feature
+    - Enable NRI feature by following
+      [these](https://github.com/cri-o/cri-o/blob/main/docs/crio.conf.5.md#crionri-table)
+      detailed instructions.  You can optionally enable the NRI in CRI-O using
+      the Helm chart during the chart installation simply by setting the
+      `nri.patchRuntimeConfig` parameter. For instance,
+
+      ```sh
+      helm install my-memory-qos nri-plugins/nri-memory-qos --namespace kube-system --set nri.patchRuntimeConfig=true
+      ```
 
 ## Installing the Chart
 
@@ -46,11 +49,11 @@ helm repo add nri-plugins https://containers.github.io/nri-plugins
 helm install my-memory-qos nri-plugins/nri-memory-qos --namespace kube-system
 ```
 
-The command above deploys memory-qos NRI plugin on the Kubernetes cluster within the
-`kube-system` namespace with default configuration. To customize the available parameters
-as described in the [Configuration options]( #configuration-options) below, you have two
-options: you can use the `--set` flag or create a custom values.yaml file and provide it
-using the `-f` flag. For example:
+The command above deploys memory-qos NRI plugin on the Kubernetes cluster
+within the `kube-system` namespace with default configuration. To customize the
+available parameters as described in the [Configuration options](#configuration-options)
+below, you have two options: you can use the `--set` flag or create a custom
+values.yaml file and provide it using the `-f` flag. For example:
 
 ```sh
 # Install the memory-qos plugin with custom values provided using the --set option
@@ -82,8 +85,8 @@ helm delete my-memory-qos --namespace kube-system
 
 ## Configuration options
 
-The tables below present an overview of the parameters available for users to customize with their own values,
-along with the default values.
+The tables below present an overview of the parameters available for users to
+customize with their own values, along with the default values.
 
 | Name                     | Default                                                                                                                       | Description                                          |
 | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |

diff --git a/deployment/helm/memtierd/README.md b/deployment/helm/memtierd/README.md
@@ -1,40 +1,43 @@
 # Memtierd Plugin
 
-This chart deploys memtierd Node Resource Interface (NRI) plugin. The memtierd NRI plugin enables
-managing workloads with Memtierd in Kubernetes.
+This chart deploys memtierd Node Resource Interface (NRI) plugin. The memtierd
+NRI plugin enables managing workloads with Memtierd in Kubernetes.
 
 ## Prerequisites
 
 - Kubernetes 1.24+
 - Helm 3.0.0+
 - Container runtime:
-    - containerD:
-        - At least [containerd 1.7.0](https://github.com/containerd/containerd/releases/tag/v1.7.0)
-            release version to use the NRI feature.
-
-        - Enable NRI feature by following [these](https://github.com/containerd/containerd/blob/main/docs/NRI.md#enabling-nri-support-in-containerd)
-          detailed instructions. You can optionally enable the NRI in containerd using the Helm chart
-          during the chart installation simply by setting the `nri.patchRuntimeConfig` parameter.
-          For instance,
-
-          ```sh
-          helm install my-memtierd nri-plugins/nri-memtierd --set nri.patchRuntimeConfig=true --namespace kube-system
-          ```
-
-          Enabling `nri.patchRuntimeConfig` creates an init container to turn on
-          NRI feature in containerd and only after that proceed the plugin installation.
-
-    - CRI-O
-        - At least [v1.26.0](https://github.com/cri-o/cri-o/releases/tag/v1.26.0) release version to
-            use the NRI feature
-        - Enable NRI feature by following [these](https://github.com/cri-o/cri-o/blob/main/docs/crio.conf.5.md#crionri-table) detailed instructions.
-          You can optionally enable the NRI in CRI-O using the Helm chart
-          during the chart installation simply by setting the `nri.patchRuntimeConfig` parameter.
-          For instance,
-
-          ```sh
-          helm install my-memtierd nri-plugins/nri-memtierd --namespace kube-system --set nri.patchRuntimeConfig=true
-          ```
+  - containerD:
+    - At least [containerd 1.7.0](https://github.com/containerd/containerd/releases/tag/v1.7.0)
+      release version to use the NRI feature.
+
+    - Enable NRI feature by following
+      [these](https://github.com/containerd/containerd/blob/main/docs/NRI.md#enabling-nri-support-in-containerd)
+      detailed instructions. You can optionally enable the NRI in containerd
+      using the Helm chart during the chart installation simply by setting the
+      `nri.patchRuntimeConfig` parameter. For instance,
+
+      ```sh
+      helm install my-memtierd nri-plugins/nri-memtierd --set nri.patchRuntimeConfig=true --namespace kube-system
+      ```
+
+      Enabling `nri.patchRuntimeConfig` creates an init container to turn on
+      NRI feature in containerd and only after that proceed the plugin
+      installation.
+
+  - CRI-O
+    - At least [v1.26.0](https://github.com/cri-o/cri-o/releases/tag/v1.26.0)
+      release version to use the NRI feature
+    - Enable NRI feature by following
+      [these](https://github.com/cri-o/cri-o/blob/main/docs/crio.conf.5.md#crionri-table)
+      detailed instructions.  You can optionally enable the NRI in CRI-O using
+      the Helm chart during the chart installation simply by setting the
+      `nri.patchRuntimeConfig` parameter. For instance,
+
+      ```sh
+      helm install my-memtierd nri-plugins/nri-memtierd --namespace kube-system --set nri.patchRuntimeConfig=true
+      ```
 
 ## Installing the Chart
 
@@ -45,11 +48,11 @@ helm repo add nri-plugins https://containers.github.io/nri-plugins
 helm install my-memtierd nri-plugins/nri-memtierd --namespace kube-system
 ```
 
-The command above deploys memtierd NRI plugin on the Kubernetes cluster within the
-`kube-system` namespace with default configuration. To customize the available parameters
-as described in the [Configuration options]( #configuration-options) below, you have two
-options: you can use the `--set` flag or create a custom values.yaml file and provide it
-using the `-f` flag. For example:
+The command above deploys memtierd NRI plugin on the Kubernetes cluster within
+the `kube-system` namespace with default configuration. To customize the
+available parameters as described in the [Configuration options](#configuration-options)
+below, you have two options: you can use the `--set` flag or create a custom
+values.yaml file and provide it using the `-f` flag. For example:
 
 ```sh
 # Install the memtierd plugin with custom values provided using the --set option
@@ -81,8 +84,8 @@ helm delete my-memtierd --namespace kube-system
 
 ## Configuration options
 
-The tables below present an overview of the parameters available for users to customize with their own values,
-along with the default values.
+The tables below present an overview of the parameters available for users to
+customize with their own values, along with the default values.
 
 | Name                     | Default                                                                                                                       | Description                                          |
 | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |