Better API and SDKs documentation#210
Conversation
bfirsh
force-pushed
the
api-and-sdks-documentation
branch
from
c7b6169 to
21c4a74
Compare
bfirsh
force-pushed
the
api-and-sdks-documentation
branch
from
21c4a74 to
b444961
Compare
|
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:
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 |
|
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 <[email protected]>
bfirsh
force-pushed
the
api-and-sdks-documentation
branch
from
b444961 to
7b54fa8
Compare
|
@mstanleyjones @johndmulhausen Rebased on top of #606 and |
bfirsh
changed the title
|
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 |
|
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. |
2 participants
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
curlexamples in the getting started guide.Dependencies
Nice-to-haves
ContainerRunshort-hand. (The Go examples in the getting started guide are a bit of a mouthful.)/cc