docs: Reshuffling the content a bit

* Affinity document is embedded to topology-aware.md file as it is related to topology-aware policy. * Shuffled the table of contents so that it is more logical. Signed-off-by: Jukka Rissanen <[email protected]>
containers · Jun 21, 2023 · 1452e84 · 1452e84
1 parent b716519
commit 1452e84
Show file tree

Hide file tree

Showing 9 changed files with 295 additions and 275 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,6 +7,8 @@ Welcome to NRI Plugins documentation
    :maxdepth: 2
    :caption: Contents:
 
+   introduction.md
+
    resource-policy/index.rst
 
    contributing.md

diff --git a/docs/introduction.md b/docs/introduction.md
@@ -0,0 +1,6 @@
+# Introduction
+
+The NRI plugins is a collection of NRI (Node Resource Interface) based plugins
+to manage various aspects of pod and container life cycle.
+For example the [resource policy plugins](resource_policies) can be used to modify
+the container resource allocation depending on available system resources.
diff --git a/docs/resource-policy/configuration.rst b/docs/resource-policy/configuration.rst
@@ -0,0 +1,7 @@
+Configuration
+#############
+.. toctree::
+   :maxdepth: 1
+
+   policy/index.rst
+   node-agent.md
diff --git a/docs/resource-policy/policy/cpu-allocator.md → ...-policy/developers-guide/cpu-allocator.md b/docs/resource-policy/policy/cpu-allocator.md → ...-policy/developers-guide/cpu-allocator.md
diff --git a/docs/resource-policy/developers-guide/index.rst b/docs/resource-policy/developers-guide/index.rst
@@ -5,3 +5,4 @@ Developer's Guide
 
    architecture.md
    testing.rst
+   cpu-allocator.md
diff --git a/docs/resource-policy/index.rst b/docs/resource-policy/index.rst
@@ -1,7 +1,5 @@
-.. NRI Resource Policy documentation master file
-
-Resource Policy Plugin
-======================
+Resource Policy Plugins
+=======================
 
 .. toctree::
    :maxdepth: 2
@@ -10,7 +8,6 @@ Resource Policy Plugin
    introduction.md
    installation.md
    setup.md
-   policy/index.rst
-   node-agent.md
+   configuration.rst
 
    developers-guide/index.rst
diff --git a/docs/resource-policy/policy/container-affinity.md b/docs/resource-policy/policy/container-affinity.md
diff --git a/docs/resource-policy/policy/index.rst b/docs/resource-policy/policy/index.rst
@@ -1,10 +1,18 @@
+.. _resource_policies:
+
 Policies
 ########
 
+Currently there are two resource policies:
+
+The Topology Aware resource policy provides a nearly zero configuration resource
+policy that allocates resources evenly in order to avoid the "noisy neighbor" problem.
+
+The Balloons resource policy allows user to allocate workloads to resources in a more
+user controlled way.
+
 .. toctree::
    :maxdepth: 1
 
    topology-aware.md
    balloons.md
-   container-affinity.md
-   cpu-allocator.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,3 +5,4 @@ Developer's Guide

		architecture.md
		testing.rst
		cpu-allocator.md