Commit Graph

55 Commits

Author SHA1 Message Date
Sebastiaan van Stijn b7cf4b0888
Merge pull request #10332 from usha-mandya/engine-api-patch
Fix Engine API toc
2020-02-25 13:43:10 +01:00
Sebastiaan van Stijn 16d565cae6
API remove section about enterprise API version mismatch
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:27 +01:00
Sebastiaan van Stijn 3a223f799c
SDK: fix some minor issues in go examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:25 +01:00
Sebastiaan van Stijn c7c1a59dab
API docs: recommend using version negotiation
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:23 +01:00
Sebastiaan van Stijn 9774d43d65
SDK: remove reference to obsolete Go version
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:21 +01:00
Sebastiaan van Stijn d021c47d26
Remove duplicated API reference from SDK docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:19 +01:00
Sebastiaan van Stijn c4309a1ef7
Remove duplicated SDK content from API overview
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:17 +01:00
Sebastiaan van Stijn ee407ac0ef
Move SDK examples under "sdk"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:06 +01:00
Sebastiaan van Stijn f757d8a14b
Engine API: use template for API reference pages
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 13:58:30 +01:00
Usha Mandya 1566e01673 Moved topics under engine/api/ 2020-02-21 16:44:41 +00:00
Sebastiaan van Stijn 05d91b90f3
Add Engine API version v1.40
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-06-13 15:05:36 +02:00
Sebastiaan van Stijn eac39d66cd
Share redoc JavaScript between API versions
This is similar to the changes made in  docker/docker.github.io#5607
(32958e7c60), but which appear
to didn't make their way into newer versions that were added.

The redoc JavaScript is a big file, and there's no need
to keep a separate copy for each version of the API.

This patch removes the copy per-version and moves the script
to a central location.

Size of the API directory:

before: 5.961.110 bytes (6 MB on disk)
after:     15.570 bytes (74 KB on disk)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-06-13 14:59:21 +02:00
Sebastiaan van Stijn aae9bfc276
Rename / remove edge-related variables
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-01-14 22:44:58 +01:00
Maria Bermudez 1cdb109de0 Add new directories for Engine API versions 2018-11-06 13:02:43 -08:00
gbarr01 f36f3ec156 Update engine API docs, fetch script, and matrix 2018-03-22 16:52:53 -07:00
Joao Fernandes c9dcb9733c Revert "Update engine API docs, fetch script, and matrix"
This reverts commit 119bda6e17.
2018-03-22 11:58:07 -07:00
gbarr01 119bda6e17 Update engine API docs, fetch script, and matrix 2018-03-22 11:14:27 -07:00
gbarr01 13be4ade89 Update engine API docs and fetch script 2018-02-08 13:54:12 -08:00
gbarr01 7c3df66e72 Add API v1.35 dir and update references 2018-01-02 17:13:00 -08:00
Sebastiaan van Stijn 32958e7c60 Improve Engine API documentation (#5607)
* Share redoc JavaScript between API versions

The redoc JavaScript is a big file, and there's no need
to keep a separate copy for each version of the API.

This patch removes the copy per-version and moves the script
to a central location.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* Use central stylesheet for API reference

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* Update ReDoc to v1.19.3

Changelog can be found at https://github.com/Rebilly/ReDoc/blob/v1.19.3/CHANGELOG.md

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* Hide "request type" badges in menu

ReDoc 1.13 added "request type" badges in the menu
given that we didn't show these before, this patch
hides them.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* Add .map file for ReDoc

Having a .map file allows debugging script issues
in the ReDoc JavaScript (which is minified).

It's a big file, but may be useful to have.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-12-26 12:35:10 -08:00
gbarr01 8677231eff Update API docs and variables 2017-11-20 14:25:56 -08:00
Misty Stanley-Jones a30b95e49d Add API 1.33, API matrix 2017-10-17 21:34:07 -07:00
Misty Stanley-Jones 6aae2e4e84 Add pointer to latest API ref (#4897) 2017-10-16 15:04:24 -07:00
John Mulhausen 8b704f7b87 Revert "Add pointer to latest API ref" (#4896)
* Revert "Clarify patch and update cycles (#4894)"

This reverts commit 6b1577aa0d.

* Revert "Add pointer to latest API ref (#4892)"

This reverts commit a6b436d133.
2017-10-11 16:33:21 -07:00
Misty Stanley-Jones a6b436d133 Add pointer to latest API ref (#4892) 2017-10-11 15:52:15 -07:00
Misty Stanley-Jones 7dda3dc484 Update API, install files, upstream resources script for 17.09 2017-09-26 20:49:43 -07:00
Misty Stanley-Jones 99a697824b Add develop section, reorganize TOC (WIP) (#4312) 2017-09-26 20:16:59 -07:00
Misty Stanley-Jones 56d6e57c95 Add 1.31 API 2017-08-29 15:10:56 -07:00
Wang Jie fcf2883446 Update sdks.md (#3855) 2017-07-12 12:02:02 -07:00
Wang Jie 95af49deb0 Update index.md (#3856)
Add a missing period (.).
2017-07-12 12:01:37 -07:00
Misty Stanley-Jones af866cbb8e Add v1.30 of the API 2017-06-28 08:31:29 -07:00
Misty Stanley-Jones 7a0b00a188 Add simple pull examples with auth (#3574) 2017-06-22 11:47:05 -07:00
Yuji Shimoda 4184049fbe Fix python code snippet. (Commit containers) (#3267) 2017-05-19 15:27:13 -07:00
Misty Stanley-Jones 9c648cf079 Docker 17.05 docs (#3092)
* Add Netlify build script

* Pull 'edge' stuff from master for now

* Add env-regex logging opt (#2688)

* Update Dockerfile to pull from 17.05 branch

* Update YAML files from 17.05.x branch

* Add scaffolding for 17.05 content

* Document highlights for 17.05

* Add v1.29 API

* Document multi-stage builds
2017-05-05 19:50:22 +00:00
Bill a3a7ae1e0b replaced docker/docker with moby/moby (#2879)
* replaced docker/docker with moby/moby

* fixed incorrect name changes in release notes

* fixed mentions of moby/moby in code
2017-04-20 15:32:18 -05:00
Royce Remer a01182857f fix imports since docker api pkg migration, fix example repository name to be canonical (#2806) 2017-04-17 10:19:02 -07:00
Misty Stanley-Jones de1df1319b Fix a few 404s (#2785) 2017-04-14 10:28:54 -07:00
Misty Stanley-Jones 10be60a80f Go back to small /edge (#2736)
* Go back to small /edge

* Update site front page

Add info about Editions
Reorganize components
Update headings

* Move logic of fetching content to a script

* Add v1.28 API

* Add info about versioned API
2017-04-13 18:58:56 -07:00
Net Gusto e10661bb8b Go code: ImagePull: repository name must be canonical
If name given to imagePull is not canonical (see here for a description of a "canonical" name : https://github.com/docker/distribution/blob/245ca46/reference/normalize.go#L19-L23 ), the Go example panics : `repository name must be canonical`
2017-04-13 14:25:54 -07:00
Misty Stanley-Jones c6aca8acee Improve bootstrap tabs (#2546)
Use data-target instead of href
Move tab-syncing code into site-wide JS so everyone can use it
Add example for syncing tab groups on the same page
2017-03-30 12:57:37 -07:00
Victor Vieux ad065409d9 bump api to 1.27 (#2461)
* bump api to 1.27

Signed-off-by: Victor Vieux <victorvieux@gmail.com>
2017-03-28 09:31:53 -07:00
John Mulhausen 1cad0f77c2 Fix for tabs on Engine API 2017-03-17 13:56:14 -07:00
Alexandre Beslic 1bd064a8a5 Fix typo in SDK list (#2367)
Fix typo `shiplist` -> `shiplift`.
2017-03-17 11:58:34 -07:00
Roman Hotsiy c6c3476c6c Upgrade to ReDoc 1.11.0, closes #2246 (#2249) 2017-03-10 11:53:37 -08:00
mike 9fa709ecae Fix sentence. (#1976) 2017-02-27 13:05:13 -08:00
Victor Vieux 80fa030ffd bump engine API to 1.26 (#1553)
Signed-off-by: Victor Vieux <victorvieux@gmail.com>
2017-02-08 13:18:24 -08:00
Daniel Suo 9e5e14f0e6 Add link to C SDK 2017-02-03 11:17:46 -05:00
Misty Stanley-Jones ef95a915eb Fixing broken links
Formatting improvements along the way
2017-01-25 11:51:14 -08:00
Ben Firshman e1a8edffab Fix title in Engine API getting started (#1259)
* Fix title in Engine API getting started

A weird character was causing it to not be rendered correctly.

Signed-off-by: Ben Firshman <ben@firshman.co.uk>

* Update getting-started.md
2017-01-20 11:46:30 -08:00
John Mulhausen f7f35a3824 Update sdks.md 2017-01-19 23:47:44 -08:00