Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_config_inspect.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ long: |-
By default, this renders all results in a JSON array. If a format is specified,
the given template will be executed for each result.

Go's [text/template](http://golang.org/pkg/text/template/) package
Go's [text/template](https://golang.org/pkg/text/template/) package
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The YAML files in the _data/engine-cli directory are generated from MarkDown source files in the CLI repository. For example, this page is generated from https://github.com/docker/cli/blob/master/docs/reference/commandline/config_inspect.md

So changes made in these YAML files will be overwritten when these files are regenerated and updated. Perhaps you're interested in opening a pull request with these changes in the CLI repository? https://github.com/docker/cli

When doing so, be sure to include a DCO sign-off line (Signed-Off-By) line in the commit message (see https://github.com/docker/cli/blob/master/CONTRIBUTING.md#sign-your-work), otherwise CI will fail in that repository.

I'm also happy to make those changes if you want

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see you're already using a DCO for your commits, so you probably don't need the instructions 😂

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay I'll take a look at docker/cli, thanks.

describes all the details of the format.

For detailed information about using configs, refer to [store configuration data using Docker Configs](https://docs.docker.com/engine/swarm/configs/).
Expand Down
4 changes: 2 additions & 2 deletions _data/engine-cli/docker_events.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -174,11 +174,11 @@ long: |-

If a format (`--format`) is specified, the given template will be executed
instead of the default
format. Go's [text/template](http://golang.org/pkg/text/template/) package
format. Go's [text/template](https://golang.org/pkg/text/template/) package
describes all the details of the format.

If a format is set to `{{json .}}`, the events are streamed as valid JSON
Lines. For information about JSON Lines, please refer to http://jsonlines.org/.
Lines. For information about JSON Lines, please refer to https://jsonlines.org/.
usage: docker events [OPTIONS]
pname: docker
plink: docker.yaml
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_info.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ long: |-
under different names is counted only once.

If a format is specified, the given template will be executed instead of the
default format. Go's [text/template](http://golang.org/pkg/text/template/) package
default format. Go's [text/template](https://golang.org/pkg/text/template/) package
describes all the details of the format.

Depending on the storage driver in use, additional information can be shown, such
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_kill.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ examples: |-
$ docker kill --signal=1 my_container
```

Refer to the [`signal(7)`](http://man7.org/linux/man-pages/man7/signal.7.html)
Refer to the [`signal(7)`](https://man7.org/linux/man-pages/man7/signal.7.html)
man-page for a list of standard Linux signals.
deprecated: false
experimental: false
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_node_inspect.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ long: |-
Returns information about a node. By default, this command renders all results
in a JSON array. You can specify an alternate format to execute a
given template for each result. Go's
[text/template](http://golang.org/pkg/text/template/) package describes all the
[text/template](https://golang.org/pkg/text/template/) package describes all the
details of the format.

> **Note**
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_secret_inspect.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ long: |-
By default, this renders all results in a JSON array. If a format is specified,
the given template will be executed for each result.

Go's [text/template](http://golang.org/pkg/text/template/) package
Go's [text/template](https://golang.org/pkg/text/template/) package
describes all the details of the format.

For detailed information about using secrets, refer to [manage sensitive data with Docker secrets](https://docs.docker.com/engine/swarm/secrets/).
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_service_create.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1588,7 +1588,7 @@ examples: |-
### Create services using templates

You can use templates for some flags of `service create`, using the syntax
provided by the Go's [text/template](http://golang.org/pkg/text/template/) package.
provided by the Go's [text/template](https://golang.org/pkg/text/template/) package.

The supported flags are the following :

Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_service_inspect.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ long: |-
By default, this renders all results in a JSON array. If a format is specified,
the given template will be executed for each result.

Go's [text/template](http://golang.org/pkg/text/template/) package
Go's [text/template](https://golang.org/pkg/text/template/) package
describes all the details of the format.

> **Note**
Expand Down
4 changes: 2 additions & 2 deletions _data/engine-cli/docker_system_events.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,11 @@ long: |-

If a format (`--format`) is specified, the given template will be executed
instead of the default
format. Go's [text/template](http://golang.org/pkg/text/template/) package
format. Go's [text/template](https://golang.org/pkg/text/template/) package
describes all the details of the format.

If a format is set to `{{json .}}`, the events are streamed as valid JSON
Lines. For information about JSON Lines, please refer to http://jsonlines.org/ .
Lines. For information about JSON Lines, please refer to https://jsonlines.org/ .
usage: docker system events [OPTIONS]
pname: docker system
plink: docker_system.yaml
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_version.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ long: |-
By default, this will render all version information in an easy to read
layout. If a format is specified, the given template will be executed instead.

Go's [text/template](http://golang.org/pkg/text/template/) package
Go's [text/template](https://golang.org/pkg/text/template/) package
describes all the details of the format.
usage: docker version [OPTIONS]
pname: docker
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_volume_create.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ examples: |-
`mount` command. You can provide multiple options by passing the `--opt` flag
multiple times. Some `mount` options (such as the `o` option) can take a
comma-separated list of options. Complete list of available mount options can be
found [here](http://man7.org/linux/man-pages/man8/mount.8.html).
found [here](https://man7.org/linux/man-pages/man8/mount.8.html).

For example, the following creates a `tmpfs` volume called `foo` with a size of
100 megabyte and `uid` of 1000.
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_volume_inspect.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ long: |-
Returns information about a volume. By default, this command renders all results
in a JSON array. You can specify an alternate format to execute a
given template for each result. Go's
[text/template](http://golang.org/pkg/text/template/) package describes all the
[text/template](https://golang.org/pkg/text/template/) package describes all the
details of the format.
usage: docker volume inspect [OPTIONS] VOLUME [VOLUME...]
pname: docker volume
Expand Down
8 changes: 4 additions & 4 deletions _data/glossary.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
aufs: |
aufs (advanced multi layered unification filesystem) is a Linux [filesystem](#filesystem) that
Docker supports as a storage backend. It implements the
[union mount](http://en.wikipedia.org/wiki/Union_mount) for Linux file systems.
[union mount](https://en.wikipedia.org/wiki/Union_mount) for Linux file systems.
base image: |
A **base image** has no parent image specified in its Dockerfile. It is created
using a Dockerfile with the `FROM scratch` directive.
btrfs: |
btrfs (B-tree file system) is a Linux [filesystem](#filesystem) that Docker
supports as a storage backend. It is a [copy-on-write](http://en.wikipedia.org/wiki/Copy-on-write)
supports as a storage backend. It is a [copy-on-write](https://en.wikipedia.org/wiki/Copy-on-write)
filesystem.
build: |
build is the process of building Docker images using a [Dockerfile](#dockerfile).
Expand Down Expand Up @@ -170,7 +170,7 @@ Machine: |

*Also known as : docker-machine*
namespace: |
A [Linux namespace](http://man7.org/linux/man-pages/man7/namespaces.7.html)
A [Linux namespace](https://man7.org/linux/man-pages/man7/namespaces.7.html)
is a Linux kernel feature that isolates and virtualizes system resources. Processes which are restricted to
a namespace can only interact with resources or processes that are part of the same namespace. Namespaces
are an important part of Docker's isolation model. Namespaces exist for each type of
Expand All @@ -189,7 +189,7 @@ overlay network driver: |
for docker containers in a cluster.
overlay storage driver: |
OverlayFS is a [filesystem](#filesystem) service for Linux which implements a
[union mount](http://en.wikipedia.org/wiki/Union_mount) for other file systems.
[union mount](https://en.wikipedia.org/wiki/Union_mount) for other file systems.
It is supported by the Docker daemon as a storage driver.
parent image: |
An image's **parent image** is the image designated in the `FROM` directive
Expand Down
4 changes: 2 additions & 2 deletions _includes/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@
</div>
<div class="footer_social_nav">
<ul class="nav-social">
<li class="fa fa-twitter"><a href="http://twitter.com/docker">Twitter</a></li>
<li class="fa fa-youtube"><a href="http://www.youtube.com/user/dockerrun">Youtube</a></li>
<li class="fa fa-twitter"><a href="https://twitter.com/docker">Twitter</a></li>
<li class="fa fa-youtube"><a href="https://www.youtube.com/user/dockerrun">Youtube</a></li>
<li class="fa fa-github"><a href="https://github.com/docker">GitHub</a></li>
<li class="fa fa-linkedin"><a href="https://www.linkedin.com/company/docker">Linkedin</a></li>
<li class="fa fa-facebook"><a href="https://www.facebook.com/docker.run">Facebook</a></li>
Expand Down
2 changes: 1 addition & 1 deletion _includes/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,6 @@
<meta property="og:url" content="https://docs.docker.com{{ page.url }}" />
<meta property="og:site_name" content="Docker Documentation" />
<meta property="article:published_time" itemprop="datePublished" content="{% if page.date %}{{ page.date | date_to_xmlschema }}{% else %}{{ site.time | date_to_xmlschema }}{% endif %}"/>
<script type="application/ld+json">{"@context":"http://schema.org","@type":"WebPage","headline":{{ page.title | default: page_title | jsonify }},"description":{{ page.description | default: page_description | jsonify }},"url":"https://docs.docker.com{{ page.url }}"}</script>
<script type="application/ld+json">{"@context":"https://schema.org","@type":"WebPage","headline":{{ page.title | default: page_title | jsonify }},"description":{{ page.description | default: page_description | jsonify }},"url":"https://docs.docker.com{{ page.url }}"}</script>
<!-- END SEO STUFF -->
</head>
2 changes: 1 addition & 1 deletion engine/swarm/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -981,7 +981,7 @@ The following examples show bind mount syntax:
### Create services using templates

You can use templates for some flags of `service create`, using the syntax
provided by the Go's [text/template](http://golang.org/pkg/text/template/)
provided by the Go's [text/template](https://golang.org/pkg/text/template/)
package.

The following flags are supported:
Expand Down
2 changes: 1 addition & 1 deletion get-started/09_image_best.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Tips for building the images for our application
## Security scanning

When you have built an image, it is a good practice to scan it for security vulnerabilities using the `docker scan` command.
Docker has partnered with [Snyk](http://snyk.io){:target="_blank" rel="noopener" class="_"} to provide the vulnerability scanning service.
Docker has partnered with [Snyk](https://snyk.io){:target="_blank" rel="noopener" class="_"} to provide the vulnerability scanning service.

> **Note**
>
Expand Down
2 changes: 1 addition & 1 deletion registry/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,5 +346,5 @@ which can be wired up to achieve interesting behavior. If this system doesn't
provide acceptable guarantees, adding a transactional `Sink` to the registry
is a possibility, although it may have an effect on request service time.
See the
[godoc](http://godoc.org/github.com/docker/distribution/notifications#Sink)
[godoc](https://godoc.org/github.com/docker/distribution/notifications#Sink)
for more information.
4 changes: 2 additions & 2 deletions registry/storage-drivers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This storage driver package comes bundled with several drivers:
- [s3](s3.md): A driver storing objects in an Amazon Simple Storage Service (S3) bucket.
- [azure](azure.md): A driver storing objects in [Microsoft Azure Blob Storage](https://azure.microsoft.com/en-us/services/storage/).
- [swift](swift.md): A driver storing objects in [Openstack Swift](https://docs.openstack.org/swift/latest/).
- [oss](oss.md): A driver storing objects in [Aliyun OSS](http://www.aliyun.com/product/oss).
- [oss](oss.md): A driver storing objects in [Aliyun OSS](https://www.aliyun.com/product/oss).
- [gcs](gcs.md): A driver storing objects in a [Google Cloud Storage](https://cloud.google.com/storage/) bucket.

## Storage driver API
Expand All @@ -33,7 +33,7 @@ validation of the `storagedriver.StorageDriver` interface.

## Driver selection and configuration

The preferred method of selecting a storage driver is using the `StorageDriverFactory` interface in the `storagedriver/factory` package. These factories provide a common interface for constructing storage drivers with a parameters map. The factory model is based on the [Register](http://golang.org/pkg/database/sql/#Register) and [Open](http://golang.org/pkg/database/sql/#Open) methods in the builtin [database/sql](http://golang.org/pkg/database/sql) package.
The preferred method of selecting a storage driver is using the `StorageDriverFactory` interface in the `storagedriver/factory` package. These factories provide a common interface for constructing storage drivers with a parameters map. The factory model is based on the [Register](https://golang.org/pkg/database/sql/#Register) and [Open](https://golang.org/pkg/database/sql/#Open) methods in the builtin [database/sql](https://golang.org/pkg/database/sql) package.

Storage driver factories may be registered by name using the
`factory.Register` method, and then later invoked by calling `factory.Create`
Expand Down