Skip to content

Better API and SDKs documentation#210

Merged
mdlinville merged 1 commit into
docker:vnext-enginefrom
bfirsh:api-and-sdks-documentation
Dec 19, 2016
Merged

Better API and SDKs documentation#210
mdlinville merged 1 commit into
docker:vnext-enginefrom
bfirsh:api-and-sdks-documentation

Conversation

@bfirsh

@bfirsh bfirsh commented Oct 14, 2016

Copy link
Copy Markdown
Contributor

Background

I have been working on making the Remote API easier to use. This has involved various things:

What I've done

I've written some better documentation for the Remote API and SDKs. It includes a better high-level overview, and a new getting started guide.

It also links off to the new Swagger-based API reference. I have moved the links to docs for previous API versions to this page so that users immediately land on something useful.

I've discussed some of the docs with @joaofnfernandes who took a look at a very early version. The version in this PR is not complete yet, but I figure it'd be better to open this sooner rather than later so people can start to take a look and be aware of its existence.

I have left in the old documentation for the time being while we figure out what to do with it.

Todo

  • curl examples in the getting started guide.
  • A call-to-action at the bottom of the getting started guide ("what's next?")

Dependencies

Nice-to-haves

  • Some improvements to the Go SDK, e.g. a ContainerRun short-hand. (The Go examples in the getting started guide are a bit of a mouthful.)

/cc

  • @dnephin for the Go SDK and Swagger stuff.
  • @shin- for the Python SDK.
@bfirsh

bfirsh commented Dec 1, 2016

Copy link
Copy Markdown
Contributor Author

I have now based this on top of #606 and updated it to make sense in context of recent changes. It is essentially an extension of that PR, but with:

  • an introduction page (engine/api/index.md)
  • a getting started guide for various languages and curl (engine/api/getting-started.md)
  • a much improved client libraries page (engine/api/sdks.md).

Once #606 is in, I think this is pretty much ready to go. The only hard dependency is Docker SDK for Python 2.0, which will be released before 1.13 anyway. I recall @johndmulhausen saying we might have to review the design of horizontal tabs, because that hasn't been done before. (In fairness, they do look a bit naff, and are hard to use.)

/cc @johndmulhausen @mstanleyjones

@mdlinville

Copy link
Copy Markdown

After #606 is in, you'll need to rebase this again before we can merge it. We're getting there!

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
@bfirsh bfirsh force-pushed the api-and-sdks-documentation branch from b444961 to 7b54fa8 Compare December 15, 2016 15:15
@bfirsh bfirsh changed the base branch from master to vnext-engine December 15, 2016 15:15
@bfirsh

bfirsh commented Dec 15, 2016

Copy link
Copy Markdown
Contributor Author

@mstanleyjones @johndmulhausen Rebased on top of #606 and vnext-engine. Also, the new Docker SDK for Python has been released, so this is all ready to go now. :)

@bfirsh bfirsh changed the title WIP: Better API and SDKs documentation Dec 15, 2016
@mdlinville

Copy link
Copy Markdown

I'm going to merge this, but ping @johndmulhausen to do a follow-up PR to toggle all tabs on a page when one is toggled, and set a cookie so the user's preference is remembered on all API pages. I think the function is toggle_all_tabs in alljs.js.

@mdlinville mdlinville merged commit df98642 into docker:vnext-engine Dec 19, 2016
@bfirsh bfirsh deleted the api-and-sdks-documentation branch December 21, 2016 16:41
@bfirsh

bfirsh commented Dec 21, 2016

Copy link
Copy Markdown
Contributor Author

Yay thank you! 🎉

Ideally, clicking a tab would toggle all the ones on the page, but I didn't have time to do it in a non-hacky way, so I just left it out.

joaofnfernandes pushed a commit to joaofnfernandes/docker.github.io that referenced this pull request Aug 16, 2017
joaofnfernandes pushed a commit to joaofnfernandes/docker.github.io that referenced this pull request Aug 16, 2017
JimGalasyn pushed a commit that referenced this pull request Aug 16, 2017
shin- pushed a commit to shin-/docker.github.io that referenced this pull request Aug 19, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants