First iteration of V1/V2 Plugin documentation.

[sh-abhi]

Signed-off-by: abhishek7 abhishek@asharma.me

- What I did
First iteration of the plugin README for the V1/V2 plugins

- How I did it
Exploring the repo, searching online, general research.

- How to verify it
Will need others to review this PR and provide constructive feedback so that we can improve it. This PR should be considered as an initial draft.

- Description for the changelog
First iteration of V1/V2 plugin documentation.

[sh-abhi]

This PR follows up on moby/moby#32591, and should be considered as an initial draft. I would like to have some more information on the architecture behind the V1 and V2 plugins so that the README can be more useful. Let me know if there is something better we can have rather than what I had in mind.

Suggestions welcome as always!

[mdlinville]

What's this for? The formal docs only consume specific parts of this docs set and would not normally consume a README. Is this just a guideline for plugin developers?

[thaJeztah]

/cc @cpuguy83

[sh-abhi]

@thaJeztah, any way that we can rebuild this?

[codecov-io]

Codecov Report

Merging #506 into master will increase coverage by <.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #506      +/-   ##
==========================================
+ Coverage   49.01%   49.02%   +<.01%     
==========================================
  Files         199      199              
  Lines       16392    16392              
==========================================
+ Hits         8035     8036       +1     
+ Misses       7939     7938       -1     
  Partials      418      418

[vdemeester]

ping @cpuguy83 @anusha-ragunathan

[sh-abhi]

Hi @cpuguy83 @anusha-ragunathan, did you have a chance to take a look at this yet? Please let me know if there are any concerns, or if there is anything else I can do to improve this.

[sh-abhi]

Friendly ping to follow up. @cpuguy83 @anusha-ragunathan

[cpuguy83]

The basic arch of v1 and v2 are the same, except that v2 introduces a formal packaging/lifecycle management but otherwise exactly the same.
The docs for the architecture are all there, just poorly organized and called out for what it is.

[cpuguy83]

Also agree with @mistyhacks, whatever changes are made, we should make sure these land in the docker docs and not just in the repo.

[sh-abhi]

@cpuguy83 apologies, I did not intend for the delayed response. I'm not entirely following, are we saying that the docs exist, and we just need to reorganize them?

If so, do we want to close this PR for the time being? Not sure if we want to reorganize the docs for the architecture at the moment.

[thaJeztah]

I think @cpuguy83's reply refers to the file being named README.md, which would show as "index" on GitHub, but for the documentation at https://docs.docker.com/engine/extend/, the index.md will be used as index (landing page); so any information in README.md that should become visible in the documentation, should likely be added to the index.md

[silvin-lubecki]

s/docs/documents
s/repo/repository

[SvenDowideit]

@thaJeztah In the interests of progress, I'd merge this as a substantive improvement on what's in the repo now - and any wishes for further improvement are just that, wishes :)

[mdlinville]

I'm not a good reviewer for this, but I can't seem to unassign myself.

[Benehiko]

@sh-abhi Thank you for your work on this. I'm sorry that this did not get the necessary attention at the time to get merged. I'll be closing this since it's been quite a while since this PR has been created and a lot has changed in the Docker documentation since then.

Feel free to open another PR if this is still a relevant topic you wish to contribute!