Skip to content

Commit

Permalink
docs: Updating the text for the NRI resource policy plugin
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
jukkar committed Jun 6, 2023
1 parent 9f3f467 commit 75fb370
Show file tree
Hide file tree
Showing 43 changed files with 609 additions and 1,339 deletions.
4 changes: 2 additions & 2 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# The NRI Plugin Collection Project Community Code of Conduct
# The NRI Plugins Project Community Code of Conduct

The NRI Plugin Collection Project follows the [Containers Community Code of Conduct](https://github.com/containers/common/blob/main/CODE-OF-CONDUCT.md).
The NRI Plugins Project follows the [Containers Community Code of Conduct](https://github.com/containers/common/blob/main/CODE-OF-CONDUCT.md).
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# NRI Plugin Collection
# NRI Plugins

This repository contains a collection of community maintained NRI plugins.

Expand All @@ -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
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Security and Disclosure Information Policy for the NRI Plugin Collection Project
# Security and Disclosure Information Policy for the NRI Plugins Project

* [Reporting a Vulnerability](#Reporting-a-Vulnerability)
* [Security Announcements](#Security-Announcements)
* [Security Vulnerability Response](#Security-Vulnerability-Response)

## Reporting a Vulnerability

If you think you've identified a security issue in a NRI Plugin Collection project,
If you think you've identified a security issue in a NRI Plugins project,
please DO NOT report the issue publicly via the Github issue tracker,
mailing list, or IRC. Instead, send an email with as many details as
possible to [[email protected]](mailto:[email protected]?subject=Security%20Vunerablity%20Report) or [[email protected]](mailto:[email protected]?subject=Security%20Vunerablity%20Report).
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</dl>
<dl>
<dt>
<a href="/cri-resource-manager/releases">all releases</a>
<a href="/containers/nri-plugins/releases">all releases</a>
</dt>
</dl>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

# -- Project information -----------------------------------------------------

project = 'NRI Plugin Collection'
project = 'NRI Plugins'
copyright = '2023, various'
author = 'various'

Expand Down Expand Up @@ -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','test/statistics-analysis/README.md']

# -- Options for HTML output -------------------------------------------------

Expand Down
12 changes: 6 additions & 6 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Contributing

Please use the GitHub\* infrastructure for contributing to
CRI Resource Manager.
Use [pull requests](https://github.com/intel/cri-resource-manager/pulls)
Please use the GitHub\* infrastructure for contributing to NRI Plugins.
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.

For the actual NRI (Node Resource Interface) API, please see [NRI repository](https://github.com/containerd/nri)
262 changes: 0 additions & 262 deletions docs/developers-guide/architecture.md

This file was deleted.

Loading

0 comments on commit 75fb370

Please sign in to comment.