docs: convert all rst to md

Convert all reStructuredText files into markdown to have all the documentation in the same format. Signed-off-by: Markus Lehtonen <[email protected]>
containers · Jun 26, 2023 · 1212598 · 1212598
1 parent bc8574b
commit 1212598
Show file tree

Hide file tree

Showing 11 changed files with 55 additions and 57 deletions.
diff --git a/docs/index.md 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 <https://github.com/containers/nri-plugins>
+```
diff --git a/docs/index.rst b/docs/index.rst
diff --git 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
@@ -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
@@ -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
diff --git a/docs/resource-policy/developers-guide/testing.md 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
diff --git a/docs/resource-policy/index.md 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
diff --git a/docs/resource-policy/policy/index.rst → docs/resource-policy/policy/index.md b/docs/resource-policy/policy/index.rst → 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
+```