From 1e4ecd6341ad9cc0e667c46d2408e18d2a17ba17 Mon Sep 17 00:00:00 2001 From: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Date: Thu, 12 Jan 2023 08:44:58 +0000 Subject: [PATCH] Update reference overview page (#16454) * Update reference overview page * add blocks * add icons * Update reference/index.md --- assets/images/authentication.svg | 1 + assets/images/compose-cli.svg | 1 + assets/images/data.svg | 1 + assets/images/engine-api.svg | 1 + assets/images/image.svg | 1 + assets/images/manage.svg | 1 + assets/images/storage.svg | 1 + assets/images/terminal.svg | 1 + reference/index.md | 156 ++++++++++++++++++++++++++----- 9 files changed, 141 insertions(+), 23 deletions(-) create mode 100644 assets/images/authentication.svg create mode 100644 assets/images/compose-cli.svg create mode 100644 assets/images/data.svg create mode 100644 assets/images/engine-api.svg create mode 100644 assets/images/image.svg create mode 100644 assets/images/manage.svg create mode 100644 assets/images/storage.svg create mode 100644 assets/images/terminal.svg diff --git a/assets/images/authentication.svg b/assets/images/authentication.svg new file mode 100644 index 0000000000..5b000f4a6f --- /dev/null +++ b/assets/images/authentication.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/compose-cli.svg b/assets/images/compose-cli.svg new file mode 100644 index 0000000000..f31c2423ac --- /dev/null +++ b/assets/images/compose-cli.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/data.svg b/assets/images/data.svg new file mode 100644 index 0000000000..49c2ae2476 --- /dev/null +++ b/assets/images/data.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/engine-api.svg b/assets/images/engine-api.svg new file mode 100644 index 0000000000..67a9cedd6b --- /dev/null +++ b/assets/images/engine-api.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/image.svg b/assets/images/image.svg new file mode 100644 index 0000000000..b6a4658b0d --- /dev/null +++ b/assets/images/image.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/manage.svg b/assets/images/manage.svg new file mode 100644 index 0000000000..4aa4b3ba31 --- /dev/null +++ b/assets/images/manage.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/storage.svg b/assets/images/storage.svg new file mode 100644 index 0000000000..316a26ffab --- /dev/null +++ b/assets/images/storage.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/terminal.svg b/assets/images/terminal.svg new file mode 100644 index 0000000000..b0934ac363 --- /dev/null +++ b/assets/images/terminal.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/reference/index.md b/reference/index.md index 458e1b70e3..ef0560fe6a 100644 --- a/reference/index.md +++ b/reference/index.md @@ -5,38 +5,148 @@ notoc: true --- This section includes the reference documentation for the Docker platform's -various APIs, CLIs, and file formats. +various APIs, CLIs, drivers and specifications, and file formats. ## File formats -| File format | Description | -|:--------------------------------------------------------------------|:----------------------------------------------------------------| -| [Dockerfile](/engine/reference/builder/) | Defines the contents and startup behavior of a single container | -| [Compose file](/compose/compose-file/) | Defines a multi-container application | - +
+ +
+
+
+
+ Download and install +
+

Dockerfile

+

Defines the contents and startup behavior of a single container.

+
+
+
+
+
+ Release notes +
+

Compose file

+

Defines a multi-container application.

+
+
+
+
## Command-line interfaces (CLIs) -| CLI | Description | -|:---------------------------------------------------------------|:-------------------------------------------------------------------------------------------| -| [Docker CLI](/engine/reference/commandline/cli/) | The main CLI for Docker, includes all `docker` commands | -| [Compose CLI](/compose/reference/) | The CLI for Docker Compose, which allows you to build and run multi-container applications | -| [Daemon CLI (dockerd)](/engine/reference/commandline/dockerd/) | Persistent process that manages containers | - +
+ +
+
+
+
+ Docker CLI +
+

Docker CLI

+

The main CLI for Docker, includes all docker commands.

+
+
+
+
+
+ Compose CLI +
+

Compose CLI

+

The CLI for Docker Compose, which allows you to build and run multi-container applications.

+
+
+
+
+
+ Give feedback +
+

Daemon CLI (dockerd)

+

Persistent process that manages containers.

+
+
+
+
## Application programming interfaces (APIs) -| API | Description | -|:------------------------------------------------------|:---------------------------------------------------------------------------------------| -| [Engine API](/engine/api/) | The main API for Docker, provides programmatic access to a daemon | -| [Registry API](/registry/spec/api/) | Facilitates distribution of images to the engine | -| [Docker Hub API](/docker-hub/api/latest/) | API to interact with Docker Hub | -| [DVP Data API](/docker-hub/api/dvp/) | API for Docker Verified Publishers to fetch analytics data | +
+ +
+
+
+
+ Engine API +
+

Engine API

+

The main API for Docker, provides programmatic access to a daemon.

+
+
+
+
+
+ Registry API +
+

Registry API

+

Facilitates distribution of images to the engine.

+
+
+
+ +
+
+
+
+ Docker Hub API +
+

Docker Hub API

+

API to interact with Docker Hub.

+
+
+
+
+
+ DVP Data API +
+

DVP Data API

+

API for Docker Verified Publishers to fetch analytics data.

+
+
+
+
## Drivers and specifications -| Driver | Description | -|:-------------------------------------------------------|:-----------------------------------------------------------------------------------| -| [Image specification](/registry/spec/manifest-v2-2/) | Describes the various components of a Docker image | -| [Registry token authentication](/registry/spec/auth/) | Outlines the Docker Registry authentication scheme | -| [Registry storage drivers](/registry/storage-drivers/) | Enables support for given cloud providers when storing images with Registry | +
+ +
+
+
+
+ Image specification +
+

Image specification

+

Describes the various components of a Docker image.

+
+
+
+
+
+ Registry token authentication +
+

Registry token authentication

+

Outlines the Docker Registry authentication schemes.

+
+
+
+
+
+ Registry storage drivers +
+

Registry storage drivers

+

Enables support for given cloud providers when storing images with Registry.

+
+
+
+
+