move packages related to v0.1.0 to the plugins/v010-adapter #154
Conversation
Signed-off-by: Iceber Gu <caiwei95@hotmail.com>
| @@ -23,26 +23,6 @@ The goal is to enable NRI support in the most commonly used OCI runtimes, | |||
| [containerd](https://github.com/containerd/containerd) and | |||
| [CRI-O](https://github.com/cri-o/cri-o). | |||
|
|
|||
| ## Background | |||
There was a problem hiding this comment.
Should we still keep a revisited short 'Background' or 'Introduction' section which briefly tells in a few sentences what NRI is ?
There was a problem hiding this comment.
Well, we have the Goal section. Maybe that's good enough then.
| @@ -1,110 +0,0 @@ | |||
| # nri - Node Resource Interface | |||
There was a problem hiding this comment.
leave a short description and a hyper link reference to the new 0.1.0/readme
e.g.
original v0.1.0 CLI invoke style version of NRI has been moved
v0.1.0 docs
| *This version of NRI is supported through the included v010-adapter plugin.* | ||
|
|
||
| Refer to the original documentation: [NRI v0.1.0](https://github.com/containerd/nri/blob/v0.9.0/README-v0.1.0.md). | ||
| If you're still using *nri v0.1.0*, We recommend refactoring to the latest NRI. |
There was a problem hiding this comment.
bring in the background v.0.1.0 paragraph from the readme.md and add links to the now removed v010 example/skel
.... other 0.1.0 files useful for v0.1.0 cll invoke style NRI plugins..
v0.1.0 clearcfs example
v0.1.0 skel example
| @@ -23,26 +23,6 @@ The goal is to enable NRI support in the most commonly used OCI runtimes, | |||
| [containerd](https://github.com/containerd/containerd) and | |||
| [CRI-O](https://github.com/cri-o/cri-o). | |||
|
|
|||
| ## Background | |||
There was a problem hiding this comment.
I'd leave the background section in, remove the first paragraph .. move the second v0.1.0 paragraph to the new 0.1.0 readme.. and revise the 3rd paragraph with a more forward presence.. vs the change to now perspective.
There was a problem hiding this comment.
What do you think of adjusting the third paragraph of the reservation to read as follows:
## Background
Plugins in NRI are daemon-like entities. A single instance of a plugin is responsible for handling the full stream of NRI events and requests. A unix-domain socket is used as the transport for communication.
NRI is defined as a formal, protobuf-based 'NRI plugin protocol' which is compiled into ttRPC bindings. This should result in improved communication efficiency with lower per-message overhead, and enable straightforward implementation of stateful NRI plugins.
Since the Background section no longer contains content related to 0.1.0, the section name seems a bit odd. It reads more like a description of the Plugin.
Do you think it would be better to either make it a subsection within the Goal section or just move it directly into the Goal section?
eg.
## Goal
....
### Plugins
Plugins in NRI are daemon-like entities. A single instance of a plugin is responsible for handling the full stream of NRI events and requests. A unix-domain socket is used as the transport for communication.
...
issue: #153