From b52f1baf33085ada41a34f3ef008a2962f667bc0 Mon Sep 17 00:00:00 2001 From: Krisztian Litkey Date: Thu, 19 Oct 2023 17:56:22 +0300 Subject: [PATCH] docs: Helm chart doc inclusion. Include link to Helm chart-specific documentation stored in deployment/helm/*/README.md among the normal documentation rooted under /docs. Signed-off-by: Krisztian Litkey --- docs/conf.py | 2 +- docs/helm/balloons.md | 2 ++ docs/helm/index.md | 12 ++++++++++++ docs/helm/memory-qos.md | 2 ++ docs/helm/memtierd.md | 2 ++ docs/helm/topology-aware.md | 2 ++ docs/index.md | 1 + docs/resource-policy/installation.md | 6 +----- 8 files changed, 23 insertions(+), 6 deletions(-) create mode 100644 docs/helm/balloons.md create mode 100644 docs/helm/index.md create mode 100644 docs/helm/memory-qos.md create mode 100644 docs/helm/memtierd.md create mode 100644 docs/helm/topology-aware.md diff --git a/docs/conf.py b/docs/conf.py index 90e631737..b3377a93b 100644 --- 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 new file mode 100644 index 000000000..f180666e5 --- /dev/null +++ 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 new file mode 100644 index 000000000..9c2a72e39 --- /dev/null +++ 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 new file mode 100644 index 000000000..4ed196196 --- /dev/null +++ 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 new file mode 100644 index 000000000..40612361c --- /dev/null +++ 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 new file mode 100644 index 000000000..3ad6dc67d --- /dev/null +++ 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 index 1aa33fb9a..8aa866d02 100644 --- 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 ``` diff --git a/docs/resource-policy/installation.md b/docs/resource-policy/installation.md index 82b5790c9..bdf6dd5c7 100644 --- 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