Skip to content

Commit a26d380

Browse files
authored
ENGDOCS-2179 (#20591)
* ENGDOCS-2179 * link fix * more link fix * final link fix
1 parent 79ff211 commit a26d380

File tree

92 files changed

+252
-135
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+252
-135
lines changed

.github/CODEOWNERS

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@
1111

1212
/content/desktop/ @aevesdocker
1313

14-
/content/desktop/extensions/ @aevesdocker
14+
/content/extensions/ @aevesdocker
1515

16-
/content/desktop/extensions-sdk/ @aevesdocker
16+
/content/extensions-sdk/ @aevesdocker
1717

1818
/content/scout/ @dvdksn
1919

20-
/content/docker-hub/ @aevesdocker @craig-osterhout @stephaurelio
20+
/content/docker-hub/ @aevesdocker @craig-osterhout
2121

2222
/content/engine/ @dvdksn
2323

24-
/content/subscription/ @aevesdocker @stephaurelio
24+
/content/subscription/ @aevesdocker
2525

26-
/content/docker-hub/publish/ @aevesdocker
26+
/content/docker-hub/publish/ @craig-osterhout
2727

28-
/content/docker-hub/official_images/ @aevesdocker
28+
/content/docker-hub/official_images/ @craig-osterhout
2929

3030
/content/registry/ @dvdksn
3131

.github/labeler.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ area/configuration:
111111
area/extensions:
112112
- changed-files:
113113
- any-glob-to-any-file:
114-
- content/desktop/extensions/**
115-
- content/desktop/extensions-sdk/**
114+
- content/extensions/**
115+
- content/extensions/extensions-sdk/**
116116

117117
area/samples:
118118
- changed-files:

content/desktop/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Docker Desktop reduces the time spent on complex setups so you can focus on writ
5454
- Docker CLI client
5555
- [Docker Scout](../scout/_index.md) (additional subscription may apply)
5656
- [Docker Build](../build/_index.md)
57-
- [Docker Extensions](./extensions/_index.md)
57+
- [Docker Extensions](../extensions/_index.md)
5858
- [Docker Compose](../compose/_index.md)
5959
- [Docker Content Trust](../engine/security/trust/_index.md)
6060
- [Kubernetes](https://github.com/kubernetes/kubernetes/)

content/desktop/settings/linux.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ Use the **Extensions** tab to:
257257
- **Allow only extensions distributed through the Docker Marketplace**
258258
- **Show Docker Extensions system containers**
259259

260-
For more information about Docker extensions, see [Extensions](../extensions/index.md).
260+
For more information about Docker extensions, see [Extensions](/extensions/index.md).
261261

262262
## Features in development
263263

content/desktop/settings/mac.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ Use the **Extensions** tab to:
299299
- **Allow only extensions distributed through the Docker Marketplace**
300300
- **Show Docker Extensions system containers**
301301

302-
For more information about Docker extensions, see [Extensions](../extensions/index.md).
302+
For more information about Docker extensions, see [Extensions](/extensions/index.md).
303303

304304
## Features in development
305305

content/desktop/settings/windows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ Use the **Extensions** tab to:
346346
- **Allow only extensions distributed through the Docker Marketplace**
347347
- **Show Docker Extensions system containers**
348348

349-
For more information about Docker extensions, see [Extensions](../extensions/index.md).
349+
For more information about Docker extensions, see [Extensions](/extensions/index.md).
350350

351351
## Features in development
352352

content/desktop/extensions/_index.md renamed to content/extensions/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
description: Extensions
33
keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows
44
title: Overview of Docker Extensions
5-
toc_min: 1
6-
toc_max: 2
5+
aliases:
6+
- /desktop/extensions/
77
---
88

99
Docker Extensions let you use third-party tools within Docker Desktop to extend its functionality.
1010

11-
You can seamlessly connect your favorite development tools to your application development and deployment workflows. Augment Docker Desktop with debugging, testing, security, and networking functionalities, and create custom add-ons using the Extensions [SDK](../extensions-sdk/index.md).
11+
You can seamlessly connect your favorite development tools to your application development and deployment workflows. Augment Docker Desktop with debugging, testing, security, and networking functionalities, and create custom add-ons using the Extensions [SDK](extensions-sdk/index.md).
1212

1313
Anyone can use Docker Extensions and there is no limit to the number of extensions you can install.
1414

content/desktop/extensions-sdk/_index.md renamed to content/extensions/extensions-sdk/_index.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,33 @@ title: Overview of the Extensions SDK
33
description: Overall index for Docker Extensions SDK documentation
44
keywords: Docker, Extensions, sdk
55
aliases:
6-
- /desktop/extensions-sdk/dev/overview/
6+
- /desktop/extensions-sdk/dev/overview/
7+
- /desktop/extensions-sdk/
78
grid:
89
- title: "The build and publish process"
910
description: Understand the process for building and publishing an extension.
1011
icon: "checklist"
11-
link: "/desktop/extensions-sdk/process/"
12+
link: "/extensions/extensions-sdk/process/"
1213
- title: "Quickstart guide"
1314
description: Follow the quickstart guide to create a basic Docker extension quickly.
1415
icon: "explore"
15-
link: "/desktop/extensions-sdk/quickstart/"
16+
link: "/extensions/extensions-sdk/quickstart/"
1617
- title: "View the design guidelines"
1718
description: Ensure your extension aligns to Docker's design guidelines and principles.
1819
icon: "design_services"
19-
link: "/desktop/extensions-sdk/design/design-guidelines/"
20+
link: "/extensions/extensions-sdk/design/design-guidelines/"
2021
- title: "Publish your extension"
2122
description: Understand how to publish your extension to the Marketplace.
2223
icon: "publish"
23-
link: "/desktop/extensions-sdk/extensions/"
24+
link: "/extensions/extensions-sdk/extensions/"
2425
- title: "Interacting with Kubernetes"
2526
description: Find information on how to interact indirectly with a Kubernetes cluster from your Docker extension.
2627
icon: "multiple_stop"
27-
link: "/desktop/extensions-sdk/dev/kubernetes/"
28+
link: "/extensions/extensions-sdk/guides/kubernetes/"
2829
- title: "Multi-arch extensions"
2930
description: Build your extension for multiple architectures.
3031
icon: "content_copy"
31-
link: "/desktop/extensions-sdk/extensions/multi-arch/"
32+
link: "/extensions/extensions-sdk/extensions/multi-arch/"
3233
---
3334

3435
The resources in this section help you create your own Docker extension.

content/desktop/extensions-sdk/architecture/_index.md renamed to content/extensions/extensions-sdk/architecture/_index.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: Extension architecture
33
description: Docker extension architecture
44
keywords: Docker, extensions, sdk, metadata
5+
aliases:
6+
- /desktop/extensions-sdk/architecture/
57
---
68

79
Extensions are applications that run inside the Docker Desktop. They're packaged as Docker images, distributed
@@ -13,19 +15,19 @@ Extensions can be composed of three (optional) components:
1315
- A backend: One or many containerised services running in the Docker Desktop VM
1416
- Executables: Shell scripts or binaries that Docker Desktop copies on the host when installing the extension
1517

16-
![Overview of the three components of an extension](./images/extensions-architecture.png?w=600h=400)
18+
![Overview of the three components of an extension](images/extensions-architecture.png?w=600h=400)
1719

1820
An extension doesn't necessarily need to have all these components, but at least one of them depending on the extension features.
1921
To configure and run those components, Docker Desktop uses a `metadata.json` file. See the
20-
[metadata](./metadata) section for more details.
22+
[metadata](metadata) section for more details.
2123

2224
## The frontend
2325

2426
The frontend is basically a web application made from HTML, Javascript, and CSS. It can be built with a simple HTML
2527
file, some vanilla Javascript or any frontend framework, such as React or Vue.js.
2628

2729
When Docker Desktop installs the extension, it extracts the UI folder from the extension image, as defined by the
28-
`ui` section in the `metadata.json`. See the [ui metadata section](./metadata.md#ui-section) for more details.
30+
`ui` section in the `metadata.json`. See the [ui metadata section](metadata.md#ui-section) for more details.
2931

3032
Every time users click on the **Extensions** tab, Docker Desktop initializes the extension's UI as if it was the first time. When they navigate away from the tab, both the UI itself and all the sub-processes started by it (if any) are terminated.
3133

@@ -60,7 +62,7 @@ file
6062

6163
Usually, the backend is made of one container that runs within the Docker Desktop VM. Internally, Docker Desktop creates
6264
a Docker Compose project, creates the container from the `image` option of the `vm` section of the `metadata.json`, and
63-
attaches it to the Compose project. See the [ui metadata section](./metadata.md#vm-section) for more details.
65+
attaches it to the Compose project. See the [ui metadata section](metadata.md#vm-section) for more details.
6466

6567
In some cases, a `compose.yml` file can be used instead of an `image`. This is useful when the backend container
6668
needs more specific options, such as mounting volumes or requesting [capabilities](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities)
@@ -79,7 +81,7 @@ or named pipe, depending on the operating system. If the backend was listening t
7981
prevent collision with other applications running on the host or in a container already. Also, some users are
8082
running Docker Desktop in constrained environments where they can't open ports on their machines.
8183

82-
![Backend and frontend communication](./images/extensions-arch-2.png?w=500h=300)
84+
![Backend and frontend communication](images/extensions-arch-2.png?w=500h=300)
8385

8486
Finally, the backend can be built with any technology, as long as it can run in a container and listen on a socket.
8587

@@ -95,15 +97,15 @@ Shipping those executables with the extension ensure that the CLI tool is always
9597
the users' machine.
9698

9799
When Docker Desktop installs the extension, it copies the executables on the host as defined by the `host` section in
98-
the `metadata.json`. See the [ui metadata section](./metadata.md#host-section) for more details.
100+
the `metadata.json`. See the [ui metadata section](metadata.md#host-section) for more details.
99101

100-
![Executable and frontend communication](./images/extensions-arch-3.png?w=250h=300)
102+
![Executable and frontend communication](images/extensions-arch-3.png?w=250h=300)
101103

102104
However, since they're executed on the users' machine, they have to be available to the platform they're running on.
103105
For example, if you want to ship the `kubectl` executable, you need to provide a different version for Windows, Mac,
104106
and Linux. Multi arch images will also need to include binaries built for the right arch (AMD / ARM)
105107

106108

107-
See the [host metadata section](./metadata.md#host-section) for more details.
109+
See the [host metadata section](metadata.md#host-section) for more details.
108110

109111
Learn how to [invoke host binaries](../guides/invoke-host-binaries.md).

0 commit comments

Comments
 (0)