diff --git a/.gitignore b/.gitignore index 366c6d8a5a..010dcf6657 100644 --- a/.gitignore +++ b/.gitignore @@ -6,5 +6,4 @@ _site/** .sass-cache/** CNAME Gemfile.lock -_samples/library/** _kbase/** diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 89d5f282ea..e3bda7862a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,7 @@ you give it a try! ### Overall doc improvements -Most commits will be made against the `master` branch. This include: +Most commits will be made against the `master` branch. This includes: - Conceptual and task-based information not specific to new features - Restructuring / rewriting diff --git a/Dockerfile b/Dockerfile index f91e3545d8..07e4dec0e3 100644 --- a/Dockerfile +++ b/Dockerfile @@ -64,15 +64,6 @@ COPY --from=docs/docker.github.io:v17.12 ${TARGET} ${TARGET} COPY --from=docs/docker.github.io:v18.03 ${TARGET} ${TARGET} COPY --from=docs/docker.github.io:v18.09 ${TARGET} ${TARGET} -# Fetch library samples (documentation from official images on Docker Hub) -# Only add the files that are needed to build these reference docs, so that -# these docs are only rebuilt if changes were made to the configuration. -# @todo find a way to build HTML in this stage, and still have them included in the navigation tree -FROM builderbase AS library-samples -COPY ./_scripts/fetch-library-samples.sh ./_scripts/ -COPY ./_samples/boilerplate.txt ./_samples/ -RUN bash ./_scripts/fetch-library-samples.sh - # Fetch upstream resources (reference documentation) # Only add the files that are needed to build these reference docs, so that # these docs are only rebuilt if changes were made to the configuration. @@ -86,7 +77,6 @@ RUN bash ./_scripts/fetch-upstream-resources.sh . # Build the current docs from the checked out branch FROM builderbase AS current COPY . . -COPY --from=library-samples /usr/src/app/md_source/. ./ COPY --from=upstream-resources /usr/src/app/md_source/. ./ # Build the static HTML, now that everything is in place diff --git a/_data/toc.yaml b/_data/toc.yaml index b494849ce4..3b29e9e293 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -285,7 +285,7 @@ guides: - path: /config/containers/runmetrics/ title: Container runtime metrics - path: /config/containers/resource_constraints/ - title: Limit a container's resources + title: Runtime options with Memory, CPUs, and GPUs - path: /config/labels-custom-metadata/ title: Apply custom metadata to containers nosync: true @@ -1257,9 +1257,6 @@ reference: samples: - path: /samples/#tutorial-labs title: Tutorial labs -- sectiontitle: Library references - section: - - generateTOC: library - sectiontitle: Sample applications section: - path: /samples/ @@ -1282,6 +1279,8 @@ samples: title: Riak - path: /engine/examples/running_ssh_service/ title: SSHd +- path: /samples/#library-references + title: Library references manuals: - sectiontitle: Docker Enterprise @@ -3994,6 +3993,12 @@ manuals: section: - path: /docker-hub/ title: Quickstart + - sectiontitle: Security and Authentication + section: + - path: /docker-hub/access-tokens/ + title: Managing Access Tokens + - path: /docker-hub/release-notes/ + title: Release notes - path: /docker-hub/repos/ title: Repositories - path: /docker-hub/official_images/ diff --git a/_includes/cli.md b/_includes/cli.md index cc28bc268c..d817dc48c7 100644 --- a/_includes/cli.md +++ b/_includes/cli.md @@ -33,13 +33,13 @@ your client and daemon API versions. > This command is experimental. > -> This command is experimental on the Docker daemon. It should not be used in production environments. +> This command is experimental on the Docker daemon. It should not be used in +> production environments. > To enable experimental features on the Docker daemon, edit the > [daemon.json](/engine/reference/commandline/dockerd.md#daemon-configuration-file) > and set `experimental` to `true`. > > {% include experimental.md %} -{: .important } {% endif %} @@ -47,12 +47,12 @@ your client and daemon API versions. > This command is experimental. > -> This command is experimental on the Docker client. It should not be used in production environments. +> This command is experimental on the Docker client. It should not be used in +> production environments. > To enable experimental features in the Docker CLI, edit the > [config.json](/engine/reference/commandline/cli.md#configuration-files) -> and set `experimental` to `enabled`. -> -> {% include experimental.md %} +> and set `experimental` to `enabled`. You can go [here](https://github.com/docker/docker.github.io/blob/master/_includes/experimental.md) +> for more information. {: .important } {% endif %} diff --git a/_includes/experimental.md b/_includes/experimental.md index 88cf393bf2..acab2783f5 100644 --- a/_includes/experimental.md +++ b/_includes/experimental.md @@ -1,6 +1,15 @@ -Experimental features provide early access to future product functionality. These features are intended for testing and feedback only as they may change between releases without warning or can be removed entirely from a future release. Experimental features must not be used in production environments. Docker does not offer support for experimental features. For more information, see [Experimental features](https://success.docker.com/article/experimental-features). +Experimental features provide early access to future product functionality. +These features are intended for testing and feedback only as they may change +between releases without warning or can be removed entirely from a future +release. Experimental features must not be used in production environments. +Docker does not offer support for experimental features. For more information, +see [Experimental features](https://success.docker.com/article/experimental-features). > -> To enable experimental features in the Docker CLI, edit the `config.json` file and set `experimental` to enabled. +> To enable experimental features in the Docker CLI, edit the `config.json` +> file and set `experimental` to enabled. > -> To enable experimental features from the Docker Desktop menu, click **Settings** (**Preferences** on macOS) > **Daemon** and then select the **Experimental features** check box. +> To enable experimental features from the Docker Desktop menu, click +> **Settings** (**Preferences** on macOS) > **Daemon** and then select the +> **Experimental features** check box. +{: .important } diff --git a/_includes/generateTOC.html b/_includes/generateTOC.html deleted file mode 100644 index d4db0fe9eb..0000000000 --- a/_includes/generateTOC.html +++ /dev/null @@ -1,3 +0,0 @@ -{% if include.tocToGenerate=="library"%}{% for thisPage in site.samples %} -