Commit Graph

92 Commits

Author SHA1 Message Date
Milos Gajdos e396d7aa86
Change distribution URL to distribution/distribution (#13484)
* Change distribution URL to distribution/distribution
* Indent code
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-10-08 11:30:31 +01:00
Sebastiaan van Stijn 173d3c65f8
fix broken (anchor) links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-13 15:07:49 +02:00
Sebastiaan van Stijn f3da53a7b4
remove old compliance upstream resource
It's no longer referenced from the TOC, and redirects to the homepage.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-13 15:07:47 +02:00
Sebastiaan van Stijn 56e601033a
Some tweaks to the API styling
- Update the logo
- Make fonts and colors a bit more consistent with the rest of the docs
- Don't uppercase TOC menu items
- Update _fetch_upstream_resources script to make the logo-URL relative
  to the current website.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-06-09 17:14:58 +02:00
Sebastiaan van Stijn 688134003d
Use 20.10 release branch for upstream engine resources
The 20.10 release branch now exists, and "master" will be used for
Docker Engine 21.xx development.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-02-25 12:54:54 +01:00
Guillaume Tardif cd5bc70940 Include ACI/ECS reference docs from compose-cli and make them easier to find for docker users
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2021-01-04 16:16:12 +01:00
Sebastiaan van Stijn f8e886bf53
Revert "Temporarily fetch API v1.41 docs from tag"
This reverts commit 9a497cdf36,
as upstream changes have been merged, and it's no longer needed.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-12-11 09:17:36 +01:00
Sebastiaan van Stijn 9a497cdf36
Temporarily fetch API v1.41 docs from tag
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-12-09 00:50:18 +01:00
Sebastiaan van Stijn ba85012f47
Remove scripts and assets related to archives
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-06-24 13:25:58 +02:00
Sebastiaan van Stijn df740c8550
remove unused page from the "extends" section (#10799)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-05-13 12:22:52 +01:00
Sebastiaan van Stijn 3b2f3f6f06
Engine API: remove per-branch fetching of API docs
now that all API versions are unified in both the "master" and
release branches, we can fetch then all at once with svn.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-06 12:14:37 +02:00
Sebastiaan van Stijn a5ab6fa4f8
fetch-upstream-resources: fix .svn cleanup step
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-15 18:22:56 +01:00
Sebastiaan van Stijn 20267e58b9
prevent fetching resources when updating _config.yml or toc.yaml
The "fetch-upstream-resources" script also updated the toc.yaml,
based on values in the _config.yml.

As a result, any change in either the "_config.yml" or "toc.yaml"
would also result in the upstream resources to be fetched again.

This patch separates the step to update the toc, so that the
upstream resources can be cached. This _does_ mean that remote
sources can get outdated (only will be rebuilt when changing
ENGINE_BRANCH or DISTRIBUTION_BRANCH). That should not be a
problem for actual deployments, which don't use caching.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-28 14:18:17 +01:00
Sebastiaan van Stijn 7d22d25adf
fetch-upstream-resources: simplify parsing of _config.yml
This part of the script was setting variables for any "_version"
property in the configuration file.

We (currently) only need the engine API version, so simplifying
the code to just do that, and fix some spaces -> tabs indentations.

With this change the script only uses standard (POSIX) scripting,
so switching to use the standard (/bin/sh) shell.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-28 14:17:11 +01:00
Sebastiaan van Stijn f12fb8302f
fetch-upstream-resources: remove dead code for "LOCAL" variable
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-28 14:16:45 +01:00
Sebastiaan van Stijn adfdc8e0a0
fetch-upstream-resources: fix check for svn vars
These checks were now checking the literal "engine_svn_branch" and
"distribution_svn_branch" string, instead of the value of the variables.

This was introduced in 1f7d4ce871 (whoops!)

We currently don't use this functionality, so not a critical bug.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-28 14:16:43 +01:00
Sebastiaan van Stijn 3bbc3f5a25
Update directories to ignore/cleanup
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-25 14:01:01 +01:00
Sebastiaan van Stijn fbbc9498ae
fetch-upstream-resources: use cli repository instead of mono-repo
The docker/docker-ce repository components are only synchronized
periodically with the upstream docker/cli repository.

This patch switches the script to directly use the upstream cli
repository, instead of the docker-ce mono-repo.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-25 14:00:59 +01:00
Sebastiaan van Stijn 6dab89c905
Engine API: unify APIs: fetch from single branch
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>
2020-02-25 14:00:55 +01:00
Sebastiaan van Stijn 8271acddec
fetch-upstream-resources: cleanup .svn directories
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-25 13:15:07 +01:00
Sebastiaan van Stijn 4434435ac7
fetch-upstream-resources: enforce _BRANCH vars to be set upfront
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-25 13:15:05 +01:00
Sebastiaan van Stijn 1f7d4ce871
Remove "svn" env-vars for branches
Don't require these to be set upfront, as we can create them
locally in the fetch-upstream-resources.sh script

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-25 13:15:03 +01:00
Dawn W Docker 5412158dda moving references to the compliance repo 2020-02-06 14:07:57 -08:00
Sebastiaan van Stijn 9f8a849089
Use current release branch for current API docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-03 14:34:38 +01:00
Sebastiaan van Stijn fd4ba21c68
Use v18.09.9 tag for API v1.39
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-03 14:32:01 +01:00
Sebastiaan van Stijn 72a2575c10
Use v18.06.3-ce tag for API v1.38
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-03 14:28:27 +01:00
Sebastiaan van Stijn 80e46fed88
Use v18.03.1-ce tag for API v1.37
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-03 14:26:37 +01:00
Sebastiaan van Stijn e6c656027e
Use v18.02.0-ce tag for API v1.36
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-03 14:21:07 +01:00
Sebastiaan van Stijn c7d08f88d3
Use v17.12.1-ce tag for API v1.35
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-03 14:16:38 +01:00
Sebastiaan van Stijn 83850917f3
Use v17.11.0-ce tag for API v1.34
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-03 14:15:02 +01:00
Sebastiaan van Stijn 1b6374652d
Use v17.10.0-ce tag for API v1.33
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-03 14:11:29 +01:00
Sebastiaan van Stijn 5e3415cf80
Use v17.09.1-ce tag for API v1.32
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-03 14:09:51 +01:00
Sebastiaan van Stijn a0c6b80e9f
Use v17.07.0-ce tag for API v1.31
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-03 14:07:45 +01:00
Sebastiaan van Stijn dc3c4349bb
Use v17.06.2 tag for API v1.30
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-03 14:05:57 +01:00
Sebastiaan van Stijn 449d7c6d52
Use v17.05.0 tag for API v1.29
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-03 14:01:05 +01:00
Usha Mandya a556c61cf7
Merge pull request #9351 from thaJeztah/remove_library_samples
Remove library samples, and link to Docker Hub instead
2019-09-23 16:21:57 +02:00
Adrian Plata ec57364ede
fixing pull location (#9380)
Signed-off-by: Adrian Plata <adrian.plata@docker.com>
2019-09-06 08:22:46 -07:00
Sebastiaan van Stijn 9b47229953
Remove script and build-stage for fetching library samples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-09-04 00:03:10 +02:00
Sebastiaan van Stijn 5fe0fd326d
Exclude library samples from the sitemap
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-09-04 00:00:09 +02:00
Sebastiaan van Stijn d460cc2351
Library samples: convert to flat directory
Instead of creating a sub-directory containing an image.md for
each page, put all pages in a single directory.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-09-03 23:03:56 +02:00
Sebastiaan van Stijn f9f5f8dacd
Convert library samples to stubs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-09-03 23:03:51 +02:00
ollypom c39ba281fd
Synced Docs Public Master with Docs Private Master 2019-07-19 11:02:28 +00:00
ollypom 8121f4ef89
Updated Archive Script 2019-07-16 20:53:15 +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 8bd9e68bb6
Bump engine version to 19.03
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-06-13 14:53:21 +02:00
Sebastiaan van Stijn 573af666e4
Move fetching "library samples" to a separate stage
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-03-07 16:27:20 +01:00
Sebastiaan van Stijn d2504d31dc
Reorder fetching of upstream-resources
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-03-07 15:31:51 +01:00
Sebastiaan van Stijn f297c554b6
Remove remaining "edge" docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-03-07 15:29:06 +01:00
Sebastiaan van Stijn 0785a8513e
Make wget less noisy when fetching upstream resources
Add a `--quiet` flag to suppress progress output;

```
--2019-03-07 14:02:43--  https://raw.githubusercontent.com/docker/docker-ce/17.12/components/engine/api/swagger.yaml
Resolving raw.githubusercontent.com... 151.101.0.133, 151.101.64.133, 151.101.128.133, ...
Connecting to raw.githubusercontent.com|151.101.0.133|:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: 343126 (335K) [text/plain]
Saving to: './engine/api/v1.35/swagger.yaml'

     0K .......... .......... .......... .......... .......... 14% 2.97M 0s
    50K .......... .......... .......... .......... .......... 29% 6.10M 0s
   100K .......... .......... .......... .......... .......... 44% 6.22M 0s
   150K .......... .......... .......... .......... .......... 59% 6.32M 0s
   200K .......... .......... .......... .......... .......... 74% 6.15M 0s
   250K .......... .......... .......... .......... .......... 89% 6.11M 0s
   300K .......... .......... .......... .....                100% 6.82M=0.06s

2019-03-07 14:02:44 (5.37 MB/s) - './engine/api/v1.35/swagger.yaml' saved [343126/343126]
```

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-03-07 15:27:06 +01:00
Sebastiaan van Stijn 5d8ce076f7
Dockerfile: remove use of $SOURCE env-var
This variable is no longer needed, as the scripts are
always executed relative to the current directory (`.`).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-03-06 15:10:07 +01:00