Document plugins by dmcgowan · Pull Request #2480 · containerd/containerd

dmcgowan · 2018-07-20T00:59:32Z

Add plugins documentation to root as well as mention configuring proxy and runtime plugins.

AkihiroSuda · 2018-07-20T01:32:34Z

nit: s/GRPC/gRPC/g ?

AkihiroSuda · 2018-07-20T01:34:42Z

Can we remove containerd/design/plugins.md now?

ijc · 2018-07-20T09:08:45Z

"In this case..."

codecov-io · 2018-07-20T19:18:58Z

Codecov Report

Merging #2480 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2480   +/-   ##
=======================================
  Coverage   44.76%   44.76%           
=======================================
  Files          93       93           
  Lines        9555     9555           
=======================================
  Hits         4277     4277           
  Misses       4585     4585           
  Partials      693      693

Flag	Coverage Δ
#linux	`48.98% <ø> (ø)`	⬆️
#windows	`41.04% <ø> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d02728f...1580ec5. Read the comment docs.

crosbymichael · 2018-07-20T21:49:29Z

LGTM

mlaventure · 2018-07-25T21:09:05Z

s/users/user

mlaventure · 2018-07-25T21:09:40Z

nit: I would actually remove Using

mlaventure · 2018-07-25T21:10:17Z

without needing to recompile the daemon ?

mlaventure · 2018-07-25T21:11:37Z

allows extension through 2 methods: - via a binary available in containerd's PATH - by configuring containerd as a proxy to another gRPC service

?

yeah I'll update to a format like that, I think that is clearer than a run-on sentence

mlaventure · 2018-07-25T21:13:19Z

may be me not being a native speaker, but which defaults to made me think that you would display the content of the file, not its location.

That is a reasonable interpretation of the sentence, changing to which by default is at to be more clear.

mlaventure · 2018-07-25T21:19:36Z

s/explained/explains

mlaventure · 2018-07-25T21:20:17Z

s/with/using the pattern/ ?

dmcgowan · 2018-07-25T21:36:32Z

@mlaventure thanks for taking a look, updated

mlaventure · 2018-07-25T21:42:52Z

the use of proxy_plugin. is a bit confusing here maybe something like:

The string following proxy_plugin. will be used as the name?

updated, also the defaults to

mlaventure · 2018-07-25T21:43:10Z

Had one more comment, but LGTM otherwise

mlaventure

LGTM

estesp · 2018-07-26T02:02:50Z

The document reads well, but the header capitalization doesn't seem to match the rest of our markdown files? I think we want initial capitals for words in headers? Pretty minor, and otherwise LGTM.

Add plugins documentation to root. Mention configuring proxy plugins and runtime plugins. Signed-off-by: Derek McGowan <[email protected]>

Signed-off-by: Derek McGowan <[email protected]>

dmcgowan force-pushed the proxy-plugin-doc branch from f7fe69b to 2975a44 Compare July 20, 2018 01:01

AkihiroSuda reviewed Jul 20, 2018

View reviewed changes

Comment thread PLUGINS.md Outdated

Copy link
Copy Markdown

Member

AkihiroSuda Jul 20, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: s/GRPC/gRPC/g ?

ijc reviewed Jul 20, 2018

View reviewed changes

Comment thread PLUGINS.md Outdated

Copy link
Copy Markdown

Contributor

ijc Jul 20, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"In this case..."

dmcgowan force-pushed the proxy-plugin-doc branch 2 times, most recently from c2e31e7 to 707ebdf Compare July 20, 2018 19:00

mlaventure reviewed Jul 25, 2018

View reviewed changes

dmcgowan force-pushed the proxy-plugin-doc branch from 707ebdf to edff762 Compare July 25, 2018 21:35

mlaventure reviewed Jul 25, 2018

View reviewed changes

dmcgowan force-pushed the proxy-plugin-doc branch from edff762 to 63078d7 Compare July 25, 2018 21:49

mlaventure approved these changes Jul 25, 2018

View reviewed changes

dmcgowan added this to the 1.2 milestone Jul 25, 2018

dmcgowan added 2 commits July 25, 2018 23:28

Document plugins

3e657de

Add plugins documentation to root. Mention configuring proxy plugins and runtime plugins. Signed-off-by: Derek McGowan <[email protected]>

Remove outdated plugin design doc

1580ec5

Signed-off-by: Derek McGowan <[email protected]>

dmcgowan force-pushed the proxy-plugin-doc branch from 63078d7 to 1580ec5 Compare July 26, 2018 06:28

AkihiroSuda approved these changes Jul 30, 2018

View reviewed changes

dmcgowan merged commit ca71484 into containerd:master Jul 30, 2018

dmcgowan deleted the proxy-plugin-doc branch September 10, 2019 17:47

Conversation

dmcgowan commented Jul 20, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AkihiroSuda commented Jul 20, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov-io commented Jul 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

crosbymichael commented Jul 20, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dmcgowan commented Jul 25, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mlaventure commented Jul 25, 2018

Uh oh!

mlaventure left a comment

Choose a reason for hiding this comment

Uh oh!

estesp commented Jul 26, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

codecov-io commented Jul 20, 2018 •

edited

Loading