diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..628226361 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,12 @@ +# Welcome to NRI Plugins documentation + +```{toctree} +--- +maxdepth: 2 +caption: Contents +--- +introduction.md +resource-policy/index.rst +contributing.md +Project GitHub repository +``` diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index eb52560e6..000000000 --- a/docs/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. NRI Plugins documentation master file - -Welcome to NRI Plugins documentation -==================================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - introduction.md - - resource-policy/index.rst - - contributing.md - - Project GitHub repository diff --git a/docs/introduction.md b/docs/introduction.md index 262835890..af51c169a 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -2,5 +2,5 @@ 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 +For example the [resource policy plugins](resource-policy/policy/index.md) can be used to modify the container resource allocation depending on available system resources. diff --git a/docs/resource-policy/configuration.md b/docs/resource-policy/configuration.md index ea7a57840..47407ccc3 100644 --- a/docs/resource-policy/configuration.md +++ b/docs/resource-policy/configuration.md @@ -23,5 +23,5 @@ the node group label. There is a [sample ConfigMap spec](/sample-configs/nri-resource-policy-configmap.example.yaml) that contains a node-specific, a group-specific, and a default ConfigMap -example. See [any available policy-specific documentation](policy/index.rst) +example. See [any available policy-specific documentation](policy/index.md) for more information on the policy configurations. diff --git a/docs/resource-policy/developers-guide/index.md b/docs/resource-policy/developers-guide/index.md new file mode 100644 index 000000000..f3869b5b4 --- /dev/null +++ b/docs/resource-policy/developers-guide/index.md @@ -0,0 +1,10 @@ +# Developer's Guide + +```{toctree} +--- +maxdepth: 1 +--- +architecture.md +testing.rst +cpu-allocator.md +``` diff --git a/docs/resource-policy/developers-guide/index.rst b/docs/resource-policy/developers-guide/index.rst deleted file mode 100644 index 05556c29a..000000000 --- a/docs/resource-policy/developers-guide/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -Developer's Guide -################# -.. toctree:: - :maxdepth: 1 - - architecture.md - testing.rst - cpu-allocator.md diff --git a/docs/resource-policy/developers-guide/testing.md b/docs/resource-policy/developers-guide/testing.md new file mode 100644 index 000000000..357e30850 --- /dev/null +++ b/docs/resource-policy/developers-guide/testing.md @@ -0,0 +1,9 @@ +# Testing + +```{toctree} +--- +maxdepth: 1 +--- +unit-test.md +e2e-test.md +``` diff --git a/docs/resource-policy/developers-guide/testing.rst b/docs/resource-policy/developers-guide/testing.rst deleted file mode 100644 index 3d0a9e30c..000000000 --- a/docs/resource-policy/developers-guide/testing.rst +++ /dev/null @@ -1,8 +0,0 @@ -Testing -####### - -.. toctree:: - :maxdepth: 1 - - unit-test.md - e2e-test.md diff --git a/docs/resource-policy/index.md b/docs/resource-policy/index.md new file mode 100644 index 000000000..cff336824 --- /dev/null +++ b/docs/resource-policy/index.md @@ -0,0 +1,14 @@ +# Resource Policy Plugins + +```{toctree} +--- +maxdepth: 2 +caption: Contents +--- +introduction.md +installation.md +setup.md +configuration.md +policy/index.md +developers-guide/index.rst +``` diff --git a/docs/resource-policy/index.rst b/docs/resource-policy/index.rst deleted file mode 100644 index 521f69907..000000000 --- a/docs/resource-policy/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -Resource Policy Plugins -======================= - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - introduction.md - installation.md - setup.md - configuration.md - policy/index.rst - - developers-guide/index.rst diff --git a/docs/resource-policy/policy/index.rst b/docs/resource-policy/policy/index.md similarity index 74% rename from docs/resource-policy/policy/index.rst rename to docs/resource-policy/policy/index.md index bc4416a24..9017a1a6d 100644 --- a/docs/resource-policy/policy/index.rst +++ b/docs/resource-policy/policy/index.md @@ -1,7 +1,4 @@ -.. _resource_policies: - -Policies -######## +# Policies Currently there are two resource policies: @@ -11,8 +8,10 @@ policy that allocates resources evenly in order to avoid the "noisy neighbor" pr 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 +```{toctree} +--- +maxdepth: 1 +--- +topology-aware.md +balloons.md +```