Skip to content

Commit 8eca808

Browse files
author
Victoria Bialas
committed
surfacing Learn by example topics to top level of Docker Engine docs
fixing links after moving surfacing tutorials fixing more links for the newly located tutorials Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
1 parent 0b879b9 commit 8eca808

File tree

23 files changed

+82
-62
lines changed

23 files changed

+82
-62
lines changed

docs/examples/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ This section contains the following:
1919
* [Dockerizing a CouchDB service](couchdb_data_volumes.md)
2020
* [Dockerizing a Redis service](running_redis_service.md)
2121
* [Dockerizing an apt-cacher-ng service](apt-cacher-ng.md)
22-
* [Dockerizing applications: A 'Hello world'](../userguide/containers/dockerizing.md)
22+
* [Dockerizing applications: A 'Hello world'](../tutorials/dockerizing.md)

docs/reference/builder.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ the `Using cache` message in the console output.
100100
Successfully built 7ea8aef582cc
101101

102102
When you're done with your build, you're ready to look into [*Pushing a
103-
repository to its registry*](../userguide/containers/dockerrepos.md#contributing-to-docker-hub).
103+
repository to its registry*](../tutorials/dockerrepos.md#contributing-to-docker-hub).
104104

105105
## Format
106106

@@ -474,7 +474,7 @@ Or
474474
The `FROM` instruction sets the [*Base Image*](glossary.md#base-image)
475475
for subsequent instructions. As such, a valid `Dockerfile` must have `FROM` as
476476
its first instruction. The image can be any valid image – it is especially easy
477-
to start by **pulling an image** from the [*Public Repositories*](../userguide/containers/dockerrepos.md).
477+
to start by **pulling an image** from the [*Public Repositories*](../tutorials/dockerrepos.md).
478478

479479
- `FROM` must be the first non-comment instruction in the `Dockerfile`.
480480

@@ -1171,7 +1171,7 @@ containers. The value can be a JSON array, `VOLUME ["/var/log/"]`, or a plain
11711171
string with multiple arguments, such as `VOLUME /var/log` or `VOLUME /var/log
11721172
/var/db`. For more information/examples and mounting instructions via the
11731173
Docker client, refer to
1174-
[*Share Directories via Volumes*](../userguide/containers/dockervolumes.md#mount-a-host-directory-as-a-data-volume)
1174+
[*Share Directories via Volumes*](../tutorials/dockervolumes.md#mount-a-host-directory-as-a-data-volume)
11751175
documentation.
11761176

11771177
The `docker run` command initializes the newly created volume with any data

docs/reference/commandline/export.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ the container, `docker export` will export the contents of the *underlying*
2323
directory, not the contents of the volume.
2424

2525
Refer to [Backup, restore, or migrate data
26-
volumes](../../userguide/containers/dockervolumes.md#backup-restore-or-migrate-data-volumes) in
26+
volumes](../../tutorials/dockervolumes.md#backup-restore-or-migrate-data-volumes) in
2727
the user guide for examples on exporting data in a volume.
2828

2929
## Examples

docs/reference/commandline/search.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ parent = "smn_cli"
2424

2525
Search [Docker Hub](https://hub.docker.com) for images
2626

27-
See [*Find Public Images on Docker Hub*](../../userguide/containers/dockerrepos.md#searching-for-images) for
27+
See [*Find Public Images on Docker Hub*](../../tutorials/dockerrepos.md#searching-for-images) for
2828
more details on finding shared images from the command line.
2929

3030
> **Note:**
@@ -124,5 +124,3 @@ This example displays images with a name containing 'busybox', at least
124124
NAME DESCRIPTION STARS OFFICIAL AUTOMATED
125125
progrium/busybox 50 [OK]
126126
radial/busyboxplus Full-chain, Internet enabled, busybox made... 8 [OK]
127-
128-

docs/reference/commandline/tag.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,31 +19,31 @@ parent = "smn_cli"
1919
An image name is made up of slash-separated name components, optionally prefixed
2020
by a registry hostname. The hostname must comply with standard DNS rules, but
2121
may not contain underscores. If a hostname is present, it may optionally be
22-
followed by a port number in the format `:8080`. If not present, the command
23-
uses Docker's public registry located at `registry-1.docker.io` by default. Name
24-
components may contain lowercase characters, digits and separators. A separator
25-
is defined as a period, one or two underscores, or one or more dashes. A name
22+
followed by a port number in the format `:8080`. If not present, the command
23+
uses Docker's public registry located at `registry-1.docker.io` by default. Name
24+
components may contain lowercase characters, digits and separators. A separator
25+
is defined as a period, one or two underscores, or one or more dashes. A name
2626
component may not start or end with a separator.
2727

2828
A tag name may contain lowercase and uppercase characters, digits, underscores,
2929
periods and dashes. A tag name may not start with a period or a dash and may
3030
contain a maximum of 128 characters.
3131

3232
You can group your images together using names and tags, and then upload them
33-
to [*Share Images via Repositories*](../../userguide/containers/dockerrepos.md#contributing-to-docker-hub).
33+
to [*Share Images via Repositories*](../../tutorials/dockerrepos.md#contributing-to-docker-hub).
3434

3535
# Examples
3636

3737
## Tagging an image referenced by ID
3838

39-
To tag a local image with ID "0e5574283393" into the "fedora" repository with
39+
To tag a local image with ID "0e5574283393" into the "fedora" repository with
4040
"version1.0":
4141

4242
docker tag 0e5574283393 fedora/httpd:version1.0
4343

4444
## Tagging an image referenced by Name
4545

46-
To tag a local image with name "httpd" into the "fedora" repository with
46+
To tag a local image with name "httpd" into the "fedora" repository with
4747
"version1.0":
4848

4949
docker tag httpd fedora/httpd:version1.0

docs/reference/commandline/volume_create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,4 @@ $ docker volume create --driver local --opt type=btrfs --opt device=/dev/sda2
7373
* [volume inspect](volume_inspect.md)
7474
* [volume ls](volume_ls.md)
7575
* [volume rm](volume_rm.md)
76-
* [Understand Data Volumes](../../userguide/containers/dockervolumes.md)
76+
* [Understand Data Volumes](../../tutorials/dockervolumes.md)

docs/reference/commandline/volume_inspect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,4 @@ Example output:
4545
* [volume create](volume_create.md)
4646
* [volume ls](volume_ls.md)
4747
* [volume rm](volume_rm.md)
48-
* [Understand Data Volumes](../../userguide/containers/dockervolumes.md)
48+
* [Understand Data Volumes](../../tutorials/dockervolumes.md)

docs/reference/commandline/volume_ls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,4 +81,4 @@ The following filter matches all volumes with a name containing the `rose` strin
8181
* [volume create](volume_create.md)
8282
* [volume inspect](volume_inspect.md)
8383
* [volume rm](volume_rm.md)
84-
* [Understand Data Volumes](../../userguide/containers/dockervolumes.md)
84+
* [Understand Data Volumes](../../tutorials/dockervolumes.md)

docs/reference/commandline/volume_rm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ Removes one or more volumes. You cannot remove a volume that is in use by a cont
2626
* [volume create](volume_create.md)
2727
* [volume inspect](volume_inspect.md)
2828
* [volume ls](volume_ls.md)
29-
* [Understand Data Volumes](../../userguide/containers/dockervolumes.md)
29+
* [Understand Data Volumes](../../tutorials/dockervolumes.md)

docs/reference/run.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1073,7 +1073,7 @@ Both flags take limits in the `<device-path>:<limit>` format. Both read and
10731073
write rates must be a positive integer.
10741074

10751075
## Additional groups
1076-
--group-add: Add additional groups to run as
1076+
--group-add: Add additional groups to run as
10771077

10781078
By default, the docker container process runs with the supplementary groups looked
10791079
up for the specified user. If one wants to add more to that list of groups, then
@@ -1497,8 +1497,8 @@ The example below mounts an empty tmpfs into the container with the `rw`,
14971497
> a volume.
14981498
14991499
The volumes commands are complex enough to have their own documentation
1500-
in section [*Managing data in
1501-
containers*](../userguide/containers/dockervolumes.md). A developer can define
1500+
in section [*Manage data in
1501+
containers*](../tutorials/dockervolumes.md). A developer can define
15021502
one or more `VOLUME`'s associated with an image, but only the operator
15031503
can give access from one container to another (or from a container to a
15041504
volume mounted on the host).
@@ -1527,7 +1527,7 @@ Dockerfile `USER` instruction. When starting a container, the operator can overr
15271527
the `USER` instruction by passing the `-u` option.
15281528

15291529
-u="", --user="": Sets the username or UID used and optionally the groupname or GID for the specified command.
1530-
1530+
15311531
The followings examples are all valid:
15321532
--user=[ user | user:group | uid | uid:gid | user:gid | uid:group ]
15331533

0 commit comments

Comments
 (0)