Creating Engine specific menu

Fixing the links Updating with Seb's comments Adding weight Fixing the engine aliases Updating after Arun pushed Removing empty file Signed-off-by: Mary Anthony <mary@docker.com> Upstream-commit: 7910f01804 Component: cli
2017-06-02 00:07:26 +00:00
parent 196808c668
commit b82ff962b6
14 changed files with 228 additions and 58 deletions
@@ -4,7 +4,8 @@ title = "Dockerfile reference"
 description = "Dockerfiles use a simple DSL which allows you to automate the steps you would normally manually take to create an image."
 keywords = ["builder, docker, Dockerfile, automation,  image creation"]
 [menu.main]
-parent = "mn_reference"
+parent = "engine_ref"
+weight=-90
 +++
 <![end-metadata]-->

@@ -18,7 +19,7 @@ instructions in succession.

 This page describes the commands you can use in a `Dockerfile`. When you are
 done reading this page, refer to the [`Dockerfile` Best
-Practices](../articles/dockerfile_best-practices.md) for a tip-oriented guide.
+Practices](../userguide/eng-image/dockerfile_best-practices.md) for a tip-oriented guide.

 ## Usage

@@ -80,7 +81,7 @@ instructions.
 Whenever possible, Docker will re-use the intermediate images (cache),
 to accelerate the `docker build` process significantly. This is indicated by
 the `Using cache` message in the console output.
-(For more information, see the [Build cache section](../articles/dockerfile_best-practices.md#build-cache)) in the
+(For more information, see the [Build cache section](../userguide/eng-image/dockerfile_best-practices.md#build-cache)) in the
 `Dockerfile` best practices guide:

    $ docker build -t svendowideit/ambassador .
@@ -99,7 +100,7 @@ the `Using cache` message in the console output.
    Successfully built 7ea8aef582cc

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

 ## Format

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

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

@@ -369,7 +370,7 @@ cache for `RUN` instructions can be invalidated by using the `--no-cache`
 flag, for example `docker build --no-cache`.

 See the [`Dockerfile` Best Practices
-guide](../articles/dockerfile_best-practices.md#build-cache) for more information.
+guide](../userguide/eng-image/dockerfile_best-practices.md#build-cache) for more information.

 The cache for `RUN` instructions can be invalidated by `ADD` instructions. See
 [below](#add) for details.
@@ -608,7 +609,7 @@ of whether or not the file has changed and the cache should be updated.
 > following instructions from the Dockerfile if the contents of `<src>` have
 > changed. This includes invalidating the cache for `RUN` instructions.
 > See the [`Dockerfile` Best Practices
-guide](../articles/dockerfile_best-practices.md#build-cache) for more information.
+guide](../userguide/eng-image/dockerfile_best-practices.md#build-cache) for more information.


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

 The `docker run` command initializes the newly created volume with any data
@@ -23,7 +23,7 @@ the container, `docker export` will export the contents of the *underlying*
 directory, not the contents of the volume.

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

 ## Examples
@@ -1,11 +1,12 @@
 <!-- [metadata]>
 +++
-title = "Docker Engine Commands"
+title = "Command line reference"
 description = "Docker's CLI command description and usage"
 keywords = ["Docker, Docker documentation, CLI,  command line"]
 [menu.main]
 identifier= "smn_cli"
-parent = "mn_reference"
+parent = "engine_ref"
+weight=-70
 +++
 <![end-metadata]-->

@@ -21,7 +21,7 @@ parent = "smn_cli"

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

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

 > **Note:**
@@ -17,4 +17,4 @@ parent = "smn_cli"
      --help               Print usage

 You can group your images together using names and tags, and then upload them
-to [*Share Images via Repositories*](../../userguide/dockerrepos.md#contributing-to-docker-hub).
+to [*Share Images via Repositories*](../../userguide/containers/dockerrepos.md#contributing-to-docker-hub).
@@ -0,0 +1,18 @@
+<!-- [metadata]>
+++
+title = "Engine reference"
+description = "Docker Engine reference"
+keywords = ["Engine"]
+[menu.main]
+parent="engine_use"
+identifier="engine_ref"
+weight=70
+++
+<![end-metadata]-->
+
+# Engine reference
+
+* [Dockerfile reference](builder.md)
+* [Docker run reference](run.md)
+* [Command line reference](commandline/index.md)
+* [API Reference](api/index.md)
@@ -4,7 +4,8 @@ title = "Docker run reference"
 description = "Configure containers at runtime"
 keywords = ["docker, run, configure,  runtime"]
 [menu.main]
-parent = "mn_reference"
+parent = "engine_ref"
+weight=-80
 +++
 <![end-metadata]-->

@@ -550,7 +551,7 @@ The exit code from `docker run` gives information about why the container
 failed to run or why it exited.  When `docker run` exits with a non-zero code,
 the exit codes follow the `chroot` standard, see below:

-**_125_** if the error is with Docker daemon **_itself_** 
+**_125_** if the error is with Docker daemon **_itself_**

    $ docker run --foo busybox; echo $?
    # flag provided but not defined: --foo
@@ -573,7 +574,7 @@ the exit codes follow the `chroot` standard, see below:

 **_Exit code_** of **_contained command_** otherwise

-    $ docker run busybox /bin/sh -c 'exit 3' 
+    $ docker run busybox /bin/sh -c 'exit 3'
    # 3

 ## Clean up (--rm)
@@ -1000,9 +1001,9 @@ For example, to set `/dev/sda` device weight to `200`:
        ubuntu

 If you specify both the `--blkio-weight` and `--blkio-weight-device`, Docker
-uses the `--blkio-weight` as the default weight and uses `--blkio-weight-device` 
-to override this default with a new value on a specific device. 
-The following example uses a default weight of `300` and overrides this default 
+uses the `--blkio-weight` as the default weight and uses `--blkio-weight-device`
+to override this default with a new value on a specific device.
+The following example uses a default weight of `300` and overrides this default
 on `/dev/sda` setting that weight to `200`:

    $ docker run -it \
@@ -1018,7 +1019,7 @@ per second from `/dev/sda`:

 The `--device-write-bps` flag limits the write rate (bytes per second)to a device.
 For example, this command creates a container and limits the write rate to `1mb`
-per second for `/dev/sda`: 
+per second for `/dev/sda`:

    $ docker run -it --device-write-bps /dev/sda:1mb ubuntu

@@ -1061,7 +1062,7 @@ one can use this flag:
 By default, Docker containers are "unprivileged" and cannot, for
 example, run a Docker daemon inside a Docker container. This is because
 by default a container is not allowed to access any devices, but a
-"privileged" container is given access to all devices (see 
+"privileged" container is given access to all devices (see
 the documentation on [cgroups devices](https://www.kernel.org/doc/Documentation/cgroups/devices.txt)).

 When the operator executes `docker run --privileged`, Docker will enable
@@ -1195,7 +1196,7 @@ container's logging driver. The following options are supported:

 The `docker logs` command is available only for the `json-file` and `journald`
 logging drivers.  For detailed information on working with logging drivers, see
-[Configure a logging driver](logging/overview.md).
+[Configure a logging driver](../admin/logging/overview.md).


 ## Overriding Dockerfile image defaults
@@ -1383,7 +1384,7 @@ Similarly the operator can set the **hostname** with `-h`.
    --volumes-from="": Mount all volumes from the given container(s)

 > **Note**:
-> The auto-creation of the host path has been [*deprecated*](../misc/deprecated.md#auto-creating-missing-host-paths-for-bind-mounts).
+> The auto-creation of the host path has been [*deprecated*](../deprecated.md#auto-creating-missing-host-paths-for-bind-mounts).

 > **Note**:
 > When using systemd to manage the Docker daemon's start and stop, in the systemd
@@ -1395,7 +1396,7 @@ Similarly the operator can set the **hostname** with `-h`.

 The volumes commands are complex enough to have their own documentation
 in section [*Managing data in
-containers*](../userguide/dockervolumes.md). A developer can define
+containers*](../userguide/containers/dockervolumes.md). A developer can define
 one or more `VOLUME`'s associated with an image, but only the operator
 can give access from one container to another (or from a container to a
 volume mounted on the host).