diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 6cf2746b67..45cb369902 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -11,21 +11,21 @@ /content/desktop/ @aevesdocker -/content/desktop/extensions/ @aevesdocker +/content/extensions/ @aevesdocker -/content/desktop/extensions-sdk/ @aevesdocker +/content/extensions-sdk/ @aevesdocker /content/scout/ @dvdksn -/content/docker-hub/ @aevesdocker @craig-osterhout @stephaurelio +/content/docker-hub/ @aevesdocker @craig-osterhout /content/engine/ @dvdksn -/content/subscription/ @aevesdocker @stephaurelio +/content/subscription/ @aevesdocker -/content/docker-hub/publish/ @aevesdocker +/content/docker-hub/publish/ @craig-osterhout -/content/docker-hub/official_images/ @aevesdocker +/content/docker-hub/official_images/ @craig-osterhout /content/registry/ @dvdksn diff --git a/.github/labeler.yml b/.github/labeler.yml index d6835d717b..cf1a52dbb7 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -111,8 +111,8 @@ area/configuration: area/extensions: - changed-files: - any-glob-to-any-file: - - content/desktop/extensions/** - - content/desktop/extensions-sdk/** + - content/extensions/** + - content/extensions/extensions-sdk/** area/samples: - changed-files: diff --git a/content/desktop/_index.md b/content/desktop/_index.md index 9c55896628..882ce814eb 100644 --- a/content/desktop/_index.md +++ b/content/desktop/_index.md @@ -54,7 +54,7 @@ Docker Desktop reduces the time spent on complex setups so you can focus on writ - Docker CLI client - [Docker Scout](../scout/_index.md) (additional subscription may apply) - [Docker Build](../build/_index.md) -- [Docker Extensions](./extensions/_index.md) +- [Docker Extensions](../extensions/_index.md) - [Docker Compose](../compose/_index.md) - [Docker Content Trust](../engine/security/trust/_index.md) - [Kubernetes](https://github.com/kubernetes/kubernetes/) diff --git a/content/desktop/settings/linux.md b/content/desktop/settings/linux.md index 5e091dd5d1..5cf5c7db59 100644 --- a/content/desktop/settings/linux.md +++ b/content/desktop/settings/linux.md @@ -257,7 +257,7 @@ Use the **Extensions** tab to: - **Allow only extensions distributed through the Docker Marketplace** - **Show Docker Extensions system containers** -For more information about Docker extensions, see [Extensions](../extensions/index.md). +For more information about Docker extensions, see [Extensions](/extensions/index.md). ## Features in development diff --git a/content/desktop/settings/mac.md b/content/desktop/settings/mac.md index 06faae4030..6804f39c7e 100644 --- a/content/desktop/settings/mac.md +++ b/content/desktop/settings/mac.md @@ -299,7 +299,7 @@ Use the **Extensions** tab to: - **Allow only extensions distributed through the Docker Marketplace** - **Show Docker Extensions system containers** -For more information about Docker extensions, see [Extensions](../extensions/index.md). +For more information about Docker extensions, see [Extensions](/extensions/index.md). ## Features in development diff --git a/content/desktop/settings/windows.md b/content/desktop/settings/windows.md index 7295ea2168..52fdef6aac 100644 --- a/content/desktop/settings/windows.md +++ b/content/desktop/settings/windows.md @@ -346,7 +346,7 @@ Use the **Extensions** tab to: - **Allow only extensions distributed through the Docker Marketplace** - **Show Docker Extensions system containers** -For more information about Docker extensions, see [Extensions](../extensions/index.md). +For more information about Docker extensions, see [Extensions](/extensions/index.md). ## Features in development diff --git a/content/desktop/extensions/_index.md b/content/extensions/_index.md similarity index 95% rename from content/desktop/extensions/_index.md rename to content/extensions/_index.md index 6b7c9585de..34046f829d 100644 --- a/content/desktop/extensions/_index.md +++ b/content/extensions/_index.md @@ -2,13 +2,13 @@ description: Extensions keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows title: Overview of Docker Extensions -toc_min: 1 -toc_max: 2 +aliases: + - /desktop/extensions/ --- Docker Extensions let you use third-party tools within Docker Desktop to extend its functionality. -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). +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). Anyone can use Docker Extensions and there is no limit to the number of extensions you can install. diff --git a/content/desktop/extensions-sdk/_index.md b/content/extensions/extensions-sdk/_index.md similarity index 82% rename from content/desktop/extensions-sdk/_index.md rename to content/extensions/extensions-sdk/_index.md index f4689353e3..3f7b1a380e 100644 --- a/content/desktop/extensions-sdk/_index.md +++ b/content/extensions/extensions-sdk/_index.md @@ -3,32 +3,33 @@ title: Overview of the Extensions SDK description: Overall index for Docker Extensions SDK documentation keywords: Docker, Extensions, sdk aliases: -- /desktop/extensions-sdk/dev/overview/ + - /desktop/extensions-sdk/dev/overview/ + - /desktop/extensions-sdk/ grid: - title: "The build and publish process" description: Understand the process for building and publishing an extension. icon: "checklist" - link: "/desktop/extensions-sdk/process/" + link: "/extensions/extensions-sdk/process/" - title: "Quickstart guide" description: Follow the quickstart guide to create a basic Docker extension quickly. icon: "explore" - link: "/desktop/extensions-sdk/quickstart/" + link: "/extensions/extensions-sdk/quickstart/" - title: "View the design guidelines" description: Ensure your extension aligns to Docker's design guidelines and principles. icon: "design_services" - link: "/desktop/extensions-sdk/design/design-guidelines/" + link: "/extensions/extensions-sdk/design/design-guidelines/" - title: "Publish your extension" description: Understand how to publish your extension to the Marketplace. icon: "publish" - link: "/desktop/extensions-sdk/extensions/" + link: "/extensions/extensions-sdk/extensions/" - title: "Interacting with Kubernetes" description: Find information on how to interact indirectly with a Kubernetes cluster from your Docker extension. icon: "multiple_stop" - link: "/desktop/extensions-sdk/dev/kubernetes/" + link: "/extensions/extensions-sdk/guides/kubernetes/" - title: "Multi-arch extensions" description: Build your extension for multiple architectures. icon: "content_copy" - link: "/desktop/extensions-sdk/extensions/multi-arch/" + link: "/extensions/extensions-sdk/extensions/multi-arch/" --- The resources in this section help you create your own Docker extension. diff --git a/content/desktop/extensions-sdk/architecture/_index.md b/content/extensions/extensions-sdk/architecture/_index.md similarity index 90% rename from content/desktop/extensions-sdk/architecture/_index.md rename to content/extensions/extensions-sdk/architecture/_index.md index a363f5e12d..31b215a93c 100644 --- a/content/desktop/extensions-sdk/architecture/_index.md +++ b/content/extensions/extensions-sdk/architecture/_index.md @@ -2,6 +2,8 @@ title: Extension architecture description: Docker extension architecture keywords: Docker, extensions, sdk, metadata +aliases: + - /desktop/extensions-sdk/architecture/ --- Extensions are applications that run inside the Docker Desktop. They're packaged as Docker images, distributed @@ -13,11 +15,11 @@ Extensions can be composed of three (optional) components: - A backend: One or many containerised services running in the Docker Desktop VM - Executables: Shell scripts or binaries that Docker Desktop copies on the host when installing the extension -![Overview of the three components of an extension](./images/extensions-architecture.png?w=600h=400) +![Overview of the three components of an extension](images/extensions-architecture.png?w=600h=400) An extension doesn't necessarily need to have all these components, but at least one of them depending on the extension features. To configure and run those components, Docker Desktop uses a `metadata.json` file. See the -[metadata](./metadata) section for more details. +[metadata](metadata) section for more details. ## The frontend @@ -25,7 +27,7 @@ The frontend is basically a web application made from HTML, Javascript, and CSS. file, some vanilla Javascript or any frontend framework, such as React or Vue.js. When Docker Desktop installs the extension, it extracts the UI folder from the extension image, as defined by the -`ui` section in the `metadata.json`. See the [ui metadata section](./metadata.md#ui-section) for more details. +`ui` section in the `metadata.json`. See the [ui metadata section](metadata.md#ui-section) for more details. 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. @@ -60,7 +62,7 @@ file Usually, the backend is made of one container that runs within the Docker Desktop VM. Internally, Docker Desktop creates a Docker Compose project, creates the container from the `image` option of the `vm` section of the `metadata.json`, and -attaches it to the Compose project. See the [ui metadata section](./metadata.md#vm-section) for more details. +attaches it to the Compose project. See the [ui metadata section](metadata.md#vm-section) for more details. In some cases, a `compose.yml` file can be used instead of an `image`. This is useful when the backend container 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 prevent collision with other applications running on the host or in a container already. Also, some users are running Docker Desktop in constrained environments where they can't open ports on their machines. -![Backend and frontend communication](./images/extensions-arch-2.png?w=500h=300) +![Backend and frontend communication](images/extensions-arch-2.png?w=500h=300) Finally, the backend can be built with any technology, as long as it can run in a container and listen on a socket. @@ -95,15 +97,15 @@ Shipping those executables with the extension ensure that the CLI tool is always the users' machine. When Docker Desktop installs the extension, it copies the executables on the host as defined by the `host` section in -the `metadata.json`. See the [ui metadata section](./metadata.md#host-section) for more details. +the `metadata.json`. See the [ui metadata section](metadata.md#host-section) for more details. -![Executable and frontend communication](./images/extensions-arch-3.png?w=250h=300) +![Executable and frontend communication](images/extensions-arch-3.png?w=250h=300) However, since they're executed on the users' machine, they have to be available to the platform they're running on. For example, if you want to ship the `kubectl` executable, you need to provide a different version for Windows, Mac, and Linux. Multi arch images will also need to include binaries built for the right arch (AMD / ARM) -See the [host metadata section](./metadata.md#host-section) for more details. +See the [host metadata section](metadata.md#host-section) for more details. Learn how to [invoke host binaries](../guides/invoke-host-binaries.md). \ No newline at end of file diff --git a/content/desktop/extensions-sdk/architecture/images/extensions-arch-2.png b/content/extensions/extensions-sdk/architecture/images/extensions-arch-2.png similarity index 100% rename from content/desktop/extensions-sdk/architecture/images/extensions-arch-2.png rename to content/extensions/extensions-sdk/architecture/images/extensions-arch-2.png diff --git a/content/desktop/extensions-sdk/architecture/images/extensions-arch-3.png b/content/extensions/extensions-sdk/architecture/images/extensions-arch-3.png similarity index 100% rename from content/desktop/extensions-sdk/architecture/images/extensions-arch-3.png rename to content/extensions/extensions-sdk/architecture/images/extensions-arch-3.png diff --git a/content/desktop/extensions-sdk/architecture/images/extensions-architecture.png b/content/extensions/extensions-sdk/architecture/images/extensions-architecture.png similarity index 100% rename from content/desktop/extensions-sdk/architecture/images/extensions-architecture.png rename to content/extensions/extensions-sdk/architecture/images/extensions-architecture.png diff --git a/content/desktop/extensions-sdk/architecture/metadata.md b/content/extensions/extensions-sdk/architecture/metadata.md similarity index 96% rename from content/desktop/extensions-sdk/architecture/metadata.md rename to content/extensions/extensions-sdk/architecture/metadata.md index 23798b5238..0d3c372d46 100644 --- a/content/desktop/extensions-sdk/architecture/metadata.md +++ b/content/extensions/extensions-sdk/architecture/metadata.md @@ -3,7 +3,8 @@ title: Extension metadata description: Docker extension metadata keywords: Docker, extensions, sdk, metadata aliases: -- /desktop/extensions-sdk/extensions/METADATA + - /desktop/extensions-sdk/extensions/METADATA + - /desktop/extensions-sdk/architecture/metadata/ --- ## The metadata.json file diff --git a/content/desktop/extensions-sdk/architecture/security.md b/content/extensions/extensions-sdk/architecture/security.md similarity index 91% rename from content/desktop/extensions-sdk/architecture/security.md rename to content/extensions/extensions-sdk/architecture/security.md index 906722e084..09c95f003a 100644 --- a/content/desktop/extensions-sdk/architecture/security.md +++ b/content/extensions/extensions-sdk/architecture/security.md @@ -3,7 +3,8 @@ title: Extension security description: Aspects of the security model of extensions keywords: Docker, extensions, sdk, security aliases: -- /desktop/extensions-sdk/guides/security/ + - /desktop/extensions-sdk/guides/security/ + - /desktop/extensions-sdk/architecture/security/ --- ## Extension capabilities diff --git a/content/desktop/extensions-sdk/build/backend-extension-tutorial.md b/content/extensions/extensions-sdk/build/backend-extension-tutorial.md similarity index 96% rename from content/desktop/extensions-sdk/build/backend-extension-tutorial.md rename to content/extensions/extensions-sdk/build/backend-extension-tutorial.md index 660fc56b68..0ca54cda48 100644 --- a/content/desktop/extensions-sdk/build/backend-extension-tutorial.md +++ b/content/extensions/extensions-sdk/build/backend-extension-tutorial.md @@ -3,9 +3,10 @@ title: Add a backend to your extension description: Learn how to add a backend to your extension. keywords: Docker, extensions, sdk, build aliases: -- /desktop/extensions-sdk/tutorials/minimal-backend-extension/ -- /desktop/extensions-sdk/build/minimal-backend-extension/ -- /desktop/extensions-sdk/build/set-up/backend-extension-tutorial/ + - /desktop/extensions-sdk/tutorials/minimal-backend-extension/ + - /desktop/extensions-sdk/build/minimal-backend-extension/ + - /desktop/extensions-sdk/build/set-up/backend-extension-tutorial/ + - /desktop/extensions-sdk/build/backend-extension-tutorial/ --- Your extension can ship a backend part with which the frontend can interact with. This page provides information on why and how to add a backend. @@ -20,7 +21,7 @@ Before you start, make sure you have installed the latest version of [Docker Des ## Why add a backend? Thanks to the Docker Extensions SDK, most of the time you should be able to do what you need from the Docker CLI -directly from [the frontend](./frontend-extension-tutorial.md#use-the-extension-apis-client). +directly from [the frontend](frontend-extension-tutorial.md#use-the-extension-apis-client). Nonetheless, there are some cases where you might need to add a backend to your extension. So far, extension builders have used the backend to: @@ -278,7 +279,7 @@ For more information on the `vm` section of the `metadata.json`, see [Metadata]( ## Invoke the extension backend from your frontend -Using the [advanced frontend extension example](./frontend-extension-tutorial.md), we can invoke our extension backend. +Using the [advanced frontend extension example](frontend-extension-tutorial.md), we can invoke our extension backend. Use the Docker Desktop Client object and then invoke the `/hello` route from the backend service with `ddClient. extension.vm.service.get` that returns the body of the response. diff --git a/content/desktop/extensions-sdk/build/frontend-extension-tutorial.md b/content/extensions/extensions-sdk/build/frontend-extension-tutorial.md similarity index 96% rename from content/desktop/extensions-sdk/build/frontend-extension-tutorial.md rename to content/extensions/extensions-sdk/build/frontend-extension-tutorial.md index 8340f1cde2..f2a979de2a 100644 --- a/content/desktop/extensions-sdk/build/frontend-extension-tutorial.md +++ b/content/extensions/extensions-sdk/build/frontend-extension-tutorial.md @@ -3,15 +3,16 @@ title: Create an advanced frontend extension description: Advanced frontend extension tutorial keywords: Docker, extensions, sdk, build aliases: -- /desktop/extensions-sdk/tutorials/react-extension/ -- /desktop/extensions-sdk/build/set-up/react-extension/ -- /desktop/extensions-sdk/build/set-up/minimal-frontend-using-docker-cli/ -- /desktop/extensions-sdk/build/set-up/frontend-extension-tutorial/ + - /desktop/extensions-sdk/tutorials/react-extension/ + - /desktop/extensions-sdk/build/set-up/react-extension/ + - /desktop/extensions-sdk/build/set-up/minimal-frontend-using-docker-cli/ + - /desktop/extensions-sdk/build/set-up/frontend-extension-tutorial/ + - /desktop/extensions-sdk/build/frontend-extension-tutorial/ --- To start creating your extension, you first need a directory with files which range from the extension’s source code to the required extension-specific files. This page provides information on how to set up an extension with a more advanced frontend. -Before you start, make sure you have installed the latest version of [Docker Desktop](../../release-notes.md). +Before you start, make sure you have installed the latest version of [Docker Desktop](/desktop/release-notes.md). ## Extension folder structure @@ -356,7 +357,7 @@ when you need to debug it. ## What's next? -- Add a [backend](./backend-extension-tutorial.md) to your extension. +- Add a [backend](backend-extension-tutorial.md) to your extension. - Learn how to [test and debug](../dev/test-debug.md) your extension. - Learn how to [setup CI for your extension](../dev/continuous-integration.md). - Learn more about extensions [architecture](../architecture/index.md). diff --git a/content/desktop/extensions-sdk/build/images/react-extension.png b/content/extensions/extensions-sdk/build/images/react-extension.png similarity index 100% rename from content/desktop/extensions-sdk/build/images/react-extension.png rename to content/extensions/extensions-sdk/build/images/react-extension.png diff --git a/content/desktop/extensions-sdk/build/images/types-autocomplete.png b/content/extensions/extensions-sdk/build/images/types-autocomplete.png similarity index 100% rename from content/desktop/extensions-sdk/build/images/types-autocomplete.png rename to content/extensions/extensions-sdk/build/images/types-autocomplete.png diff --git a/content/desktop/extensions-sdk/build/images/ui-minimal-extension.png b/content/extensions/extensions-sdk/build/images/ui-minimal-extension.png similarity index 100% rename from content/desktop/extensions-sdk/build/images/ui-minimal-extension.png rename to content/extensions/extensions-sdk/build/images/ui-minimal-extension.png diff --git a/content/desktop/extensions-sdk/build/minimal-frontend-extension.md b/content/extensions/extensions-sdk/build/minimal-frontend-extension.md similarity index 92% rename from content/desktop/extensions-sdk/build/minimal-frontend-extension.md rename to content/extensions/extensions-sdk/build/minimal-frontend-extension.md index 2224696a71..867a537976 100644 --- a/content/desktop/extensions-sdk/build/minimal-frontend-extension.md +++ b/content/extensions/extensions-sdk/build/minimal-frontend-extension.md @@ -3,13 +3,14 @@ title: Create a simple extension description: Minimal frontend extension tutorial keywords: Docker, extensions, sdk, build aliases: -- /desktop/extensions-sdk/tutorials/minimal-frontend-extension/ -- /desktop/extensions-sdk/build/set-up/minimal-frontend-extension/ + - /desktop/extensions-sdk/tutorials/minimal-frontend-extension/ + - /desktop/extensions-sdk/build/set-up/minimal-frontend-extension/ + - /desktop/extensions-sdk/build/minimal-frontend-extension/ --- To start creating your extension, you first need a directory with files which range from the extension’s source code to the required extension-specific files. This page provides information on how to set up a minimal frontend extension based on plain HTML. -Before you start, make sure you have installed the latest version of [Docker Desktop](../../release-notes.md). +Before you start, make sure you have installed the latest version of [Docker Desktop](/desktop/release-notes.md). > Tip > @@ -102,7 +103,7 @@ The left-hand menu displays a new tab with the name of your extension. ## What's next? -- Build a more [advanced frontend](./frontend-extension-tutorial.md) extension. +- Build a more [advanced frontend](frontend-extension-tutorial.md) extension. - Learn how to [test and debug](../dev/test-debug.md) your extension. - Learn how to [setup CI for your extension](../dev/continuous-integration.md). - Learn more about extensions [architecture](../architecture/index.md). \ No newline at end of file diff --git a/content/desktop/extensions-sdk/design/_index.md b/content/extensions/extensions-sdk/design/_index.md similarity index 96% rename from content/desktop/extensions-sdk/design/_index.md rename to content/extensions/extensions-sdk/design/_index.md index b2b5cc83ac..55a6bdfa10 100644 --- a/content/desktop/extensions-sdk/design/_index.md +++ b/content/extensions/extensions-sdk/design/_index.md @@ -3,8 +3,9 @@ title: UI styling overview for Docker extensions description: Docker extension design keywords: Docker, extensions, design aliases: -- /desktop/extensions-sdk/design/design-overview/ -- /desktop/extensions-sdk/design/overview/ + - /desktop/extensions-sdk/design/design-overview/ + - /desktop/extensions-sdk/design/overview/ + - /desktop/extensions-sdk/design/ --- Our Design System is a constantly evolving set of specifications that aim to ensure visual consistency across Docker products, and meet [level AA accessibility standards](https://www.w3.org/WAI/WCAG2AA-Conformance). We've opened parts of it to extension authors, documenting basic styles (color, typography) and components. See: [Docker Extensions Styleguide](https://www.figma.com/file/U7pLWfEf6IQKUHLhdateBI/Docker-Design-Guidelines?node-id=1%3A28771). diff --git a/content/desktop/extensions-sdk/design/design-guidelines.md b/content/extensions/extensions-sdk/design/design-guidelines.md similarity index 98% rename from content/desktop/extensions-sdk/design/design-guidelines.md rename to content/extensions/extensions-sdk/design/design-guidelines.md index cd4cc3df9e..c04fa36c59 100644 --- a/content/desktop/extensions-sdk/design/design-guidelines.md +++ b/content/extensions/extensions-sdk/design/design-guidelines.md @@ -2,6 +2,8 @@ title: Design guidelines for Docker extensions description: Docker extension design keywords: Docker, extensions, design +aliases: + - /desktop/extensions-sdk/design/design-guidelines/ --- At Docker, we aim to build tools that integrate into a user's existing workflows rather than requiring them to adopt new ones. We strongly recommend that you follow these guidelines when creating extensions. We review and approve your Marketplace publication based on these requirements. diff --git a/content/desktop/extensions-sdk/design/design-principles.md b/content/extensions/extensions-sdk/design/design-principles.md similarity index 95% rename from content/desktop/extensions-sdk/design/design-principles.md rename to content/extensions/extensions-sdk/design/design-principles.md index 7e90f00cd3..a193478664 100644 --- a/content/desktop/extensions-sdk/design/design-principles.md +++ b/content/extensions/extensions-sdk/design/design-principles.md @@ -2,6 +2,8 @@ title: Docker design principles description: Docker extension design keywords: Docker, extensions, design +aliases: + - /desktop/extensions-sdk/design/design-principles/ --- ## Provide actionable guidance diff --git a/content/desktop/extensions-sdk/design/images/complicated_flows.webp b/content/extensions/extensions-sdk/design/images/complicated_flows.webp similarity index 100% rename from content/desktop/extensions-sdk/design/images/complicated_flows.webp rename to content/extensions/extensions-sdk/design/images/complicated_flows.webp diff --git a/content/desktop/extensions-sdk/design/images/cta.webp b/content/extensions/extensions-sdk/design/images/cta.webp similarity index 100% rename from content/desktop/extensions-sdk/design/images/cta.webp rename to content/extensions/extensions-sdk/design/images/cta.webp diff --git a/content/desktop/extensions-sdk/design/images/header.webp b/content/extensions/extensions-sdk/design/images/header.webp similarity index 100% rename from content/desktop/extensions-sdk/design/images/header.webp rename to content/extensions/extensions-sdk/design/images/header.webp diff --git a/content/desktop/extensions-sdk/design/images/icon_colors.webp b/content/extensions/extensions-sdk/design/images/icon_colors.webp similarity index 100% rename from content/desktop/extensions-sdk/design/images/icon_colors.webp rename to content/extensions/extensions-sdk/design/images/icon_colors.webp diff --git a/content/desktop/extensions-sdk/design/images/light_dark_mode.webp b/content/extensions/extensions-sdk/design/images/light_dark_mode.webp similarity index 100% rename from content/desktop/extensions-sdk/design/images/light_dark_mode.webp rename to content/extensions/extensions-sdk/design/images/light_dark_mode.webp diff --git a/content/desktop/extensions-sdk/design/images/start_page.webp b/content/extensions/extensions-sdk/design/images/start_page.webp similarity index 100% rename from content/desktop/extensions-sdk/design/images/start_page.webp rename to content/extensions/extensions-sdk/design/images/start_page.webp diff --git a/content/desktop/extensions-sdk/design/images/switch_context_do.webp b/content/extensions/extensions-sdk/design/images/switch_context_do.webp similarity index 100% rename from content/desktop/extensions-sdk/design/images/switch_context_do.webp rename to content/extensions/extensions-sdk/design/images/switch_context_do.webp diff --git a/content/desktop/extensions-sdk/design/images/switch_context_dont.webp b/content/extensions/extensions-sdk/design/images/switch_context_dont.webp similarity index 100% rename from content/desktop/extensions-sdk/design/images/switch_context_dont.webp rename to content/extensions/extensions-sdk/design/images/switch_context_dont.webp diff --git a/content/desktop/extensions-sdk/design/images/terminal_window_do.webp b/content/extensions/extensions-sdk/design/images/terminal_window_do.webp similarity index 100% rename from content/desktop/extensions-sdk/design/images/terminal_window_do.webp rename to content/extensions/extensions-sdk/design/images/terminal_window_do.webp diff --git a/content/desktop/extensions-sdk/design/images/terminal_window_dont.webp b/content/extensions/extensions-sdk/design/images/terminal_window_dont.webp similarity index 100% rename from content/desktop/extensions-sdk/design/images/terminal_window_dont.webp rename to content/extensions/extensions-sdk/design/images/terminal_window_dont.webp diff --git a/content/desktop/extensions-sdk/design/mui-best-practices.md b/content/extensions/extensions-sdk/design/mui-best-practices.md similarity index 98% rename from content/desktop/extensions-sdk/design/mui-best-practices.md rename to content/extensions/extensions-sdk/design/mui-best-practices.md index 4de8039a4f..98c50a0b2c 100644 --- a/content/desktop/extensions-sdk/design/mui-best-practices.md +++ b/content/extensions/extensions-sdk/design/mui-best-practices.md @@ -2,6 +2,8 @@ title: MUI best practices description: Guidelines for using MUI to maximise compatibility with Docker Desktop keywords: Docker, extensions, mui, theme, theming, material-ui, material +aliases: + - /desktop/extensions-sdk/design/mui-best-practices/ --- This article assumes you're following our recommended practice by using our [Material UI theme](https://www.npmjs.com/package/@docker/docker-mui-theme). diff --git a/content/desktop/extensions-sdk/dev/api/backend.md b/content/extensions/extensions-sdk/dev/api/backend.md similarity index 98% rename from content/desktop/extensions-sdk/dev/api/backend.md rename to content/extensions/extensions-sdk/dev/api/backend.md index f982e02e10..0064d21c09 100644 --- a/content/desktop/extensions-sdk/dev/api/backend.md +++ b/content/extensions/extensions-sdk/dev/api/backend.md @@ -2,6 +2,8 @@ title: Extension Backend description: Docker extension API keywords: Docker, extensions, sdk, API +aliases: + - /desktop/extensions-sdk/dev/api/backend/ --- The `ddClient.extension.vm` object can be used to communicate with the backend defined in the [vm section](../../architecture/metadata.md#vm-section) of the extension metadata. diff --git a/content/desktop/extensions-sdk/dev/api/dashboard-routes-navigation.md b/content/extensions/extensions-sdk/dev/api/dashboard-routes-navigation.md similarity index 96% rename from content/desktop/extensions-sdk/dev/api/dashboard-routes-navigation.md rename to content/extensions/extensions-sdk/dev/api/dashboard-routes-navigation.md index bd584484bc..8e0bfb6a28 100644 --- a/content/desktop/extensions-sdk/dev/api/dashboard-routes-navigation.md +++ b/content/extensions/extensions-sdk/dev/api/dashboard-routes-navigation.md @@ -2,6 +2,8 @@ title: Navigation description: Docker extension API keywords: Docker, extensions, sdk, API +aliases: + - /desktop/extensions-sdk/dev/api/dashboard-routes-navigation/ --- `ddClient.desktopUI.navigate` enables navigation to specific screens of Docker Desktop such as the containers tab, the images tab, or a specific container's logs. diff --git a/content/desktop/extensions-sdk/dev/api/dashboard.md b/content/extensions/extensions-sdk/dev/api/dashboard.md similarity index 95% rename from content/desktop/extensions-sdk/dev/api/dashboard.md rename to content/extensions/extensions-sdk/dev/api/dashboard.md index 1e3c005f40..311c41f62c 100644 --- a/content/desktop/extensions-sdk/dev/api/dashboard.md +++ b/content/extensions/extensions-sdk/dev/api/dashboard.md @@ -2,6 +2,8 @@ title: Dashboard description: Docker extension API keywords: Docker, extensions, sdk, API +aliases: + - /desktop/extensions-sdk/dev/api/dashboard/ --- ## User notifications diff --git a/content/desktop/extensions-sdk/dev/api/docker.md b/content/extensions/extensions-sdk/dev/api/docker.md similarity index 98% rename from content/desktop/extensions-sdk/dev/api/docker.md rename to content/extensions/extensions-sdk/dev/api/docker.md index 845a1e2aa9..8e913f0d59 100644 --- a/content/desktop/extensions-sdk/dev/api/docker.md +++ b/content/extensions/extensions-sdk/dev/api/docker.md @@ -2,6 +2,8 @@ title: Docker description: Docker extension API keywords: Docker, extensions, sdk, API +aliases: + - /desktop/extensions-sdk/dev/api/docker/ --- ## Docker objects diff --git a/content/desktop/extensions-sdk/dev/api/overview.md b/content/extensions/extensions-sdk/dev/api/overview.md similarity index 91% rename from content/desktop/extensions-sdk/dev/api/overview.md rename to content/extensions/extensions-sdk/dev/api/overview.md index 476a4e13d5..f05db2ff9b 100644 --- a/content/desktop/extensions-sdk/dev/api/overview.md +++ b/content/extensions/extensions-sdk/dev/api/overview.md @@ -2,6 +2,8 @@ title: Extension UI API description: Docker extension development overview keywords: Docker, extensions, sdk, development +aliases: + - /desktop/extensions-sdk/dev/api/overview/ --- The extensions UI runs in a sandboxed environment and doesn't have access to any diff --git a/content/desktop/extensions-sdk/dev/api/reference/README.md b/content/extensions/extensions-sdk/dev/api/reference/README.md similarity index 95% rename from content/desktop/extensions-sdk/dev/api/reference/README.md rename to content/extensions/extensions-sdk/dev/api/reference/README.md index 7b2c0dabc5..645ad2959c 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/README.md +++ b/content/extensions/extensions-sdk/dev/api/reference/README.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/README/ --- # Extensions API Reference diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/BackendV0.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/BackendV0.md similarity index 98% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/BackendV0.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/BackendV0.md index c7de6ea6f6..d3da24c696 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/BackendV0.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/BackendV0.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/BackendV0/ --- # Interface: BackendV0 diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/DesktopUI.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/DesktopUI.md similarity index 83% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/DesktopUI.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/DesktopUI.md index d945ec6846..e159dbed6b 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/DesktopUI.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/DesktopUI.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/DesktopUI/ --- # Interface: DesktopUI diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/Dialog.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/Dialog.md similarity index 91% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/Dialog.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/Dialog.md index 18ef5890df..2d0a2c52ba 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/Dialog.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/Dialog.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/Dialog/ --- # Interface: Dialog diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/Docker.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/Docker.md similarity index 97% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/Docker.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/Docker.md index 19efb23bee..5945c8bf35 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/Docker.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/Docker.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/Docker/ --- # Interface: Docker diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/DockerCommand.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerCommand.md similarity index 72% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/DockerCommand.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerCommand.md index d88ecee2c2..1f1cc891f8 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/DockerCommand.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerCommand.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/DockerCommand/ --- # Interface: DockerCommand diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md similarity index 99% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md index 0707ca54c3..6e9423f33d 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient/ --- # Interface: DockerDesktopClient diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/Exec.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/Exec.md similarity index 94% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/Exec.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/Exec.md index 832f6d84f9..0799bee707 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/Exec.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/Exec.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/Exec/ --- # Interface: Exec diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExecOptions.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecOptions.md similarity index 81% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/ExecOptions.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecOptions.md index 84c08beb98..a5f98b770e 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExecOptions.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecOptions.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/ExecOptions/ --- # Interface: ExecOptions diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExecProcess.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecProcess.md similarity index 77% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/ExecProcess.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecProcess.md index 3b905be916..d1e1b83df0 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExecProcess.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecProcess.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/ExecProcess/ --- # Interface: ExecProcess diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExecResult.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecResult.md similarity index 95% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/ExecResult.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecResult.md index d5ee34def9..c22fa344c8 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExecResult.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecResult.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/ExecResult/ --- # Interface: ExecResult diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExecResultV0.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecResultV0.md similarity index 92% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/ExecResultV0.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecResultV0.md index 12870d6355..926b3639d6 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExecResultV0.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecResultV0.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/ExecResultV0/ --- # Interface: ExecResultV0 diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions.md similarity index 95% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions.md index ef097798ed..b70d94c5d2 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions/ --- # Interface: ExecStreamOptions diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/Extension.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/Extension.md similarity index 83% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/Extension.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/Extension.md index ab49d1f62a..99ebf2ed84 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/Extension.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/Extension.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/Extension/ --- # Interface: Extension diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionCli.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionCli.md similarity index 72% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionCli.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionCli.md index 4def6dc968..3ced8fccaf 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionCli.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionCli.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionCli/ --- # Interface: ExtensionCli diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionHost.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionHost.md similarity index 94% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionHost.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionHost.md index 9cc0949144..5074c8e5c8 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionHost.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionHost.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionHost/ --- # Interface: ExtensionHost diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionVM.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionVM.md similarity index 95% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionVM.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionVM.md index b80fb22e65..d75e056ca8 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionVM.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionVM.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionVM/ --- # Interface: ExtensionVM diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/Host.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/Host.md similarity index 93% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/Host.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/Host.md index 02a75e7480..2895149d39 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/Host.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/Host.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/Host/ --- # Interface: Host diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/HttpService.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/HttpService.md similarity index 97% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/HttpService.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/HttpService.md index fb7253fba8..b9a9f60fdd 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/HttpService.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/HttpService.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/HttpService/ --- # Interface: HttpService diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/NavigationIntents.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/NavigationIntents.md similarity index 98% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/NavigationIntents.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/NavigationIntents.md index 03325b29ce..538f109f28 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/NavigationIntents.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/NavigationIntents.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/NavigationIntents/ --- # Interface: NavigationIntents diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult.md similarity index 89% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult.md index fc28d0a694..8e27ee6d98 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult/ --- # Interface: OpenDialogResult diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/RawExecResult.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/RawExecResult.md similarity index 88% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/RawExecResult.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/RawExecResult.md index f6aa6d308d..4bca29e1c4 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/RawExecResult.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/RawExecResult.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/RawExecResult/ --- # Interface: RawExecResult diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfig.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfig.md similarity index 82% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfig.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfig.md index acf5a0a007..c1d7bca7e4 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfig.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfig.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfig/ --- # Interface: RequestConfig diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0.md similarity index 81% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0.md index 3fdec45c09..f8ad8a7ae0 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0/ --- # Interface: RequestConfigV0 diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ServiceError.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ServiceError.md similarity index 83% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/ServiceError.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/ServiceError.md index 9c42f3c70d..22cc8b0fe4 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/ServiceError.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/ServiceError.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/ServiceError/ --- # Interface: ServiceError diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/SpawnOptions.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/SpawnOptions.md similarity index 87% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/SpawnOptions.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/SpawnOptions.md index f988d80df9..cac7973c6a 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/SpawnOptions.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/SpawnOptions.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/SpawnOptions/ --- # Interface: SpawnOptions diff --git a/content/desktop/extensions-sdk/dev/api/reference/interfaces/Toast.md b/content/extensions/extensions-sdk/dev/api/reference/interfaces/Toast.md similarity index 94% rename from content/desktop/extensions-sdk/dev/api/reference/interfaces/Toast.md rename to content/extensions/extensions-sdk/dev/api/reference/interfaces/Toast.md index 8e62c54515..a1a2fb6cf4 100644 --- a/content/desktop/extensions-sdk/dev/api/reference/interfaces/Toast.md +++ b/content/extensions/extensions-sdk/dev/api/reference/interfaces/Toast.md @@ -1,6 +1,8 @@ --- description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference +aliases: + - /desktop/extensions-sdk/dev/api/reference/interfaces/Toast/ --- # Interface: Toast diff --git a/content/desktop/extensions-sdk/dev/continuous-integration.md b/content/extensions/extensions-sdk/dev/continuous-integration.md similarity index 97% rename from content/desktop/extensions-sdk/dev/continuous-integration.md rename to content/extensions/extensions-sdk/dev/continuous-integration.md index 77810f4ab7..f48d375150 100644 --- a/content/desktop/extensions-sdk/dev/continuous-integration.md +++ b/content/extensions/extensions-sdk/dev/continuous-integration.md @@ -2,6 +2,8 @@ title: Continuous Integration (CI) description: Automatically test and validate your extension. keywords: Docker, Extensions, sdk, CI, test, regression +aliases: + - /desktop/extensions-sdk/dev/continuous-integration/ --- In order to help validate your extension and ensure it's functional, the Extension SDK provides tools to help you setup continuous integration for your extension. diff --git a/content/desktop/extensions-sdk/dev/test-debug.md b/content/extensions/extensions-sdk/dev/test-debug.md similarity index 94% rename from content/desktop/extensions-sdk/dev/test-debug.md rename to content/extensions/extensions-sdk/dev/test-debug.md index b676f541d1..eef806f035 100644 --- a/content/desktop/extensions-sdk/dev/test-debug.md +++ b/content/extensions/extensions-sdk/dev/test-debug.md @@ -3,7 +3,8 @@ title: Test and debug description: Test and debug your extension. keywords: Docker, Extensions, sdk, preview, update, Chrome DevTools aliases: -- /desktop/extensions-sdk/build/test-debug/ + - /desktop/extensions-sdk/build/test-debug/ + - /desktop/extensions-sdk/dev/test-debug/ --- In order to improve the developer experience, Docker Desktop provides a set of tools to help you test and debug your extension. @@ -74,4 +75,4 @@ $ docker extension rm - Learn more about extensions [architecture](../architecture/index.md). - Explore our [design principles](../design/design-principles.md). - Take a look at our [UI styling guidelines](../design/index.md). -- Learn how to [setup CI for your extension](./continuous-integration.md). \ No newline at end of file +- Learn how to [setup CI for your extension](continuous-integration.md). \ No newline at end of file diff --git a/content/desktop/extensions-sdk/dev/usage.md b/content/extensions/extensions-sdk/dev/usage.md similarity index 91% rename from content/desktop/extensions-sdk/dev/usage.md rename to content/extensions/extensions-sdk/dev/usage.md index e237d0661a..f83afa27ba 100644 --- a/content/desktop/extensions-sdk/dev/usage.md +++ b/content/extensions/extensions-sdk/dev/usage.md @@ -3,7 +3,8 @@ title: Usage overview description: Docker extension CLI keywords: Docker, extensions, sdk, CLI aliases: -- /desktop/extensions-sdk/dev/cli/usage/ + - /desktop/extensions-sdk/dev/cli/usage/ + - /desktop/extensions-sdk/dev/usage/ --- The Extensions CLI is an extension development tool that is used to manage Docker extensions. Actions include install, list, remove, and validate extensions. diff --git a/content/desktop/extensions-sdk/extensions/DISTRIBUTION.md b/content/extensions/extensions-sdk/extensions/DISTRIBUTION.md similarity index 96% rename from content/desktop/extensions-sdk/extensions/DISTRIBUTION.md rename to content/extensions/extensions-sdk/extensions/DISTRIBUTION.md index 8fa36da40b..0135afe393 100644 --- a/content/desktop/extensions-sdk/extensions/DISTRIBUTION.md +++ b/content/extensions/extensions-sdk/extensions/DISTRIBUTION.md @@ -2,6 +2,8 @@ title: Package and release your extension description: Docker extension disctribution keywords: Docker, extensions, sdk, distribution +aliases: + - /desktop/extensions-sdk/extensions/DISTRIBUTION/ --- This page contains additional information on how to package and distribute extensions. diff --git a/content/desktop/extensions-sdk/extensions/_index.md b/content/extensions/extensions-sdk/extensions/_index.md similarity index 91% rename from content/desktop/extensions-sdk/extensions/_index.md rename to content/extensions/extensions-sdk/extensions/_index.md index 3863874b5b..0b3bc76ad9 100644 --- a/content/desktop/extensions-sdk/extensions/_index.md +++ b/content/extensions/extensions-sdk/extensions/_index.md @@ -2,6 +2,8 @@ title: Extension release process description: General steps in how to publish an extension keywords: Docker, Extensions, sdk, publish +aliases: + - /desktop/extensions-sdk/extensions/ --- This section describes how to make your extension available and more visible, so users can discover it and install it with a single click. @@ -13,7 +15,7 @@ After you have developed your extension and tested it locally, you are ready to Releasing your extension consists of: - Providing information about your extension: description, screenshots, etc. so users can decide to install your extension -- [Validating](./validate.md) that the extension is built in the right format and includes the required information +- [Validating](validate.md) that the extension is built in the right format and includes the required information - Making the extension image available on [Docker Hub](https://hub.docker.com/) See [Package and release your extension](DISTRIBUTION.md) for more details about the release process. diff --git a/content/desktop/extensions-sdk/extensions/images/list-preview.png b/content/extensions/extensions-sdk/extensions/images/list-preview.png similarity index 100% rename from content/desktop/extensions-sdk/extensions/images/list-preview.png rename to content/extensions/extensions-sdk/extensions/images/list-preview.png diff --git a/content/desktop/extensions-sdk/extensions/images/marketplace-details.png b/content/extensions/extensions-sdk/extensions/images/marketplace-details.png similarity index 100% rename from content/desktop/extensions-sdk/extensions/images/marketplace-details.png rename to content/extensions/extensions-sdk/extensions/images/marketplace-details.png diff --git a/content/desktop/extensions-sdk/extensions/images/open-share.png b/content/extensions/extensions-sdk/extensions/images/open-share.png similarity index 100% rename from content/desktop/extensions-sdk/extensions/images/open-share.png rename to content/extensions/extensions-sdk/extensions/images/open-share.png diff --git a/content/desktop/extensions-sdk/extensions/labels.md b/content/extensions/extensions-sdk/extensions/labels.md similarity index 98% rename from content/desktop/extensions-sdk/extensions/labels.md rename to content/extensions/extensions-sdk/extensions/labels.md index 7656336252..eb7bcd6a33 100644 --- a/content/desktop/extensions-sdk/extensions/labels.md +++ b/content/extensions/extensions-sdk/extensions/labels.md @@ -2,6 +2,8 @@ title: Extension image labels description: Docker extension labels keywords: Docker, extensions, sdk, labels +aliases: + - /desktop/extensions-sdk/extensions/labels/ --- Extensions use image labels to provide additional information such as a title, description, screenshots, and more. @@ -10,7 +12,7 @@ This information is then displayed as an overview of the extension, so users can ![An extension overview, generated from labels](images/marketplace-details.png) -You can define [image labels](../../../reference/dockerfile.md#label) in the extension's `Dockerfile`. +You can define [image labels](/reference/dockerfile.md#label) in the extension's `Dockerfile`. > **Important** > diff --git a/content/desktop/extensions-sdk/extensions/multi-arch.md b/content/extensions/extensions-sdk/extensions/multi-arch.md similarity index 95% rename from content/desktop/extensions-sdk/extensions/multi-arch.md rename to content/extensions/extensions-sdk/extensions/multi-arch.md index a5af34b2b7..3bbaa41c00 100644 --- a/content/desktop/extensions-sdk/extensions/multi-arch.md +++ b/content/extensions/extensions-sdk/extensions/multi-arch.md @@ -2,6 +2,8 @@ title: Build the extensions for multiple architectures description: Step three in creating an extension. keywords: Docker, Extensions, sdk, build, multi-arch +aliases: + - /desktop/extensions-sdk/extensions/multi-arch/ --- It is highly recommended that, at a minimum, your extension is supported for the following architectures: @@ -34,7 +36,7 @@ $ docker buildx build --push --platform=linux/amd64,linux/arm64 --tag=username/m ``` You can then check the image manifest to see if the image is available for both -architectures using the [`docker buildx imagetools` command](../../../reference/cli/docker/buildx/imagetools/_index.md): +architectures using the [`docker buildx imagetools` command](/reference/cli/docker/buildx/imagetools/_index.md): ```console $ docker buildx imagetools inspect username/my-extension:0.0.1 @@ -57,7 +59,7 @@ Manifests: > If you're having trouble pushing the image, make sure you're signed in to Docker Hub. Otherwise, run `docker login` to authenticate. { .tip } -For more information, see [Multi-platform images](../../../build/building/multi-platform.md) page. +For more information, see [Multi-platform images](/build/building/multi-platform.md) page. ## Adding multi-arch binaries diff --git a/content/desktop/extensions-sdk/extensions/publish.md b/content/extensions/extensions-sdk/extensions/publish.md similarity index 89% rename from content/desktop/extensions-sdk/extensions/publish.md rename to content/extensions/extensions-sdk/extensions/publish.md index ca01d0b38a..63340be38d 100644 --- a/content/desktop/extensions-sdk/extensions/publish.md +++ b/content/extensions/extensions-sdk/extensions/publish.md @@ -2,6 +2,8 @@ title: Publish your extension in the Marketplace description: Docker extension distribution keywords: Docker, extensions, publish +aliases: + - /desktop/extensions-sdk/extensions/publish/ --- ## Submit your extension to the Marketplace @@ -9,7 +11,7 @@ keywords: Docker, extensions, publish Docker Desktop displays published extensions in the Extensions Marketplace on [Docker Desktop](https://open.docker.com/extensions/marketplace) and [Docker Hub](https://hub.docker.com/search?q=&type=extension). The Extensions Marketplace is a space where developers can discover extensions to improve their developer experience and propose their own extension to be available for all Desktop users. -Whenever you are [ready to publish](./DISTRIBUTION.md) your extension in the Marketplace, you can [self-publish your extension](https://github.com/docker/extensions-submissions/issues/new?assignees=&labels=&template=1_automatic_review.yaml&title=%5BSubmission%5D%3A+) +Whenever you are [ready to publish](DISTRIBUTION.md) your extension in the Marketplace, you can [self-publish your extension](https://github.com/docker/extensions-submissions/issues/new?assignees=&labels=&template=1_automatic_review.yaml&title=%5BSubmission%5D%3A+) > **Note** > diff --git a/content/desktop/extensions-sdk/extensions/share.md b/content/extensions/extensions-sdk/extensions/share.md similarity index 91% rename from content/desktop/extensions-sdk/extensions/share.md rename to content/extensions/extensions-sdk/extensions/share.md index f8f88c6d0a..1dddc84ca4 100644 --- a/content/desktop/extensions-sdk/extensions/share.md +++ b/content/extensions/extensions-sdk/extensions/share.md @@ -2,6 +2,8 @@ title: Share your extension description: Share your extension with a share link keywords: Docker, extensions, share +aliases: + - /desktop/extensions-sdk/extensions/share/ --- Once your extension image is accessible on Docker Hub, anyone with access to the image can install the extension. diff --git a/content/desktop/extensions-sdk/extensions/validate.md b/content/extensions/extensions-sdk/extensions/validate.md similarity index 82% rename from content/desktop/extensions-sdk/extensions/validate.md rename to content/extensions/extensions-sdk/extensions/validate.md index 9c63012f22..d16c053e3b 100644 --- a/content/desktop/extensions-sdk/extensions/validate.md +++ b/content/extensions/extensions-sdk/extensions/validate.md @@ -3,9 +3,10 @@ title: Validate your extension description: Step three in the extension creation process keywords: Docker, Extensions, sdk, validate, install aliases: -- /desktop/extensions-sdk/extensions/validation/ -- /desktop/extensions-sdk/build/build-install/ -- /desktop/extensions-sdk/dev/cli/build-test-install-extension/ + - /desktop/extensions-sdk/extensions/validation/ + - /desktop/extensions-sdk/build/build-install/ + - /desktop/extensions-sdk/dev/cli/build-test-install-extension/ + - /desktop/extensions-sdk/extensions/validate/ --- Validate your extension before you share or publish it. Validating the extension ensures that the extension: diff --git a/content/desktop/extensions-sdk/guides/images/oauth.png b/content/extensions/extensions-sdk/guides/images/oauth.png similarity index 100% rename from content/desktop/extensions-sdk/guides/images/oauth.png rename to content/extensions/extensions-sdk/guides/images/oauth.png diff --git a/content/desktop/extensions-sdk/guides/invoke-host-binaries.md b/content/extensions/extensions-sdk/guides/invoke-host-binaries.md similarity index 98% rename from content/desktop/extensions-sdk/guides/invoke-host-binaries.md rename to content/extensions/extensions-sdk/guides/invoke-host-binaries.md index d37b3fdf6f..b01822c64b 100644 --- a/content/desktop/extensions-sdk/guides/invoke-host-binaries.md +++ b/content/extensions/extensions-sdk/guides/invoke-host-binaries.md @@ -3,6 +3,8 @@ title: Invoke host binaries description: Add invocations to host binaries from the frontend with the extension SDK. keywords: Docker, extensions, sdk, build +aliases: + - /desktop/extensions-sdk/guides/invoke-host-binaries/ --- In some cases, your extension may need to invoke some command from the host. For example, you diff --git a/content/desktop/extensions-sdk/guides/kubernetes.md b/content/extensions/extensions-sdk/guides/kubernetes.md similarity index 97% rename from content/desktop/extensions-sdk/guides/kubernetes.md rename to content/extensions/extensions-sdk/guides/kubernetes.md index 6ddf9bf687..e5f7e34414 100644 --- a/content/desktop/extensions-sdk/guides/kubernetes.md +++ b/content/extensions/extensions-sdk/guides/kubernetes.md @@ -3,7 +3,8 @@ title: Interacting with Kubernetes from an extension description: How to connect to a Kubernetes cluster from an extension keywords: Docker, Extensions, sdk, Kubernetes aliases: -- /desktop/extensions-sdk/dev/kubernetes/ + - /desktop/extensions-sdk/dev/kubernetes/ + - /desktop/extensions-sdk/guides/kubernetes/ --- The Extensions SDK does not provide any API methods to directly interact with the Docker Desktop managed Kubernetes cluster or any other created using other tools such as KinD. However, this page provides a way for you to use other SDK APIs to interact indirectly with a Kubernetes cluster from your extension. @@ -22,7 +23,7 @@ Docker Desktop conveniently provides the user with a local preconfigured `kubeco If your extension needs to interact with Kubernetes clusters, it is recommended that you include the `kubectl` command line tool as part of your extension. By doing this, users who install your extension get `kubectl` installed on their host. -To find out how to ship the `kubectl` command line tool for multiple platforms as part of your Docker Extension image, see [Build multi-arch extensions](../../../desktop/extensions-sdk/extensions/multi-arch.md#adding-multi-arch-binaries). +To find out how to ship the `kubectl` command line tool for multiple platforms as part of your Docker Extension image, see [Build multi-arch extensions](../extensions/multi-arch.md#adding-multi-arch-binaries). ## Examples diff --git a/content/desktop/extensions-sdk/guides/oauth2-flow.md b/content/extensions/extensions-sdk/guides/oauth2-flow.md similarity index 98% rename from content/desktop/extensions-sdk/guides/oauth2-flow.md rename to content/extensions/extensions-sdk/guides/oauth2-flow.md index d955ef07f2..37b4407423 100644 --- a/content/desktop/extensions-sdk/guides/oauth2-flow.md +++ b/content/extensions/extensions-sdk/guides/oauth2-flow.md @@ -3,7 +3,8 @@ title: OAuth 2.0 flow description: Docker extension OAuth 2.0 flow keywords: Docker, extensions, sdk, OAuth 2.0 aliases: -- /desktop/extensions-sdk/dev/oauth2-flow/ + - /desktop/extensions-sdk/dev/oauth2-flow/ + - /desktop/extensions-sdk/guides/oauth2-flow/ --- > **Note** diff --git a/content/desktop/extensions-sdk/guides/use-docker-socket-from-backend.md b/content/extensions/extensions-sdk/guides/use-docker-socket-from-backend.md similarity index 93% rename from content/desktop/extensions-sdk/guides/use-docker-socket-from-backend.md rename to content/extensions/extensions-sdk/guides/use-docker-socket-from-backend.md index 27a8f1b4d7..262b5addba 100644 --- a/content/desktop/extensions-sdk/guides/use-docker-socket-from-backend.md +++ b/content/extensions/extensions-sdk/guides/use-docker-socket-from-backend.md @@ -2,6 +2,8 @@ title: Use the Docker socket from the extension backend description: Docker extension metadata keywords: Docker, extensions, sdk, metadata +aliases: + - /desktop/extensions-sdk/guides/use-docker-socket-from-backend/ --- Extensions can invoke Docker commands directly from the frontend with the SDK. diff --git a/content/desktop/extensions-sdk/process.md b/content/extensions/extensions-sdk/process.md similarity index 94% rename from content/desktop/extensions-sdk/process.md rename to content/extensions/extensions-sdk/process.md index 78e23e5feb..7806362e81 100644 --- a/content/desktop/extensions-sdk/process.md +++ b/content/extensions/extensions-sdk/process.md @@ -2,6 +2,8 @@ description: Understand the process of creating an extension. title: The build and publish process keyword: Docker Extensions, sdk, build, create, publish +aliases: + - /desktop/extensions-sdk/process/ --- This documentation is structured so that it matches the steps you need to take when creating your extension. @@ -38,7 +40,7 @@ For further inspiration, see the other examples in the [samples folder](https:// Docker Desktop displays published extensions in the Extensions Marketplace. The Extensions Marketplace is a curated space where developers can discover extensions to improve their developer experience and upload their own extension to share with the world. -If you want your extension published in the Marketplace, read the [publish documentation](./extensions/publish.md). +If you want your extension published in the Marketplace, read the [publish documentation](extensions/publish.md). {{< include "extensions-form.md" >}} diff --git a/content/desktop/extensions-sdk/quickstart.md b/content/extensions/extensions-sdk/quickstart.md similarity index 96% rename from content/desktop/extensions-sdk/quickstart.md rename to content/extensions/extensions-sdk/quickstart.md index 0013e477fa..c1e2d83343 100644 --- a/content/desktop/extensions-sdk/quickstart.md +++ b/content/extensions/extensions-sdk/quickstart.md @@ -3,18 +3,19 @@ title: Quickstart description: Guide on how to build an extension quickly keywords: quickstart, extensions aliases: -- desktop/extensions-sdk/tutorials/initialize/ + - desktop/extensions-sdk/tutorials/initialize/ + - /desktop/extensions-sdk/quickstart/ --- Follow this guide to get started with creating a basic Docker extension. The Quickstart guide automatically generates boilerplate files for you. ## Prerequisites -- [Docker Desktop](../release-notes.md) +- [Docker Desktop](/desktop/release-notes.md) - [NodeJS](https://nodejs.org/) - [Go](https://go.dev/dl/) -> Note +> **Note** > > NodeJS and Go are only required when you follow the quickstart guide to create an extension. It uses the `docker extension init` command to automatically generate boilerplate files. This command uses a template based on a ReactJS and Go application. diff --git a/content/desktop/extensions/marketplace.md b/content/extensions/marketplace.md similarity index 97% rename from content/desktop/extensions/marketplace.md rename to content/extensions/marketplace.md index 314ce49e4d..a85a1fee28 100644 --- a/content/desktop/extensions/marketplace.md +++ b/content/extensions/marketplace.md @@ -2,6 +2,8 @@ description: Extensions keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows, Marketplace title: Marketplace extensions +aliases: + - /desktop/extensions/marketplace/ --- There are two types of extensions available in the Extensions Marketplace: diff --git a/content/desktop/extensions/non-marketplace.md b/content/extensions/non-marketplace.md similarity index 98% rename from content/desktop/extensions/non-marketplace.md rename to content/extensions/non-marketplace.md index 7430966d32..d5434d87e2 100644 --- a/content/desktop/extensions/non-marketplace.md +++ b/content/extensions/non-marketplace.md @@ -2,6 +2,8 @@ description: Extensions keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows, title: Non-Marketplace extensions +aliases: + - /desktop/extensions/non-marketplace/ --- ## Install an extension not available in the Marketplace diff --git a/content/desktop/extensions/private-marketplace.md b/content/extensions/private-marketplace.md similarity index 93% rename from content/desktop/extensions/private-marketplace.md rename to content/extensions/private-marketplace.md index 3234c1d941..6b307397cc 100644 --- a/content/desktop/extensions/private-marketplace.md +++ b/content/extensions/private-marketplace.md @@ -2,6 +2,8 @@ description: How to configure and use Docker Extensions' private marketplace keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows, Marketplace, private, security title: Configure a private marketplace for extensions +aliases: + - /desktop/extensions/private-marketplace/ --- > **Beta** @@ -14,7 +16,7 @@ Learn how to configure and set up a private marketplace with a curated list of e It is designed specifically -Docker Extensions' private marketplace is designed specifically for organizations who don’t give developers root access to their machines. It makes use of [Settings Management](../hardened-desktop/settings-management/_index.md) so administrators have complete control over the private marketplace. +Docker Extensions' private marketplace is designed specifically for organizations who don’t give developers root access to their machines. It makes use of [Settings Management](/desktop/hardened-desktop/settings-management/_index.md) so administrators have complete control over the private marketplace. ## Prerequisites @@ -80,7 +82,7 @@ Each setting has a `value` that you can set, including a `locked` field that let } ``` -To find out more information about the `admin-settings.json` file, see [Settings Management](../hardened-desktop/settings-management/_index.md). +To find out more information about the `admin-settings.json` file, see [Settings Management](/desktop/hardened-desktop/settings-management/_index.md). ## Step three: List allowed extensions @@ -137,7 +139,7 @@ $ /opt/docker-desktop/extension-admin generate This creates an `extension-marketplace` directory and downloads the marketplace metadata for all the allowed extensions. -The marketplace content is generated from extension image information as image labels, which is the [same format as public extensions](../extensions-sdk/extensions/labels.md). It includes the extension title, description, screenshots, links, etc. +The marketplace content is generated from extension image information as image labels, which is the [same format as public extensions](extensions-sdk/extensions/labels.md). It includes the extension title, description, screenshots, links, etc. ## Step five: Test the private marketplace setup @@ -194,7 +196,7 @@ These files must be placed on developer's machines. Depending on your operating - Windows: `C:\ProgramData\DockerDesktop` - Linux: `/usr/share/docker-desktop` -Make sure your developers are signed in to Docker Desktop in order for the private marketplace configuration to take effect. As an administrator, you should [configure a registry.json to enforce Docker Desktop sign-in](../../security/for-admins/configure-sign-in.md). +Make sure your developers are signed in to Docker Desktop in order for the private marketplace configuration to take effect. As an administrator, you should [configure a registry.json to enforce Docker Desktop sign-in](/security/for-admins/configure-sign-in.md). ## Feedback diff --git a/content/desktop/extensions/settings-feedback.md b/content/extensions/settings-feedback.md similarity index 88% rename from content/desktop/extensions/settings-feedback.md rename to content/extensions/settings-feedback.md index 6c1b08f858..287483fcf6 100644 --- a/content/desktop/extensions/settings-feedback.md +++ b/content/extensions/settings-feedback.md @@ -2,6 +2,8 @@ description: Extensions keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows, feedback title: Settings and feedback for Docker Extensions +aliases: + - /desktop/extensions/settings-feedback/ --- ## Settings @@ -17,12 +19,12 @@ Docker Extensions is switched on by default. To change your settings: >**Note** > -> If you are an [organization owner](../../admin/organization/manage-a-team.md#organization-owner), you can turn off extensions for your users. Open the `settings.json` file, and set `"extensionsEnabled"` to `false`. +> If you are an [organization owner](/admin/organization/manage-a-team.md#organization-owner), you can turn off extensions for your users. Open the `settings.json` file, and set `"extensionsEnabled"` to `false`. > The `settings.json` file is located at: > - `~/Library/Group Containers/group.com.docker/settings.json` on Mac > - `C:\Users\[USERNAME]\AppData\Roaming\Docker\settings.json` on Windows > -> This can also be done with [Hardened Docker Desktop](../hardened-desktop/index.md) +> This can also be done with [Hardened Docker Desktop](/desktop/hardened-desktop/index.md) ### Turn on or turn off extensions not available in the Marketplace diff --git a/content/manuals.md b/content/manuals.md index 6cbbf1b1d9..fa6ddeece1 100644 --- a/content/manuals.md +++ b/content/manuals.md @@ -24,7 +24,7 @@ development: - title: Docker Extensions description: Customize your Docker Desktop workflow. icon: extension - link: /desktop/extensions/ + link: /extensions/ services: - title: Docker Hub description: Discover, share, and integrate container images diff --git a/data/toc.yaml b/data/toc.yaml index 4066a1f80e..500129f5a9 100644 --- a/data/toc.yaml +++ b/data/toc.yaml @@ -983,51 +983,55 @@ Reference: path: /docker-hub/api/deprecated/ - sectiontitle: Docker Extension SDK API section: - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/DesktopUI/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/DesktopUI/ title: DesktopUI - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/Dialog/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/Dialog/ title: Dialog - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/Docker/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/Docker/ title: Docker - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/DockerCommand/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/DockerCommand/ title: DockerCommand - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient/ title: DockerDesktopClient - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/Exec/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/Exec/ title: Exec - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/ExecProcess/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ExecProcess/ title: ExecProcess - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/ExecResult/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ExecResult/ title: ExecResult - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions/ title: ExecStreamOptions - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/Extension/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/Extension/ title: Extension - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionCli/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionCli/ title: ExtensionCli - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionHost/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionHost/ title: ExtensionHost - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionVM/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ExtensionVM/ title: ExtensionVM - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/Host/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/Host/ title: Host - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/HttpService/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/HttpService/ title: HttpService - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/NavigationIntents/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/NavigationIntents/ title: NavigationIntents - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult/ title: OpenDialogResult - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/RawExecResult/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/RawExecResult/ title: RawExecResult - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfig/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfig/ title: RequestConfig - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0/ title: RequestConfigV0 - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/Toast/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ServiceError/ + title: ServiceError + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ServiceError/ + title: SpawnOptions + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/Toast/ title: Toast - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/ExecResultV0/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/ExecResultV0/ title: ExecResultV0 - - path: /desktop/extensions-sdk/dev/api/reference/interfaces/BackendV0/ + - path: /extensions/extensions-sdk/dev/api/reference/interfaces/BackendV0/ title: BackendV0 - sectiontitle: Compose file reference section: @@ -1346,100 +1350,100 @@ Manuals: - sectiontitle: Docker Extensions section: - - path: /desktop/extensions/ + - path: /extensions/ title: Overview - sectiontitle: Extensions on Docker Desktop section: - - path: /desktop/extensions/marketplace/ + - path: /extensions/marketplace/ title: Manage Marketplace extensions - - path: /desktop/extensions/non-marketplace/ + - path: /extensions/non-marketplace/ title: Manage non-Marketplace extensions - - path: /desktop/extensions/settings-feedback/ + - path: /extensions/settings-feedback/ title: Change settings and give feedback - - path: /desktop/extensions/private-marketplace/ + - path: /extensions/private-marketplace/ title: Configure a private Marketplace (Beta) - sectiontitle: Extensions SDK section: - - path: /desktop/extensions-sdk/ + - path: /extensions/extensions-sdk/ title: Overview - - path: /desktop/extensions-sdk/process/ + - path: /extensions/extensions-sdk/process/ title: The build and publish process - - path: /desktop/extensions-sdk/quickstart/ + - path: /extensions/extensions-sdk/quickstart/ title: Quickstart - sectiontitle: "Part one: Build" section: - title: Create a simple extension - path: /desktop/extensions-sdk/build/minimal-frontend-extension/ + path: /extensions/extensions-sdk/build/minimal-frontend-extension/ - title: Create an advanced frontend extension - path: /desktop/extensions-sdk/build/frontend-extension-tutorial/ + path: /extensions/extensions-sdk/build/frontend-extension-tutorial/ - title: Add a backend to your extension - path: /desktop/extensions-sdk/build/backend-extension-tutorial/ + path: /extensions/extensions-sdk/build/backend-extension-tutorial/ - sectiontitle: "Part two: Publish" section: - title: Overview - path: /desktop/extensions-sdk/extensions/ + path: /extensions/extensions-sdk/extensions/ - title: Labels - path: /desktop/extensions-sdk/extensions/labels/ + path: /extensions/extensions-sdk/extensions/labels/ - title: Validate - path: /desktop/extensions-sdk/extensions/validate/ + path: /extensions/extensions-sdk/extensions/validate/ - title: Package and release your extension - path: /desktop/extensions-sdk/extensions/DISTRIBUTION/ + path: /extensions/extensions-sdk/extensions/DISTRIBUTION/ - title: Generate a share link - path: /desktop/extensions-sdk/extensions/share/ + path: /extensions/extensions-sdk/extensions/share/ - title: Publish in the Marketplace - path: /desktop/extensions-sdk/extensions/publish/ + path: /extensions/extensions-sdk/extensions/publish/ - title: Build multi-arch extensions - path: /desktop/extensions-sdk/extensions/multi-arch/ + path: /extensions/extensions-sdk/extensions/multi-arch/ - sectiontitle: "Architecture" section: - title: Overview - path: /desktop/extensions-sdk/architecture/ + path: /extensions/extensions-sdk/architecture/ - title: Metadata - path: /desktop/extensions-sdk/architecture/metadata/ + path: /extensions/extensions-sdk/architecture/metadata/ - title: Security - path: /desktop/extensions-sdk/architecture/security/ + path: /extensions/extensions-sdk/architecture/security/ - sectiontitle: "Design and UI styling" section: - title: UI styling guidelines - path: /desktop/extensions-sdk/design/ + path: /extensions/extensions-sdk/design/ - title: Guidelines - path: /desktop/extensions-sdk/design/design-guidelines/ + path: /extensions/extensions-sdk/design/design-guidelines/ - title: Docker design principles - path: /desktop/extensions-sdk/design/design-principles/ + path: /extensions/extensions-sdk/design/design-principles/ - title: MUI best practices - path: /desktop/extensions-sdk/design/mui-best-practices/ + path: /extensions/extensions-sdk/design/mui-best-practices/ - sectiontitle: "Developer Guides" section: - title: Invoke host binaries - path: /desktop/extensions-sdk/guides/invoke-host-binaries/ + path: /extensions/extensions-sdk/guides/invoke-host-binaries/ - title: Use the Docker socket from the extension backend - path: /desktop/extensions-sdk/guides/use-docker-socket-from-backend/ + path: /extensions/extensions-sdk/guides/use-docker-socket-from-backend/ - title: Interacting with Kubernetes - path: /desktop/extensions-sdk/guides/kubernetes/ + path: /extensions/extensions-sdk/guides/kubernetes/ - title: Authentication - path: /desktop/extensions-sdk/guides/oauth2-flow/ + path: /extensions/extensions-sdk/guides/oauth2-flow/ - sectiontitle: Developer SDK tools section: - title: "Test and debug" - path: /desktop/extensions-sdk/dev/test-debug/ + path: /extensions/extensions-sdk/dev/test-debug/ - title: "Continuous integration" - path: /desktop/extensions-sdk/dev/continuous-integration/ + path: /extensions/extensions-sdk/dev/continuous-integration/ - title: CLI reference - path: /desktop/extensions-sdk/dev/usage/ + path: /extensions/extensions-sdk/dev/usage/ - sectiontitle: Extension APIs section: - title: Overview - path: /desktop/extensions-sdk/dev/api/overview/ + path: /extensions/extensions-sdk/dev/api/overview/ - title: Extension Backend - path: /desktop/extensions-sdk/dev/api/backend/ + path: /extensions/extensions-sdk/dev/api/backend/ - title: Docker - path: /desktop/extensions-sdk/dev/api/docker/ + path: /extensions/extensions-sdk/dev/api/docker/ - title: Dashboard - path: /desktop/extensions-sdk/dev/api/dashboard/ + path: /extensions/extensions-sdk/dev/api/dashboard/ - title: Navigation - path: /desktop/extensions-sdk/dev/api/dashboard-routes-navigation/ + path: /extensions/extensions-sdk/dev/api/dashboard-routes-navigation/ - title: API Reference - path: /desktop/extensions-sdk/dev/api/reference/README/ + path: /extensions/extensions-sdk/dev/api/reference/README/ - sectiontitle: Docker Scout section: