docs: experiment with Helm chart doc inclusion.

Experiment with including/linking to Helm chart-specific documentation stored in deployment/helm/*/README.md among the normal documentation rooted under /docs. Signed-off-by: Krisztian Litkey <[email protected]>
containers · Oct 20, 2023 · 91854dc · 91854dc
1 parent b12c897
commit 91854dc
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 6 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -127,7 +127,7 @@ def gomod_versions(modules):
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', '.github', '_work', 'generate', 'README.md', 'TODO.md', 'SECURITY.md', 'CODE-OF-CONDUCT.md', 'docs/releases', 'test/self-hosted-runner/README.md', 'test/e2e/README.md', 'docs/resource-policy/releases', 'docs/resource-policy/README.md','test/statistics-analysis/README.md']
+exclude_patterns = ['_build', '.github', '_work', 'generate', 'README.md', 'TODO.md', 'SECURITY.md', 'CODE-OF-CONDUCT.md', 'docs/releases', 'test/self-hosted-runner/README.md', 'test/e2e/README.md', 'docs/resource-policy/releases', 'docs/resource-policy/README.md','test/statistics-analysis/README.md', 'deployment/helm/*/*.md']
 
 # -- Options for HTML output -------------------------------------------------
 

diff --git a/docs/helm/balloons.md b/docs/helm/balloons.md
@@ -0,0 +1,2 @@
+```{include} ../../deployment/helm/balloons/README.md
+```
diff --git a/docs/helm/index.md b/docs/helm/index.md
@@ -0,0 +1,12 @@
+# Helm Charts
+
+```{toctree}
+---
+maxdepth: 2
+caption: Contents
+---
+balloons.md
+topology-aware.md
+memory-qos.md
+memtierd.md
+```
diff --git a/docs/helm/memory-qos.md b/docs/helm/memory-qos.md
@@ -0,0 +1,2 @@
+```{include} ../../deployment/helm/memory-qos/README.md
+```
diff --git a/docs/helm/memtierd.md b/docs/helm/memtierd.md
@@ -0,0 +1,2 @@
+```{include} ../../deployment/helm/memtierd/README.md
+```
diff --git a/docs/helm/topology-aware.md b/docs/helm/topology-aware.md
@@ -0,0 +1,2 @@
+```{include} ../../deployment/helm/topology-aware/README.md
+```
diff --git a/docs/index.md b/docs/index.md
@@ -8,6 +8,7 @@ caption: Contents
 introduction.md
 resource-policy/index.rst
 memory/index.md
+helm/index.md
 contributing.md
 Project GitHub repository <https://github.com/containers/nri-plugins>
 ```
diff --git a/docs/resource-policy/installation.md b/docs/resource-policy/installation.md
@@ -120,11 +120,7 @@ Note: this removes DaemonSet, ConfigMap, CustomResourceDefinition, and RBAC-rela
 
 ## Available parameters
 
-To know what are the available Helm configuration options for currently available Helm charts, you can check:
-- [balloons parameters](../../deployment/helm/balloons/README.md)
-- [memory-qos parameters](../../deployment/helm/memory-qos/README.md)
-- [memtierd parameters](../../deployment/helm/memtierd/README.md)
-- [topology-aware parameters](../../deployment/helm/topology-aware/README.md)
+See the documentation of our [Helm charts](../helm/index.md) the available Helm configuration options
 
 ## Manual installation
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		```{include} ../../deployment/helm/balloons/README.md
		```
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		```{include} ../../deployment/helm/memory-qos/README.md
		```
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		```{include} ../../deployment/helm/memtierd/README.md
		```
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		```{include} ../../deployment/helm/topology-aware/README.md
		```