diff --git a/_data/toc.yaml b/_data/toc.yaml index 846f4691ff..2996083a92 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -1252,9 +1252,7 @@ manuals: title: Quickstart - sectiontitle: "Part one: Build" section: - - title: "Step one: Get started" - path: /desktop/extensions-sdk/build/get-started/ - - sectiontitle: "Step two: Set up..." + - sectiontitle: "Step one: Set up..." section: - title: ...a minimal frontend extension path: /desktop/extensions-sdk/build/set-up/minimal-frontend-extension/ @@ -1264,9 +1262,9 @@ manuals: path: /desktop/extensions-sdk/build/set-up/minimal-frontend-using-docker-cli/ - title: ... a minimal backend extension path: /desktop/extensions-sdk/build/set-up/minimal-backend-extension/ - - title: "Step three: Build and install" + - title: "Step two: Build and install" path: /desktop/extensions-sdk/build/build-install/ - - title: "Step four: Test and debug" + - title: "Step three: Test and debug" path: /desktop/extensions-sdk/build/test-debug/ - sectiontitle: "Part two: Publish" section: diff --git a/desktop/extensions-sdk/build/build-install.md b/desktop/extensions-sdk/build/build-install.md index 1f4d0b0031..6e4743df6d 100644 --- a/desktop/extensions-sdk/build/build-install.md +++ b/desktop/extensions-sdk/build/build-install.md @@ -1,5 +1,5 @@ --- -title: "Step three: Build and install" +title: "Step two: Build and install" description: Step three in the extension creation process keywords: Docker, Extensions, sdk, validate, install redirect_from: diff --git a/desktop/extensions-sdk/build/get-started.md b/desktop/extensions-sdk/build/get-started.md deleted file mode 100644 index 7985eaa80f..0000000000 --- a/desktop/extensions-sdk/build/get-started.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "Step one: Get started" -description: The first step to building an extension. -keywords: Docker, Extensions, sdk, prerequisites -redirect_from: - - desktop/extensions-sdk/tutorials/initialize/ ---- - -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. - -## Prerequisites - -Before you create your own extension, you need to install [Docker Desktop](../../release-notes.md). - -You can list installed extensions (the list should be empty if you have not installed extensions already): - -```console -$ docker extension ls -ID PROVIDER VERSION UI VM HOST -``` - -![Extensions enabled](images/extensions-enabled.png) - -You can now continue to step two and set up your directory. - -## What’s next? - -Explore how to set up: - -- [A frontend extension based on plain HTML](set-up/minimal-frontend-extension.md) -- [A simple Docker extension that contains only a UI part and is based on ReactJS](set-up/react-extension.md) -- [An extension that invokes Docker CLI commands](set-up/minimal-frontend-using-docker-cli.md) -- [A simple backend extension](set-up/minimal-backend-extension.md) diff --git a/desktop/extensions-sdk/build/set-up/minimal-backend-extension.md b/desktop/extensions-sdk/build/set-up/minimal-backend-extension.md index 86c45607a5..32d4505adf 100644 --- a/desktop/extensions-sdk/build/set-up/minimal-backend-extension.md +++ b/desktop/extensions-sdk/build/set-up/minimal-backend-extension.md @@ -6,10 +6,13 @@ redirect_from: - /desktop/extensions-sdk/tutorials/minimal-backend-extension/ --- -Set up a simple Docker Extension that runs CLI commands in the backend. +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 simple Docker Extension that runs CLI commands in the backend. For extensions with a backend service running REST services over sockets or named pipes, see the `vm-ui extension` [sample](https://github.com/docker/extensions-sdk/tree/main/samples). +>Note +> +>Before you start, make sure you have installed the latest version of [Docker Desktop](../../../release-notes.md). ## Extension folder structure diff --git a/desktop/extensions-sdk/build/set-up/minimal-frontend-extension.md b/desktop/extensions-sdk/build/set-up/minimal-frontend-extension.md index c2b4daca3d..bb851168b9 100644 --- a/desktop/extensions-sdk/build/set-up/minimal-frontend-extension.md +++ b/desktop/extensions-sdk/build/set-up/minimal-frontend-extension.md @@ -6,7 +6,11 @@ redirect_from: - /desktop/extensions-sdk/tutorials/minimal-frontend-extension/ --- -Set up a minimal frontend extension based on plain HTML. +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. + +>Note +> +>Before you start, make sure you have installed the latest version of [Docker Desktop](../../../release-notes.md). ## Extension folder structure diff --git a/desktop/extensions-sdk/build/set-up/minimal-frontend-using-docker-cli.md b/desktop/extensions-sdk/build/set-up/minimal-frontend-using-docker-cli.md index 3c565a69c4..3557ab0dc0 100644 --- a/desktop/extensions-sdk/build/set-up/minimal-frontend-using-docker-cli.md +++ b/desktop/extensions-sdk/build/set-up/minimal-frontend-using-docker-cli.md @@ -6,7 +6,11 @@ redirect_from: - /desktop/extensions-sdk/tutorials/minimal-frontend-using-docker-cli/ --- -Set up a simple Docker extension that invokes Docker CLI commands. +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 simple Docker extension that invokes Docker CLI commands. + +>Note +> +>Before you start, make sure you have installed the latest version of [Docker Desktop](../../../release-notes.md). ## Extension folder structure diff --git a/desktop/extensions-sdk/build/set-up/react-extension.md b/desktop/extensions-sdk/build/set-up/react-extension.md index 4dbef84605..aac1c4b24e 100644 --- a/desktop/extensions-sdk/build/set-up/react-extension.md +++ b/desktop/extensions-sdk/build/set-up/react-extension.md @@ -6,7 +6,11 @@ redirect_from: - /desktop/extensions-sdk/tutorials/react-extension/ --- -Set up a simple Docker extension that contains only a UI part and is based on ReactJS. +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 simple Docker extension that contains only a UI part and is based on ReactJS. + +>Note +> +>Before you start, make sure you have installed the latest version of [Docker Desktop](../../../release-notes.md). ## Extension folder structure diff --git a/desktop/extensions-sdk/build/test-debug.md b/desktop/extensions-sdk/build/test-debug.md index 4f1b422e01..84576673fd 100644 --- a/desktop/extensions-sdk/build/test-debug.md +++ b/desktop/extensions-sdk/build/test-debug.md @@ -1,5 +1,5 @@ --- -title: "Step four: Test and debug" +title: "Step three: Test and debug" description: Step four in the extension creation process keywords: Docker, Extensions, sdk, preview, update, Chrome DevTools --- diff --git a/desktop/extensions-sdk/index.md b/desktop/extensions-sdk/index.md index dac34de008..e195a31b89 100644 --- a/desktop/extensions-sdk/index.md +++ b/desktop/extensions-sdk/index.md @@ -22,13 +22,13 @@ Development of extensions can be done locally without the need to push the exten ## How to use the resources in this section -The documentation is structured so that it matches the steps you need to take when creating your extension. There are two main parts to creating a Docker Extension; Build the foundations and then publish your extension. +The documentation is structured so that it matches the steps you need to take when creating your extension. There are two main parts to creating a Docker Extension; build the foundations and then publish your extension. ### Part one: Build the foundations The build process consists of: -- Installing the prerequisites. +- Installing the latest version of Docker Desktop. - Setting up the directory with files which range from the extension’s source code to the required extension-specific files. - Creating the Dockerfile to build, publish, and run your extension in Docker Desktop. - Configuring the metadata file which is required at the root of the image filesystem. @@ -59,4 +59,4 @@ Docker Desktop displays published extensions in the Extensions Marketplace. If y ## What’s next? If you want to get up and running quickly with a Docker Extension, see the [Quickstart guide](quickstart.md). -For more in-depth information about each step of the extension creation process, see [Get started](/build/get-started.md). \ No newline at end of file +Alternatively, get started with Part one: Build for more in-depth information about each step of the extension creation process. \ No newline at end of file diff --git a/desktop/extensions-sdk/quickstart.md b/desktop/extensions-sdk/quickstart.md index 27ccc3257b..ceb7798b84 100644 --- a/desktop/extensions-sdk/quickstart.md +++ b/desktop/extensions-sdk/quickstart.md @@ -2,6 +2,8 @@ title: Quickstart description: Guide on how to build an extension quickly keywords: quickstart, extensions +redirect_from: + - desktop/extensions-sdk/tutorials/initialize/ --- Follow the guide below to build a basic Docker Extension quickly. The Quickstart guide automatically generates boilerplate files for you.