mirror of https://github.com/docker/docs.git
Direct extension authors to the quickstart guide rather than samples when they start creating a codebase for their new extensions (#15702)
* Direct extension authors to the quickstart guide rather than samples when they start creating a codebase for their new extensions Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com> * Apply suggestions from code review Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> * Fix warning class not picked up properly in note Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com> Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com> Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
This commit is contained in:
Guillaume Tardif
GitHub
parent
ba85aa2460
commit
6228d4e263
|
|
@ -1,18 +1,22 @@
|
|||
---
|
||||
title: Set up a minimal backend extension
|
||||
title: Set up a minimal backend extension
|
||||
description: Minimal backend extension tutorial
|
||||
keywords: Docker, extensions, sdk, build
|
||||
redirect_from:
|
||||
- /desktop/extensions-sdk/tutorials/minimal-backend-extension/
|
||||
- /desktop/extensions-sdk/tutorials/minimal-backend-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 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
|
||||
> Note
|
||||
>
|
||||
>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](../../../release-notes.md).
|
||||
|
||||
> Note
|
||||
>
|
||||
> If you want to start a codebase for your new extension, our [Quickstart guide](../../quickstart.md) and `docker extension init <my-extension>` provides a better base for your extension as it is more up-to-date and related to your install of Docker Desktop.
|
||||
|
||||
## Extension folder structure
|
||||
|
||||
|
|
@ -111,12 +115,9 @@ For more information on the `metadata.json`, see [Metadata](../../extensions/MET
|
|||
|
||||
> **Warning**
|
||||
>
|
||||
>Do not replace the `${DESKTOP_PLUGIN_IMAGE}` placeholder in the `metadata.json` file. The placeholder is replaced automatically with the correct image name when the extension is installed.
|
||||
> Do not replace the `${DESKTOP_PLUGIN_IMAGE}` placeholder in the `metadata.json` file. The placeholder is replaced automatically with the correct image name when the extension is installed.
|
||||
{: .warning}
|
||||
|
||||
|
||||
## What's next?
|
||||
|
||||
Learn how to [build and install your extension](../build-install.md).
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,16 +1,20 @@
|
|||
---
|
||||
title: Set up a minimal frontend extension
|
||||
title: Set up a minimal frontend extension
|
||||
description: Minimal frontend extension tutorial
|
||||
keywords: Docker, extensions, sdk, build
|
||||
redirect_from:
|
||||
- /desktop/extensions-sdk/tutorials/minimal-frontend-extension/
|
||||
- /desktop/extensions-sdk/tutorials/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.
|
||||
|
||||
>Note
|
||||
> Note
|
||||
>
|
||||
>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](../../../release-notes.md).
|
||||
|
||||
> Note
|
||||
>
|
||||
> If you want to start a codebase for your new extension, our [Quickstart guide](../../quickstart.md) and `docker extension init <my-extension>` will provide a better base for your extension, more up-to-date and related to your install of Docker Desktop.
|
||||
|
||||
## Extension folder structure
|
||||
|
||||
|
|
|
|||
|
|
@ -3,14 +3,18 @@ title: Set up a minimal extension invoking Docker commands
|
|||
description: Minimal docker CLI extension tutorial
|
||||
keywords: Docker, extensions, sdk, build
|
||||
redirect_from:
|
||||
- /desktop/extensions-sdk/tutorials/minimal-frontend-using-docker-cli/
|
||||
- /desktop/extensions-sdk/tutorials/minimal-frontend-using-docker-cli/
|
||||
---
|
||||
|
||||
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
|
||||
> Note
|
||||
>
|
||||
>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](../../../release-notes.md).
|
||||
|
||||
> Note
|
||||
>
|
||||
> If you want to start a codebase for your new extension, our [Quickstart guide](../../quickstart.md) and `docker extension init <my-extension>` will provide a better base for your extension, more up-to-date and related to your install of Docker Desktop.
|
||||
|
||||
## Extension folder structure
|
||||
|
||||
|
|
|
|||
|
|
@ -3,14 +3,18 @@ title: Set up a minimal react extension
|
|||
description: Minimal react extension tutorial
|
||||
keywords: Docker, extensions, sdk, build
|
||||
redirect_from:
|
||||
- /desktop/extensions-sdk/tutorials/react-extension/
|
||||
- /desktop/extensions-sdk/tutorials/react-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 simple Docker extension that contains only a UI part and is based on ReactJS.
|
||||
|
||||
>Note
|
||||
> Note
|
||||
>
|
||||
>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](../../../release-notes.md).
|
||||
|
||||
> Note
|
||||
>
|
||||
> If you want to start a codebase for your new extension, our [Quickstart guide](../../quickstart.md) and `docker extension init <my-extension>` will provide a better base for your extension, more up-to-date and related to your install of Docker Desktop.
|
||||
|
||||
## Extension folder structure
|
||||
|
||||
|
|
@ -49,7 +53,7 @@ If you want to set up user authentication for the extension, see [Authentication
|
|||
|
||||
## Create a Dockerfile
|
||||
|
||||
Use the Dockerfile below as a template and change it accordingly to suit your needs.
|
||||
Use the Dockerfile below as a template and change it accordingly to suit your needs.
|
||||
|
||||
```Dockerfile
|
||||
FROM node:14.17-alpine3.13 AS client-builder
|
||||
|
|
|
|||
Loading…
Reference in New Issue