From 3bf5edeb65e4879dbdf709ba9108c03eb94a9c69 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:49:10 +0100 Subject: [PATCH 1/2] chore: add comments explaining hugo.yaml config Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- hugo.yaml | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/hugo.yaml b/hugo.yaml index f433a02eebf3..09d8394133ab 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -11,6 +11,7 @@ taxonomies: tag: tags language: languages +# Remove the /manuals prefix for content in the manuals section permalinks: page: manuals: /:sections[1:]/:slugorfilename/ @@ -27,10 +28,13 @@ markup: parser: wrapStandAloneImageWithinParagraph: false attribute: + # Allow setting attributes on block-level elements block: true renderer: + # Allow inline HTML unsafe: true highlight: + # Use custom CSS for syntax highlighting noClasses: false related: @@ -46,10 +50,12 @@ related: toLower: false build: + # Generate hugo_stats.json - Tailwind uses this to detect classes buildStats: enable: true disableIDs: true disableTags: true + # Ensure that CSS/assets changes trigger a dev server rebuild cachebusters: - source: assets/watching/hugo_stats\.json target: styles\.css @@ -60,23 +66,29 @@ build: - source: (assets|layouts)/.*\.(.*)$ target: "$2" +# Additional output formats (e.g. custom JSON files) outputFormats: + # File containing all redirects, see: layouts/index.redirects.json redirects: baseName: redirects isPlainText: true mediaType: "application/json" notAlternative: true + # Metadata file used by DD global search, see: layouts/index.metadata.json metadata: baseName: metadata isPlainText: true mediaType: "application/json" notAlternative: true + # robots.txt, see: layouts/index.robots.json robots: baseName: robots isPlainText: true mediaType: "text/plain" notAlternative: true +# Enable custom output formats for the home page only +# (only generate the custom output files once) outputs: home: - html @@ -88,6 +100,9 @@ languages: en: languageName: English +# Site-wide parameters +# Can be accessed in content with {{% param "param_name" %}} +# Or in layouts/partials with site.Params.param_name params: kapa: id: ba5c2cbc-6535-4334-a72e-050f7a681c8a @@ -103,21 +118,36 @@ params: 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. + # Mostly as examples in code snippets, but also in other exotic ways. + # Use `grep` to figure out how they might be used. + + # Latest version of the Docker Engine API latest_engine_api_version: "1.47" + # Latest version of Docker Engine docker_ce_version: "27.5.0" + # Previous version of the Docker Engine + # (Used to show e.g., "latest" and "latest"-1 in engine install examples 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" + # Example runtime/library/os versions example_go_version: "1.23" example_alpine_version: "3.21" example_node_version: "20" + # Minimum version thresholds (used together with the "introduced" shortcode + # See layouts/shortcodes/introduced.html min_version_thresholds: buildx: "0.10.0" buildkit: "0.11.0" @@ -128,6 +158,7 @@ params: scout: "1.0.0" menus: + # Site header menu main: - name: Get started pageRef: /get-started/ @@ -142,6 +173,7 @@ menus: pageRef: /reference/ weight: 4 + # Footer links footer: - url: https://www.docker.com/products name: Product offerings @@ -241,21 +273,28 @@ menus: name: Newsletter parent: About us +# Hugo modules - for fetching docs from upstream repos +# NOTE: we always vendor upstream docs in _vendor/ +# Versions are declared in go.mod module: proxy: https://proxy.golang.org,direct hugoVersion: extended: false min: "0.139.0" mounts: + # Mount the assets directory so it doesn't get overwritten - source: assets target: assets + # Mount hugo_stats.json to the assets dir to trigger cachebust - source: hugo_stats.json target: assets/watching/hugo_stats.json + # Mount the icon files to assets so we can access them with resources.Get - source: node_modules/@material-symbols/svg-400/rounded target: assets/icons imports: + # Docker Engine - path: github.com/moby/moby mounts: - source: docs/api/v1.24.md @@ -266,6 +305,7 @@ module: target: content/reference/api/engine/version includeFiles: "*.yaml" + # BuildKit - path: github.com/moby/buildkit mounts: - source: frontend/dockerfile/docs/reference.md @@ -280,11 +320,13 @@ module: - source: docs/attestations/attestation-storage.md target: content/manuals/build/metadata/attestations/attestation-storage.md + # Buildx CLI plugin - path: github.com/docker/buildx mounts: - source: docs/bake-reference.md target: content/manuals/build/bake/reference.md + # Docker CLI - path: github.com/docker/cli mounts: - source: docs/extend @@ -300,12 +342,14 @@ module: - source: docs/reference/dockerd.md target: content/reference/cli/dockerd.md + # Compose - path: github.com/docker/compose/v2 mounts: - source: docs/reference target: data/compose-cli includeFiles: "*.yaml" + # Scout CLI plugin (public dist repo) - path: github.com/docker/scout-cli mounts: - source: docs From 7ac9a0b6a5c03f60e49970c09550af7df0b8b4ff Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:51:44 +0100 Subject: [PATCH 2/2] chore: config cleanup, remove unused parameters Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- .../extensions-sdk/extensions/labels.md | 28 ++++++------ hugo.yaml | 19 -------- hugo_stats.json | 1 - static/assets/images/engine.svg | 44 ------------------- 4 files changed, 14 insertions(+), 78 deletions(-) delete mode 100644 static/assets/images/engine.svg diff --git a/content/manuals/extensions/extensions-sdk/extensions/labels.md b/content/manuals/extensions/extensions-sdk/extensions/labels.md index 626a1e32eb03..bb670d513747 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 09d8394133ab..ef8bd7f77b0f 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 4cb719a37c91..057958e87d5c 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 7b948c51f9d7..000000000000 --- a/static/assets/images/engine.svg +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -