docs: Updating the text for the NRI resource policy plugin

Changing the documentation so that it will describe how the nri-resource-policy plugin works. Also reshuffling the files around to better fit the overall documentation structure. Signed-off-by: Jukka Rissanen <[email protected]>
containers · Mar 28, 2023 · 45ba643 · 45ba643
1 parent 3886620
commit 45ba643
Show file tree

Hide file tree

Showing 37 changed files with 322 additions and 851 deletions.
diff --git a/README.md b/README.md
@@ -9,4 +9,4 @@ Currently following plugins are available:
 | [Topology Aware][1] |  resource policy |
 | [Balloons][1]       |  resource policy |
 
-[1]: http://github.com/containers/nri-plugins/blob/main/docs/README-resource-policy.md
+[1]: http://github.com/containers/nri-plugins/blob/main/docs/resource-policy/README.md
diff --git a/docs/conf.py b/docs/conf.py
@@ -129,7 +129,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']
+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']
 
 # -- Options for HTML output -------------------------------------------------
 

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -1,10 +1,9 @@
 # Contributing
 
 Please use the GitHub\* infrastructure for contributing to
-CRI Resource Manager.
-Use [pull requests](https://github.com/intel/cri-resource-manager/pulls)
+NRI Plugin Collection.
+Use [pull requests](https://github.com/containers/nri-plugins/pulls)
 to contribute code, bug fixes, or if you want to discuss your ideas in terms of
-code. Open [issues](https://github.com/intel/cri-resource-manager/issues) to
+code. Open [issues](https://github.com/containers/nri-plugins/issues) to
 report bugs, request new features, or if you want to discuss any other topics
-related to CRI Resource Manager or orchestration resource management in
-general.
+related to NRI plugins.
diff --git a/docs/developers-guide/e2e-test.md b/docs/developers-guide/e2e-test.md
diff --git a/docs/developers-guide/figures/arch-overview.svg b/docs/developers-guide/figures/arch-overview.svg
diff --git a/docs/developers-guide/figures/cri-resmgr.png b/docs/developers-guide/figures/cri-resmgr.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,24 +1,14 @@
-.. CRI Resource Manager documentation master file
+.. NRI Plugin Collection documentation master file
 
-Welcome to CRI Resource Manager's documentation!
-================================================
+Welcome to NRI Plugin Collection documentation
+==============================================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-   introduction.md
-   quick-start.md
-   installation.md
-   setup.md
-   policy/index.rst
-   node-agent.md
-
-   developers-guide/index.rst
-
-   reference/index.md
-
    contributing.md
-   security.md
 
-   Project GitHub repository <https://github.com/intel/nri-resmgr>
+   resource-policy/index.rst
+
+   Project GitHub repository <https://github.com/containers/nri-plugins>
diff --git a/docs/introduction.md b/docs/introduction.md
diff --git a/docs/policy/blockio.md b/docs/policy/blockio.md