diff --git a/_vale/Docker/Acronyms.yml b/_vale/Docker/Acronyms.yml index e01063056cc3..866d870d3490 100644 --- a/_vale/Docker/Acronyms.yml +++ b/_vale/Docker/Acronyms.yml @@ -75,6 +75,7 @@ exceptions: - MAC - MDM - MDN + - MSI - NAT - NET - NFS diff --git a/content/guides/java/run-tests.md b/content/guides/java/run-tests.md index e1d26c961c1b..c88025ad82b6 100644 --- a/content/guides/java/run-tests.md +++ b/content/guides/java/run-tests.md @@ -95,7 +95,7 @@ fail if the tests fail. Finally, you updated the deps stage to be based on the base stage and removed the instructions that are now in the base stage. -Run the following command to build a new image using the test stage as the target and view the test results. Include `--progress=plain` to view the build output, `--no-cache` to ensure the tests always run, and `--target-test` to target the test stage. +Run the following command to build a new image using the test stage as the target and view the test results. Include `--progress=plain` to view the build output, `--no-cache` to ensure the tests always run, and `--target test` to target the test stage. Now, build your image and run your tests. You'll run the `docker build` command and add the `--target test` flag so that you specifically run the test build stage. diff --git a/content/guides/ruby/containerize.md b/content/guides/ruby/containerize.md index 83f0c3933ecf..ed87769c0516 100644 --- a/content/guides/ruby/containerize.md +++ b/content/guides/ruby/containerize.md @@ -67,7 +67,7 @@ FROM base AS build # Install packages needed to build gems RUN apt-get update -qq && \ - apt-get install --no-install-recommends -y build-essential curl git pkg-config && \ + apt-get install --no-install-recommends -y build-essential curl git pkg-config libyaml-dev && \ rm -rf /var/lib/apt/lists /var/cache/apt/archives # Install JavaScript dependencies and Node.js for asset compilation diff --git a/content/manuals/accounts/_index.md b/content/manuals/accounts/_index.md index 6da49ef20b43..65797233c44a 100644 --- a/content/manuals/accounts/_index.md +++ b/content/manuals/accounts/_index.md @@ -2,6 +2,7 @@ title: Docker accounts description: Learn how to create and manage your Docker account. keywords: accounts, docker ID, account management, account settings, docker account, docker home +weight: 30 params: sidebar: group: Platform diff --git a/content/manuals/accounts/manage-account.md b/content/manuals/accounts/manage-account.md index 9d28ded5cbca..316a8d654e3b 100644 --- a/content/manuals/accounts/manage-account.md +++ b/content/manuals/accounts/manage-account.md @@ -27,7 +27,7 @@ To update your account information, select the arrow icon. You can edit the foll - Company - Location - Website -- Gravatar email +- Gravatar email: To add an avatar to your Docker account, create a [Gravatar account](https://gravatar.com/) and create your avatar. Next, add your Gravatar email to your Docker account settings. It may take some time for your avatar to update in Docker. This information is visible on your account profile in Docker Hub. diff --git a/content/manuals/admin/_index.md b/content/manuals/admin/_index.md index 72f14268db76..8ea5bd56c7d2 100644 --- a/content/manuals/admin/_index.md +++ b/content/manuals/admin/_index.md @@ -2,6 +2,7 @@ title: Administration description: Discover manuals on administration for accounts, organizations, and companies. keywords: admin, administration, company, organization, Admin Console, user accounts, account management +weight: 10 params: sidebar: group: Platform diff --git a/content/manuals/admin/faqs/general-faqs.md b/content/manuals/admin/faqs/general-faqs.md index 28b6c0f3128b..eb34f31a5fcb 100644 --- a/content/manuals/admin/faqs/general-faqs.md +++ b/content/manuals/admin/faqs/general-faqs.md @@ -80,3 +80,9 @@ If the user is a member of your organization, you can remove the user from your ### How do I manage settings for a user account? You can manage your account settings anytime when you sign in to your [Docker account](https://app.docker.com/login). In Docker Home, select your avatar in the top-right navigation, then select **My Account**. You can also access this menu from any Docker web applications when you're signed in to your account. See [Manage your Docker account](/accounts/manage-account). If your account is associated with an organization that uses SSO, you may have limited access to the settings that you can control. + +### How do I add an avatar to my Docker account? + +To add an avatar to your Docker account, create a [Gravatar account](https://gravatar.com/) and create your avatar. Next, add your Gravatar email to your Docker account settings. + +Note, that it may take some time for your avatar to update in Docker. diff --git a/content/manuals/admin/organization/general-settings.md b/content/manuals/admin/organization/general-settings.md index ada92c672a61..d6ce00340418 100644 --- a/content/manuals/admin/organization/general-settings.md +++ b/content/manuals/admin/organization/general-settings.md @@ -18,7 +18,7 @@ This information includes: - Company - Location - Website - - Avatar + - Gravatar email: To add an avatar to your Docker account, create a [Gravatar account](https://gravatar.com/) and create your avatar. Next, add your Gravatar email to your Docker account settings. It may take some time for your avatar to update in Docker. To edit this information: diff --git a/content/manuals/billing/_index.md b/content/manuals/billing/_index.md index 0c2d49073d77..0e2ea0f91cae 100644 --- a/content/manuals/billing/_index.md +++ b/content/manuals/billing/_index.md @@ -3,6 +3,7 @@ title: Billing and payments linkTitle: Billing description: Discover information on billing and payment processes for Docker subscriptions. keywords: billing, invoice, payment, subscription +weight: 20 params: sidebar: group: Platform diff --git a/content/manuals/build/buildkit/_index.md b/content/manuals/build/buildkit/_index.md index 71927e567004..89d75f2ad539 100644 --- a/content/manuals/build/buildkit/_index.md +++ b/content/manuals/build/buildkit/_index.md @@ -110,9 +110,8 @@ daemon. > [!WARNING] > -> BuildKit only fully supports building Linux containers. -> Windows container support is experimental, and is tracked in -> [`moby/buildkit#616`](https://github.com/moby/buildkit/issues/616). +> BuildKit only fully supports building Linux containers. Windows container +> support is experimental. BuildKit has experimental support for Windows containers (WCOW) as of version 0.13. This section walks you through the steps for trying it out. @@ -120,8 +119,8 @@ We appreciate any feedback you submit by [opening an issue here](https://github. ### Known limitations -- BuildKit on Windows currently only supports the `containerd` worker. - Support for non-OCI workers is tracked in [moby/buildkit#4836](https://github.com/moby/buildkit/issues/4836). +For information about open bugs and limitations related to BuildKit on Windows, +see [GitHub issues](https://github.com/moby/buildkit/issues?q=is%3Aissue%20state%3Aopen%20label%3Aarea%2Fwindows-wcow). ### Prerequisites diff --git a/content/manuals/desktop/setup/install/enterprise-deployment/faq.md b/content/manuals/desktop/setup/install/enterprise-deployment/faq.md index 0936a2a81fc4..979485823707 100644 --- a/content/manuals/desktop/setup/install/enterprise-deployment/faq.md +++ b/content/manuals/desktop/setup/install/enterprise-deployment/faq.md @@ -1,5 +1,5 @@ --- -title: FAQs +title: Enterprise deployment FAQs description: Frequently asked questions for deploying Docker Desktop at scale keywords: msi, deploy, docker desktop, faqs, pkg, mdm, jamf, intune, windows, mac, enterprise, admin tags: [FAQ, admin] diff --git a/content/manuals/desktop/setup/install/linux/rhel.md b/content/manuals/desktop/setup/install/linux/rhel.md index a2e3db85bc80..91baeee45de1 100644 --- a/content/manuals/desktop/setup/install/linux/rhel.md +++ b/content/manuals/desktop/setup/install/linux/rhel.md @@ -93,7 +93,7 @@ To install Docker Desktop on RHEL: $ sudo dnf config-manager --add-repo {{% param "download-url-base" %}}/docker-ce.repo ``` -2. Download the latest [RPM package](https://desktop.docker.com/linux/main/amd64/docker-desktop-x86_64.rpm?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64). +2. Download the latest [RPM package](https://desktop.docker.com/linux/main/amd64/docker-desktop-x86_64-rhel.rpm?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64). 3. Install the package with dnf as follows: diff --git a/content/manuals/desktop/troubleshoot-and-support/faqs/general.md b/content/manuals/desktop/troubleshoot-and-support/faqs/general.md index 54f80dd95452..2a48392d84ed 100644 --- a/content/manuals/desktop/troubleshoot-and-support/faqs/general.md +++ b/content/manuals/desktop/troubleshoot-and-support/faqs/general.md @@ -82,7 +82,7 @@ You can then sign in to your machine with the user ID specified, and launch Dock > [!NOTE] > -> Before launching Docker Desktop, if a `settings.json` file already exists in the `~/Library/Group Containers/group.com.docker/` directory, you will see a **Finish setting up Docker Desktop** window that prompts for administrator privileges when you select **Finish**. To avoid this, ensure you delete the `settings.json` file left behind from any previous installations before launching the application. +> Before launching Docker Desktop, if a `settings-store.json` file (or `settings.json` for Docker Desktop versions 4.34 and earlier) already exists in the `~/Library/Group Containers/group.com.docker/` directory, you will see a **Finish setting up Docker Desktop** window that prompts for administrator privileges when you select **Finish**. To avoid this, ensure you delete the `settings-store.json` file (or `settings.json` for Docker Desktop versions 4.34 and earlier) left behind from any previous installations before launching the application. {{< /tab >}} {{< tab name="Windows" >}} diff --git a/content/manuals/docker-hub/release-notes.md b/content/manuals/docker-hub/release-notes.md index 29361bcf66b9..69dc8b48d2a8 100644 --- a/content/manuals/docker-hub/release-notes.md +++ b/content/manuals/docker-hub/release-notes.md @@ -15,17 +15,11 @@ known issues for each Docker Hub release. Take a look at the [Docker Public Roadmap](https://github.com/orgs/docker/projects/51/views/1?filterQuery=) to see what's coming next. -## 2024-11-11 +## 2024-12-12 ### New -- [Personal access tokens](/security/for-developers/access-tokens/) (PATs) now support expiration dates. - -## 2024-10-15 - -### New - -- Beta: You can now create [organization access tokens](/security/for-admins/access-tokens/) (OATs) to enhance security for organizations and streamline access management for organizations. +- The AI Catalog in Docker Hub is available directly through Docker Desktop. ## 2024-03-23 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/content/manuals/platform-release-notes.md b/content/manuals/platform-release-notes.md new file mode 100644 index 000000000000..e7ceb4457104 --- /dev/null +++ b/content/manuals/platform-release-notes.md @@ -0,0 +1,71 @@ +--- +title: Release notes for Docker Home, the Admin Console, billing, security, and subscription features +linkTitle: Release notes +description: Learn about the new features, bug fixes, and breaking changes for Docker Home, the Admin Console, and billing and subscription features +keywords: Docker Home, Docker Admin Console, billing, subscription, security, admin, releases, what's new +weight: 60 +params: + sidebar: + group: Platform +tags: [Release notes, admin] +--- + +This page provides details on new features, enhancements, known issues, and bug fixes across Docker Home, the Admin Console, billing, security, and subscription functionalities. + +Take a look at the [Docker Public Roadmap](https://github.com/orgs/docker/projects/51/views/1?filterQuery=) to see what's coming next. + +## 2024-12-10 + +### New + +- New Docker subscriptions are now available. For more information, see [Docker + subscriptions and features](/manuals/subscription/details.md) and [Announcing + Upgraded Docker Plans: Simpler, More Value, Better Development and + Productivity](https://www.docker.com/blog/november-2024-updated-plans-announcement/). + +## 2024-11-18 + +### New + +- Administrators can now: + - Enforce sign-in with macOS [configuration profiles](/manuals/security/for-admins/enforce-sign-in/methods.md#configuration-profiles-method-mac-only) (Early Access). + - Enforce sign-in for more than one organization at a time (Early Access). + - Deploy Docker Desktop for Mac in bulk with the [PKG installer](/manuals/desktop/setup/install/enterprise-deployment/pkg-install-and-configure.md) (Early Access). + - [Use Desktop Settings Management via the Docker Admin Console](/manuals/security/for-admins/hardened-desktop/settings-management/configure-admin-console.md) (Early Access). + +### Bug fixes and enhancements + +- Enhance Container Isolation (ECI) has been improved to: + - Permit admins to [turn off Docker socket mount restrictions](/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md#allowing-all-containers-to-mount-the-docker-socket). + - Support wildcard tags when using the [`allowedDerivedImages` setting](/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md#docker-socket-mount-permissions-for-derived-images). + +## 2024-11-11 + +### New + +- [Personal access tokens](/security/for-developers/access-tokens/) (PATs) now support expiration dates. + +## 2024-10-15 + +### New + +- Beta: You can now create [organization access tokens](/security/for-admins/access-tokens/) (OATs) to enhance security for organizations and streamline access management for organizations in the Docker Admin Console. + +## 2024-08-29 + +### New + +- Deploying Docker Desktop via the [MSI installer](/manuals/desktop/setup/install/enterprise-deployment/msi-install-and-configure.md) is now generally available. +- Two new methods to [enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md) (Windows registry key and `.plist` file) are now generally available. + +## 2024-08-24 + +### New + +- Administrators can now view [organization insights](/manuals/admin/organization/insights.md) (Early Access). + +## 2024-07-17 + +### New + +- You can now centrally access and manage Docker products in [Docker Home](https://app.docker.com) (Early Access). \ No newline at end of file diff --git a/content/manuals/security/_index.md b/content/manuals/security/_index.md index c7d4dc29a9f6..1d2ecf3b2403 100644 --- a/content/manuals/security/_index.md +++ b/content/manuals/security/_index.md @@ -2,6 +2,7 @@ title: Security description: Learn about security features Docker has to offer and explore best practices keywords: docker, docker hub, docker desktop, security +weight: 40 params: sidebar: group: Platform diff --git a/content/manuals/security/faqs/single-sign-on/domain-faqs.md b/content/manuals/security/faqs/single-sign-on/domain-faqs.md index a991edc74522..1946068befcc 100644 --- a/content/manuals/security/faqs/single-sign-on/domain-faqs.md +++ b/content/manuals/security/faqs/single-sign-on/domain-faqs.md @@ -1,7 +1,7 @@ --- description: Single sign-on domain FAQs keywords: Docker, Docker Hub, SSO FAQs, single sign-on, domains, domain verification, domain management -title: Domains +title: FAQS on SSO and domains tags: [FAQ] aliases: - /single-sign-on/domain-faqs/ diff --git a/content/manuals/security/faqs/single-sign-on/enforcement-faqs.md b/content/manuals/security/faqs/single-sign-on/enforcement-faqs.md index 23be1ea11f8e..11d31eeecfa3 100644 --- a/content/manuals/security/faqs/single-sign-on/enforcement-faqs.md +++ b/content/manuals/security/faqs/single-sign-on/enforcement-faqs.md @@ -1,7 +1,7 @@ --- description: Single sign-on enforcement FAQs keywords: Docker, Docker Hub, SSO FAQs, single sign-on, enforce SSO, SSO enforcement -title: Enforcement +title: FAQs on SSO and enforcement tags: [FAQ] aliases: - /single-sign-on/enforcement-faqs/ diff --git a/content/manuals/security/faqs/single-sign-on/idp-faqs.md b/content/manuals/security/faqs/single-sign-on/idp-faqs.md index d67ccab424bd..01aff89b9b17 100644 --- a/content/manuals/security/faqs/single-sign-on/idp-faqs.md +++ b/content/manuals/security/faqs/single-sign-on/idp-faqs.md @@ -1,7 +1,7 @@ --- description: Single sign-on IdP FAQs keywords: Docker, Docker Hub, SSO FAQs, single sign-on, IdP -title: Identity providers +title: FAQs on SSO and identity providers tags: [FAQ] aliases: - /single-sign-on/idp-faqs/ diff --git a/content/manuals/security/faqs/single-sign-on/users-faqs.md b/content/manuals/security/faqs/single-sign-on/users-faqs.md index ba720c937166..64a9c62ec45a 100644 --- a/content/manuals/security/faqs/single-sign-on/users-faqs.md +++ b/content/manuals/security/faqs/single-sign-on/users-faqs.md @@ -1,7 +1,7 @@ --- description: Single sign-on user management FAQs keywords: Docker, Docker Hub, SSO FAQs, single sign-on -title: Manage users +title: FAQs on SSO and managing users tags: [FAQ] aliases: - /single-sign-on/users-faqs/ diff --git a/content/manuals/subscription/_index.md b/content/manuals/subscription/_index.md index b33d97665723..7cfa0d8d1f16 100644 --- a/content/manuals/subscription/_index.md +++ b/content/manuals/subscription/_index.md @@ -2,6 +2,7 @@ title: Subscription description: Learn about subscription features and how to manage your subscription keywords: Docker, pricing, billing, Pro, Team, business, subscription, tier, plan +weight: 50 params: sidebar: group: Platform diff --git a/hugo.yaml b/hugo.yaml index f433a02eebf3..ef8bd7f77b0f 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,29 +28,22 @@ 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: - 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: 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 +54,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 +88,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 @@ -98,26 +101,34 @@ 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. + # 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 +139,7 @@ params: scout: "1.0.0" menus: + # Site header menu main: - name: Get started pageRef: /get-started/ @@ -142,6 +154,7 @@ menus: pageRef: /reference/ weight: 4 + # Footer links footer: - url: https://www.docker.com/products name: Product offerings @@ -241,21 +254,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 +286,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 +301,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 +323,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 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 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -