DD 4.15: extensions content changes (#16187)

* DD 4.15: extensions content changes

* addition of share content
This commit is contained in:
Allie Sadler 2022-12-01 15:26:23 +00:00 committed by GitHub
parent 477d7f673b
commit 87b5615982
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 59 additions and 23 deletions

View File

@ -1343,6 +1343,8 @@ manuals:
section:
- title: Publish your extension
path: /desktop/extensions-sdk/extensions/
- title: Share your extension
path: /desktop/extensions-sdk/extensions/share
- title: Metadata
path: /desktop/extensions-sdk/extensions/METADATA/
- title: Labels

Binary file not shown.

Before

Width:  |  Height:  |  Size: 585 KiB

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

View File

@ -0,0 +1,34 @@
---
title: Share your extension
description: Docker extension distribution
keywords: Docker, extensions, share
---
Once your extension image is accessible on Docker Hub, anyone with access to the image can install the extension.
People can install your extension by typing `docker extension install my/awesome-extension:latest` in to the terminal.
However, this option doesn't provide a preview of the extension before it's installed.
## Share with URL
Docker now allows you to share your extensions using a URL.
When people navigate to this URL, it opens Docker Desktop and displays a preview of your extension in the same way as an extension in the Marketplace. From the preivew, users can then select **Install**.
![Navigate to extension link](images/open-share.PNG)
To generate this link you can either:
- Run the following command:
```console
$ docker extension share my/awesome-extension:0.0.1
```
- Once you have installed your extension locally, navigate to the **Manage** tab and select **Share**.
![Share button](images/list-preview.png)
Previews of the extension description or screenshots, for example, are created using [extension labels](labels.md).

View File

@ -14,21 +14,21 @@ To install an extension:
1. Open Docker Desktop.
2. From the Dashboard, select **Add Extensions** in the menu bar.
The Extensions Marketplace opens.
The Extensions Marketplace opens on the **Browse** tab.
3. Browse the available extensions.
You can sort the list of extensions by **Recently added** or alphabetically.
4. Click **Install**.
4. Choose you extension and select **Install**.
From here, you can click **Open** to access the extension or install additional extensions. The extension also appears in the menu bar.
From here, you can select **Open** to access the extension or install additional extensions. The extension also appears in the left-hand menu and in the **Manage** tab.
## Update an extension
You can update any extension outside of Docker Desktop releases. To update an extension to the latest version:
1. Navigate to Docker Dashboard, and from the menu bar select the ellipsis to the right of **Extensions**.
2. Click **Manage Extensions**.
If an extension has a new version available, it displays an **Update** button.
3. Click **Update**.
2. Select **Manage**.
The **Manage** tab displays with all your installed extensions. If an extension has a new version available, it displays an **Update** button.
3. Select **Update**.
## Uninstall an extension
@ -36,8 +36,8 @@ You can uninstall an extension at any time.
> **Note**
>
> Any data used by the extension that is stored in a volume must be manually deleted.
> Any data used by the extension that's stored in a volume must be manually deleted.
1. From the menu bar, select the ellipsis to the right of **Extensions**.
2. Click **Manage Extensions**. This displays a list of extensions you've installed.
3. Click **Uninstall**.
2. Select **Manage**. This displays a list of extensions you've installed.
3. Select **Uninstall**.

View File

@ -39,20 +39,20 @@ ID PROVIDER VERSION UI
john/my-extension John latest 1 tab(My-Extension) Running(1) -
```
Go to the Docker Dashboard, click on **Add Extensions** and on the **Installed** tab to see the new extension installed.
Go to the Docker Dashboard, click on **Add Extensions** and on the **Managed** tab to see the new extension installed.
Notice that an `UNPUBLISHED` label displays which indicates that the extension has not been installed from the Marketplace.
## Update an extension
To update an extension which is not present in the Marketplace, in a terminal type `docker extension update IMAGE[:TAG]` where the `TAG` should be different from the extension that is already installed.
To update an extension which isn't present in the Marketplace, in a terminal type `docker extension update IMAGE[:TAG]` where the `TAG` should be different from the extension that's already installed.
For instance, if you installed an extension with `docker extension install john/my-extension:0.0.1`, you can update it by running `docker extension update john/my-extension:0.0.2`.
Go to the Docker Dashboard to see the new extension updated.
> **Note**
>
> Extensions that have not been installed through the Marketplace will not receive update notifications from Docker Desktop.
> Extensions that aren't installed through the Marketplace don't receive update notifications from Docker Desktop.
## Uninstall an extension
To uninstall an extension which is not present in the Marketplace, you can either navigate to the **Installed** tab in the Marketplace and select the **Uninstall** button, or from a terminal type `docker extension uninstall IMAGE[:TAG]`.
To uninstall an extension which is not present in the Marketplace, you can either navigate to the **Managed** tab in the Marketplace and select the **Uninstall** button, or from a terminal type `docker extension uninstall IMAGE[:TAG]`.

View File

@ -6,23 +6,23 @@ title: Settings and feedback
## Settings
### Enable or disable extensions available in the Marketplace
### Turn on or turn off extensions available in the Marketplace
Docker Extensions is switched on by default. To change your settings:
1. Navigate to **Settings**, or **Preferences** if you're a Mac user.
2. Select the **Extensions** tab.
3. Next to **Enable Docker Extensions**, select or clear the checkbox to set your desired state.
4. In the bottom-right corner, click **Apply & Restart**.
4. In the bottom-right corner, select **Apply & Restart**.
### Enable or disable extensions not available in the Marketplace
### Turn on or turn off extensions not available in the Marketplace
You can install extensions through the Marketplace or through the Extensions SDK tools. You can choose to only allow published extensions (extensions that have been reviewed and published in the Extensions Marketplace).
You can install extensions through the Marketplace or through the Extensions SDK tools. You can choose to only allow published extensions. These are extensions that have been reviewed and published in the Extensions Marketplace.
1. Navigate to **Settings**, or **Preferences** if you're a Mac user.
2. Select the **Extensions** tab.
3. Next to **Allow only extensions distributed through the Docker Marketplace**, select or clear the checkbox to set your desired state.
4. In the bottom-right corner, click **Apply & Restart**.
4. In the bottom-right corner, select **Apply & Restart**.
### See containers created by extensions
@ -32,20 +32,20 @@ update your settings:
1. Navigate to **Settings**, or **Preferences** if you're a Mac user.
2. Select the **Extensions** tab.
3. Next to **Show Docker Extensions system containers**, select or clear the checkbox to set your desired state.
4. In the bottom-right corner, click **Apply & Restart**.
4. In the bottom-right corner, select **Apply & Restart**.
> **Note**
>
> Enabling extensions does not use computer resources (CPU / Memory) by itself.
> Enabling extensions doesn't use computer resources (CPU / Memory) by itself.
>
> Specific extensions might use computer resources, depending on the features and implementation of each extension, but there is no reserved resources or usage cost associated with enabling extensions.
## Submit feedback
Feedback can be given to an extension author through a dedicated Slack channel or Github. To submit feedback about a particular extension:
Feedback can be given to an extension author through a dedicated Slack channel or GitHub. To submit feedback about a particular extension:
1. Navigate to Docker Dashboard and from the menu bar select the ellipsis to the right of **Extensions**.
2. Click **Manage Extensions**.
2. Select the **Manage** tab.
3. Select the extension you want to provide feedback on.
4. Scroll down to the bottom of the extension's description and, depending on the
extension, select:
@ -53,4 +53,4 @@ extension, select:
- Slack
- Issues. You'll be sent to a page outside of Docker Desktop to submit your feedback.
If an extension does not provide a way for you to give feedback, contact us and we'll pass on the feedback for you. To provide feedback, select the **Give feedback** to the right of **Extensions Marketplace**.
If an extension doesn't provide a way for you to give feedback, contact us and we'll pass on the feedback for you. To provide feedback, select the **Give feedback** to the right of **Extensions Marketplace**.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 53 KiB