diff --git a/content/manuals/extensions/extensions-sdk/extensions/labels.md b/content/manuals/extensions/extensions-sdk/extensions/labels.md index 626a1e32eb..bb670d5137 100644 --- a/content/manuals/extensions/extensions-sdk/extensions/labels.md +++ b/content/manuals/extensions/extensions-sdk/extensions/labels.md @@ -23,20 +23,20 @@ You can define [image labels](/reference/dockerfile.md#label) in the extension's Here is the list of labels you can or need to specify when building your extension: -| Label | Required | Description | Example | -| ------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `org.opencontainers.image.title` | Yes | Human-readable title of the image (string). This appears in the UI for Docker Desktop. | my-extension | -| `org.opencontainers.image.description` | Yes | Human-readable description of the software packaged in the image (string) | This extension is cool. | -| `org.opencontainers.image.vendor` | Yes | Name of the distributing entity, organization, or individual. | Acme, Inc. | -| `com.docker.desktop.extension.api.version` | Yes | Version of the Docker Extension manager that the extension is compatible with. It must follow [semantic versioning](https://semver.org/). | A specific version like `0.1.0` or, a constraint expression: `>= 0.1.0`, `>= 1.4.7, < 2.0` . For your first extension, you can use `docker extension version` to know the SDK API version and specify `>= `. | -| `com.docker.desktop.extension.icon` | Yes | The extension icon (format: .svg .png .jpg) | {{% param "docs_url" %}}/assets/images/engine.svg | -| `com.docker.extension.screenshots` | Yes | A JSON array of image URLs and an alternative text displayed to users (in the order they appear in your metadata) in your extension's details page. **Note:** The recommended size for screenshots is 2400x1600 pixels. | `[{"alt":"alternative text for image 1",` `"url":"https://foo.bar/image1.png"},` `{"alt":"alternative text for image2",` `"url":"https://foo.bar/image2.jpg"}]` | -| `com.docker.extension.detailed-description` | Yes | Additional information in plain text or HTML about the extension to display in the details dialog. | `My detailed description` or `

My detailed description

` | -| `com.docker.extension.publisher-url` | Yes | The publisher website URL to display in the details dialog. | `https://foo.bar` | -| `com.docker.extension.additional-urls` | No | A JSON array of titles and additional URLs displayed to users (in the order they appear in your metadata) in your extension's details page. Docker recommends you display the following links if they apply: documentation, support, terms of service, and privacy policy links. | `[{"title":"Documentation","url":"https://foo.bar/docs"},` `{"title":"Support","url":"https://foo.bar/support"},` `{"title":"Terms of Service","url":"https://foo.bar/tos"},` `{"title":"Privacy policy","url":"https://foo.bar/privacy-policy"}]` | -| `com.docker.extension.changelog` | Yes | Changelog in plain text or HTML containing the change for the current version only. | `Extension changelog` or `

Extension changelog

` | -| `com.docker.extension.account-info` | No | Whether the user needs to register to a SaaS platform to use some features of the extension. | `required` in case it does, leave it empty otherwise. | -| `com.docker.extension.categories` | No | The list of Marketplace categories that your extension belongs to: `ci-cd`, `container-orchestration`, `cloud-deployment`, `cloud-development`, `database`, `kubernetes`, `networking`, `image-registry`, `security`, `testing-tools`, `utility-tools`,`volumes`. If you don't specify this label, users won't be able to find your extension in the Extensions Marketplace when filtering by a category. Extensions published to the Marketplace before the 22nd of September 2022 have been auto-categorized by Docker. | Specified as comma separated values in case of having multiple categories e.g: `kubernetes,security` or a single value e.g. `kubernetes`. | +| Label | Required | Description | Example | +| ------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `org.opencontainers.image.title` | Yes | Human-readable title of the image (string). This appears in the UI for Docker Desktop. | my-extension | +| `org.opencontainers.image.description` | Yes | Human-readable description of the software packaged in the image (string) | This extension is cool. | +| `org.opencontainers.image.vendor` | Yes | Name of the distributing entity, organization, or individual. | Acme, Inc. | +| `com.docker.desktop.extension.api.version` | Yes | Version of the Docker Extension manager that the extension is compatible with. It must follow [semantic versioning](https://semver.org/). | A specific version like `0.1.0` or, a constraint expression: `>= 0.1.0`, `>= 1.4.7, < 2.0` . For your first extension, you can use `docker extension version` to know the SDK API version and specify `>= `. | +| `com.docker.desktop.extension.icon` | Yes | The extension icon (format: .svg .png .jpg) | `https://example.com/assets/image.svg` | +| `com.docker.extension.screenshots` | Yes | A JSON array of image URLs and an alternative text displayed to users (in the order they appear in your metadata) in your extension's details page. **Note:** The recommended size for screenshots is 2400x1600 pixels. | `[{"alt":"alternative text for image 1",` `"url":"https://example.com/image1.png"},` `{"alt":"alternative text for image2",` `"url":"https://example.com/image2.jpg"}]` | +| `com.docker.extension.detailed-description` | Yes | Additional information in plain text or HTML about the extension to display in the details dialog. | `My detailed description` or `

My detailed description

` | +| `com.docker.extension.publisher-url` | Yes | The publisher website URL to display in the details dialog. | `https://example.com` | +| `com.docker.extension.additional-urls` | No | A JSON array of titles and additional URLs displayed to users (in the order they appear in your metadata) in your extension's details page. Docker recommends you display the following links if they apply: documentation, support, terms of service, and privacy policy links. | `[{"title":"Documentation","url":"https://example.com/docs"},` `{"title":"Support","url":"https://example.com/bar/support"},` `{"title":"Terms of Service","url":"https://example.com/tos"},` `{"title":"Privacy policy","url":"https://example.com/privacy"}]` | +| `com.docker.extension.changelog` | Yes | Changelog in plain text or HTML containing the change for the current version only. | `Extension changelog` or `

Extension changelog

    ` `
  • New feature A
    • ` `
  • Bug fix on feature B

` | +| `com.docker.extension.account-info` | No | Whether the user needs to register to a SaaS platform to use some features of the extension. | `required` in case it does, leave it empty otherwise. | +| `com.docker.extension.categories` | No | The list of Marketplace categories that your extension belongs to: `ci-cd`, `container-orchestration`, `cloud-deployment`, `cloud-development`, `database`, `kubernetes`, `networking`, `image-registry`, `security`, `testing-tools`, `utility-tools`,`volumes`. If you don't specify this label, users won't be able to find your extension in the Extensions Marketplace when filtering by a category. Extensions published to the Marketplace before the 22nd of September 2022 have been auto-categorized by Docker. | Specified as comma separated values in case of having multiple categories e.g: `kubernetes,security` or a single value e.g. `kubernetes`. | > [!TIP] > diff --git a/hugo.yaml b/hugo.yaml index 09d8394133..ef8bd7f77b 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -37,18 +37,6 @@ markup: # Use custom CSS for syntax highlighting noClasses: false -related: - includeNewer: true - indices: - - name: keywords - weight: 80 - - name: fragmentrefs - applyFilter: false - type: fragments - weight: 80 - threshold: 20 - toLower: false - build: # Generate hugo_stats.json - Tailwind uses this to detect classes buildStats: @@ -113,14 +101,9 @@ params: google: GTM-WL2QLG5 onetrust: 65425fb0-7b36-4317-9f10-7b3e08039af0 vwo: 723167 - algolia: - appid: 3XRLW0LZH9 - apikey: 2899036ce47dba191b8dc1758e4bc6a4 - indexname: docker # Docs repository URL repo: https://github.com/docker/docs - docs_url: https://docs.docker.com # === Example versions === # The following parameters are used in various ways in content and templates. @@ -136,8 +119,6 @@ params: docker_ce_version_prev: "27.4.1" # Latest Docker Compose version compose_version: "v2.32.3" - compose_file_v3: "3.8" - compose_file_v2: "2.4" # Latest BuildKit version buildkit_version: "0.16.0" diff --git a/hugo_stats.json b/hugo_stats.json index 4cb719a37c..057958e87d 100644 --- a/hugo_stats.json +++ b/hugo_stats.json @@ -61,7 +61,6 @@ "Go", "HTTP", "Heredocs", - "Hub", "Hyper-V-backend-x86_64", "Inline", "JSON", diff --git a/static/assets/images/engine.svg b/static/assets/images/engine.svg deleted file mode 100644 index 7b948c51f9..0000000000 --- a/static/assets/images/engine.svg +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -