* Update examples.md for golang
calling, `defer cli.Close()`
to close the underline transport used by the client
* fixed indentation
* added cli.close() call in index.md
Co-authored-by: Mohd Sadiq <mohd.sadiq@akridata.com>
- Add missing code-hints (console, yaml)
- Consistently add an empty line after code-blocks
- Combine some examples where the output and the command were
put in separate blocks. With the "console" code-hint, this
is no longer nescessary.
- fix indentation in cloud/ecs-integration.md, which caused the
numbered-list to be interrupted.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Original: on line 18 we have `images, err := cli.ImageList(context.Background(), types.ImageListOptions{})` which gives us an error of:
```
# command-line-arguments
./main.go:12:2: ctx declared but not used
```
*Fix:* on line 18 we need to have `images, err := cli.ImageList(ctx, types.ImageListOptions{})`
Fixed go example:
1) so that it actually compiles, and
2) so that you get to see the output `hello world` in visual studio code's console (`Tty: true,`).
- Move getting started overview to /get-started/overview/
- Move engine installation files under /engine/
- Redirect the top-level /install/ to /get-docker/
- Updated titles in left-hand navigation
- Added back some pages to the navigation that were
currently not included.
- Reduce some steps in the installation pages
- Move devicemapper prerequisites to the devicemapper
storage driver page.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Now that the files are named `<api-version>.md`, we no longer need
to set a custom `api_version` property; instead we can use the filename
to detect what API version we're rendering.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The upstream (moby/moby) repository is unifying all API swagger files
to be in the release branch. With that change, it is no longer needed
to fetch each version of the API separately, and instead all versions
can be fetched at once.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
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>
* 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>
* Revert "Clarify patch and update cycles (#4894)"
This reverts commit 6b1577aa0d.
* Revert "Add pointer to latest API ref (#4892)"
This reverts commit a6b436d133.
