Skip to content
This repository has been archived by the owner on Sep 26, 2021. It is now read-only.

driver doc updates #934

Merged
merged 2 commits into from
Apr 1, 2015
Merged

driver doc updates #934

merged 2 commits into from
Apr 1, 2015

Conversation

ehazlett
Copy link
Contributor

This updates the driver docs with the latest changes and an overview on driver creation and integration.

Signed-off-by: Evan Hazlett <ejhazlett@gmail.com>
@ehazlett ehazlett added this to the 0.2.0 milestone Mar 31, 2015
@nathanleclaire
Copy link
Contributor

If we update the Driver interface in the future (likely) we'll have to also update this document, so perhaps we should link to the relevant file instead (at least for the interface bits).

I think I'd also introduce the interface first, and then follow up with a small explanation that "And in order to provide this functionality most drivers end up as a struct that implements these methods with parameters similar to the following", since it's not strictly necessary to have those exact fields.

Also, tangentially, since those fields are very common, we could probably provide a struct that drivers can embed which has them like you mentioned in that one issue, and recommend that as a way to keep things consistent across drivers.

@ehazlett
Copy link
Contributor Author

ehazlett commented Apr 1, 2015

Yeah I was going to just have the link but then figured it would be good to have the docs in one place. I'll update to just have the link as our docs are out of sync now in places and I'm sure this would get worse.

I like the idea of embedding too. I will leave that out of this doc update though.

Thanks

Signed-off-by: Evan Hazlett <ejhazlett@gmail.com>
@ehazlett
Copy link
Contributor Author

ehazlett commented Apr 1, 2015

@nathanleclaire This has been updated - PTAL

@nathanleclaire
Copy link
Contributor

LGTM thanks for doing this. I want to do some focusing on docs today as well.

@ehazlett
Copy link
Contributor Author

ehazlett commented Apr 1, 2015

Thanks

ehazlett added a commit that referenced this pull request Apr 1, 2015
@ehazlett ehazlett merged commit be9113a into docker:master Apr 1, 2015
@ehazlett ehazlett deleted the driver-doc-updates branch April 1, 2015 19:57
@ehazlett ehazlett mentioned this pull request Apr 1, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants