Skip to content

Commit a6a887c

Browse files
glossary: add static terms (docker#22401)
<!--Delete sections as needed --> ## Description Reverted the glossary back to some static terms and instead added a tip to ask AI. https://deploy-preview-22401--docsdocker.netlify.app/reference/glossary/ ## Related issues or tickets <!-- Related issues, pull requests, or Jira tickets --> ## Reviews - [ ] Editorial review --------- Signed-off-by: Craig <[email protected]>
1 parent a86ab99 commit a6a887c

File tree

3 files changed

+130
-2
lines changed

3 files changed

+130
-2
lines changed

content/reference/glossary.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,21 @@ title: Glossary
33
description: Glossary of terms used around Docker
44
keywords: glossary, docker, terms, definitions
55
notoc: true
6+
layout: glossary
67
aliases:
78
- /engine/reference/glossary/
89
- /glossary/
910
---
1011

11-
Need a definition? Docker's AI-powered assistant can help. Select **Ask AI** in the
12-
top navigation and ask it to define a term.
12+
> [!TIP]
13+
>
14+
> Looking for a definition that's not listed or need a more context-aware
15+
> explanation?
16+
>
17+
> Try <a role="button" tabindex="0" class="open-kapa-widget">Ask AI</a>.
18+
19+
20+
<!--
21+
To edit/add/remove glossary entries, visit the YAML file at:
22+
https://github.com/docker/docs/blob/main/data/glossary.yaml
23+
-->

data/glossary.yaml

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
base image: |
2+
A base image is an image you designate in a `FROM` directive in a Dockerfile.
3+
It defines the starting point for your build.
4+
Dockerfile instructions create additional layers on top of the base image.
5+
A Dockerfile with the `FROM scratch` directive uses an empty base image.
6+
7+
build: |
8+
Build is the process of building Docker images using a Dockerfile. The build
9+
uses a Dockerfile and a "context". The context is the set of files in the
10+
directory in which the image is built.
11+
12+
container: |
13+
A container is a runnable instance of an image. You can start, stop, move, or
14+
delete a container using the Docker CLI or API. Containers are isolated from
15+
one another and the host system but share the OS kernel. They provide a
16+
lightweight and consistent way to run applications.
17+
18+
context: |
19+
A Docker context contains endpoint configuration for the Docker CLI to connect
20+
to different Docker environments, such as remote Docker hosts or Docker
21+
Desktop. Use `docker context use` to switch between contexts.
22+
23+
Docker CLI: |
24+
The Docker CLI is the command-line interface for interacting with the Docker
25+
Engine. It provides commands like `docker run`, `docker build`, `docker ps`,
26+
and others to manage Docker containers, images, and services.
27+
28+
Docker Compose: |
29+
Docker Compose is a tool for defining and running multi-container Docker
30+
applications using a YAML file (`compose.yaml`). With a single command, you
31+
can start all services defined in the configuration.
32+
33+
Docker Desktop: |
34+
Docker Desktop is an easy-to-install application for Windows, macOS, and Linux
35+
that provides a local Docker development environment. It includes Docker
36+
Engine, Docker CLI, Docker Compose, and a Kubernetes cluster.
37+
38+
Docker Engine: |
39+
Docker Engine is the client-server technology that creates and runs Docker
40+
containers. It includes the Docker daemon (`dockerd`), REST API, and the
41+
Docker CLI client.
42+
43+
Docker Hub: |
44+
Docker Hub is Docker’s public registry service where users can store, share,
45+
and manage container images. It hosts Docker Official Images, Verified
46+
Publisher content, and community-contributed images.
47+
48+
image: |
49+
An image is a read-only template used to create containers. It typically
50+
includes a base operating system and application code packaged together using
51+
a Dockerfile. Images are versioned using tags and can be pushed to or pulled
52+
from a container registry like Docker Hub.
53+
54+
layer: |
55+
In an image, a layer is a modification represented by an instruction in the
56+
Dockerfile. Layers are applied in sequence to the base image to create the
57+
final image. Unchanged layers are cached, making image builds faster and more
58+
efficient.
59+
60+
multi-architecture image: |
61+
A multi-architecture image is a Docker image that supports multiple CPU
62+
architectures, like `amd64` or `arm64`. Docker automatically pulls the correct
63+
architecture image for your platform when using a multi-arch image.
64+
65+
persistent storage: |
66+
Persistent storage or volume storage provides a way for containers to retain
67+
data beyond their lifecycle. This storage can exist on the host machine or an
68+
external storage system and is not tied to the container's runtime.
69+
70+
registry: |
71+
A registry is a storage and content delivery system for Docker images. The
72+
default public registry is Docker Hub, but you can also set up private
73+
registries using Docker Distribution.
74+
75+
volume: |
76+
A volume is a special directory within a container that bypasses the Union
77+
File System. Volumes are designed to persist data independently of the
78+
container lifecycle. Docker supports host, anonymous, and named volumes.

layouts/_default/glossary.html

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{{ define "left" }}
2+
{{ partial "sidebar/mainnav.html" . }}
3+
{{ partial "sidebar/sections.html" . }}
4+
{{ end }}
5+
6+
{{ define "main" }}
7+
{{ partial "breadcrumbs.html" . }}
8+
<article class="prose max-w-none dark:prose-invert">
9+
{{ with .Title }}
10+
<h1 class="scroll-mt-36">{{ . }}</h1>
11+
{{ end }}
12+
{{ with .Content }}
13+
{{ . }}
14+
{{ end }}
15+
<table>
16+
<thead>
17+
<tr>
18+
<th>Term</th>
19+
<th>Definition</th>
20+
</tr>
21+
</thead>
22+
<tbody>
23+
{{ range $term, $definition := site.Data.glossary }}
24+
<tr>
25+
<td class="not-prose">
26+
<a class="-top-16 relative" name="{{ $term | anchorize }}"></a>
27+
{{ $term }}
28+
</td>
29+
<td>{{ $definition | $.RenderString }}</td>
30+
</tr>
31+
{{ end }}
32+
</tbody>
33+
</table>
34+
</article>
35+
{{ end }}
36+
37+
{{ define "right" }}
38+
{{ partial "aside.html" . }}
39+
{{ end }}

0 commit comments

Comments
 (0)