mirror of https://github.com/docker/docs.git
Merge pull request #15042 from aevesdocker/ENGDOCS-788
refine the Extensions-sdk
This commit is contained in:
Allie Sadler
GitHub
commit
5f339da34c
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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
|
||||
```
|
||||
|
||||
|
||||
|
||||
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)
|
||||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
---
|
||||
|
|
|
|||
|
|
@ -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).
|
||||
Alternatively, get started with Part one: Build for more in-depth information about each step of the extension creation process.
|
||||
|
|
@ -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.
|
||||
|
|
|
|||
Loading…
Reference in New Issue