diff --git a/.markdownlint.json b/.markdownlint.json index e4df3c8ee327..93b3f1de588a 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -1,6 +1,9 @@ { "default": false, "hr-style": true, + "heading-start-left": true, + "single-h1": true, + "no-trailing-punctuation": true, "no-missing-space-atx": true, "no-multiple-space-atx": true, "no-missing-space-closed-atx": true, @@ -8,10 +11,13 @@ "no-space-in-emphasis": true, "no-space-in-code": true, "no-space-in-links": true, + "no-empty-links": true, "ol-prefix": {"style": "ordered"}, "no-reversed-links": true, "reference-links-images": { "shortcut_syntax": true }, - "fenced-code-language": true + "fenced-code-language": true, + "table-pipe-style": true, + "table-column-count": true } diff --git a/content/admin/company/users.md b/content/admin/company/users.md index 8f5f7913612f..5144baa442a2 100644 --- a/content/admin/company/users.md +++ b/content/admin/company/users.md @@ -12,4 +12,4 @@ You can manage users at the company-level in the Docker Admin Console. ## Manage members on a team -Use Docker Hub to add a member to a team or remove a member from a team. For more details, see [Manage members in Docker Hub](#). \ No newline at end of file +Use Docker Hub to add a member to a team or remove a member from a team. For more details, see [Manage members in Docker Hub](../organization/members.md#manage-members-on-a-team). diff --git a/content/build/cache/_index.md b/content/build/cache/_index.md index 42507216fd8d..ac2abe6d7503 100644 --- a/content/build/cache/_index.md +++ b/content/build/cache/_index.md @@ -243,7 +243,7 @@ stages in parallel. Only the instructions in the `site` stage will end up as layers in the final image. The entire `git` history doesn't get embedded into the final result, which helps keep the image small and secure. -#### Combine commands together wherever possible. +#### Combine commands together wherever possible Most Dockerfile commands, and `RUN` commands in particular, can often be joined together. For example, instead of using `RUN` like this: diff --git a/content/compose/gpu-support.md b/content/compose/gpu-support.md index e7f8a553c137..e82f719808d9 100644 --- a/content/compose/gpu-support.md +++ b/content/compose/gpu-support.md @@ -31,7 +31,7 @@ This provides more granular control over a GPU reservation as custom values can For more information on these properties, see the [Compose Deploy Specification](compose-file/deploy.md#devices). -### Example of a Compose file for running a service with access to 1 GPU device: +### Example of a Compose file for running a service with access to 1 GPU device ```yaml services: diff --git a/content/compose/release-notes.md b/content/compose/release-notes.md index b788c94de483..c1fadfb0d2c2 100644 --- a/content/compose/release-notes.md +++ b/content/compose/release-notes.md @@ -2865,7 +2865,7 @@ naming scheme accordingly before upgrading. ## 1.6.0 (2016-01-15) -### Major Features: +### Major Features - Compose 1.6 introduces a new format for `docker-compose.yml` which lets you define networks and volumes in the Compose file as well as services. It @@ -2913,7 +2913,7 @@ naming scheme accordingly before upgrading. `docker-compose up SERVICE` on a service with dependencies, those are started as well. -### New Features: +### New Features - Added a new command `config` which validates and prints the Compose configuration after interpolating variables, resolving relative paths, and diff --git a/content/compose/use-secrets.md b/content/compose/use-secrets.md index 27c373550a5e..36b9eea71576 100644 --- a/content/compose/use-secrets.md +++ b/content/compose/use-secrets.md @@ -81,7 +81,7 @@ In the advanced example above: > > The `_FILE` environment variables demonstrated here are a convention used by some images, including Docker Official Images like [mysql](https://hub.docker.com/_/mysql) and [postgres](https://hub.docker.com/_/postgres). -## Resources: +## Resources - [Secrets top-level element](compose-file/09-secrets.md) -- [Secrets attribute for services top-level element](compose-file/05-services.md#secrets) \ No newline at end of file +- [Secrets attribute for services top-level element](compose-file/05-services.md#secrets) diff --git a/content/config/formatting.md b/content/config/formatting.md index ca95c8d1d76b..8ac2fb77b125 100644 --- a/content/config/formatting.md +++ b/content/config/formatting.md @@ -97,7 +97,7 @@ $ docker inspect --format "{{upper .Name}}" container $ docker inspect --format='{{range .NetworkSettings.Networks}}{{println .IPAddress}}{{end}}' container ``` -# Hint +## Hint To find out what data can be printed, show all content as json: diff --git a/content/contribute/style/formatting.md b/content/contribute/style/formatting.md index 662bd386eea9..850ebd3edb85 100644 --- a/content/contribute/style/formatting.md +++ b/content/contribute/style/formatting.md @@ -9,7 +9,7 @@ toc_max: 2 Readers pay fractionally more attention to headings, bulleted lists, and links, so it's important to ensure the first two to three words in those items "front load" information as much as possible. -### Best practice: +### Best practice - Headings and subheadings should let the reader know what they will find on the page. - They should describe succinctly and accurately what the content is about. @@ -21,7 +21,7 @@ Readers pay fractionally more attention to headings, bulleted lists, and links, Page titles should be action orientated. For example: - _Enable SCIM_ - _Install Docker Desktop_ -### Best practice: +### Best practice - Make sure the title of your page and the table of contents (TOC) entry matches. - If you want to use a ‘:’ in a page title in the table of contents (\_toc.yaml), you must wrap the entire title in “” to avoid breaking the build. @@ -31,7 +31,7 @@ Page titles should be action orientated. For example: - _Enable SCIM_ - _Install Images, including screenshots, can help a reader better understand a concept. However, you should use them sparingly as they tend to go out-of-date. -### Best practice: +### Best practice - When you take screenshots: - Don’t use lorem ipsum text. Try to replicate how someone would use the feature in a real-world scenario, and use realistic text. @@ -52,7 +52,7 @@ When people follow links, they can often lose their train of thought and fail to The best links offer readers another way to scan information. -### Best practice: +### Best practice - Use plain language that doesn't mislead or promise too much. - Be short and descriptive (around five words is best). @@ -72,7 +72,7 @@ To apply inline code style, wrap the text in a single backtick (`). For information on how to add code blocks to your content, see [Useful component and formatting examples](../components/code-blocks.md). -### Best practice for commands: +### Best practice for commands - Command prompt and shell: - For a non-privileged shell, prefix commands in code blocks with the $ prompt symbol. @@ -89,7 +89,7 @@ For information on how to add code blocks to your content, see [Useful component - Use pipes ( \| ) between mutually exclusive arguments. - Use three dots ( ... ) after repeated arguments. -### Best practice for code: +### Best practice for code - Indent code blocks by 3 spaces when you nest a code block under a list item. - Use three dots ( ... ) when you omit code. @@ -98,7 +98,7 @@ For information on how to add code blocks to your content, see [Useful component Use callouts to emphasize selected information on a page. -### Best practice: +### Best practice - Format the word Warning, Important, or Note in bold. Don't bold the content within the callout. - It's good practice to avoid placing a lot of text callouts on one page. They can create a cluttered appearance if used to excess, and you'll diminish their impact. @@ -110,7 +110,7 @@ Use callouts to emphasize selected information on a page. | Important | Use an Important tag to signal to the reader where actions may cause issues of a lower magnitude. | Yellow | | | ✅ Example: Update to the Docker Desktop terms | | | Note | Use the Note tag for information that may not apply to all readers, or if the information is tangential to a topic. | Blue | -| | ✅ Example: Deleting a repository deletes all the images it contains and its build settings. This action cannot be undone. | +| | ✅ Example: Deleting a repository deletes all the images it contains and its build settings. This action cannot be undone. | | For information on how to add callouts to your content, see [Useful component and formatting examples](../components/call-outs.md). @@ -149,7 +149,7 @@ Use tables to describe complex information in a straightforward manner. Note that in many cases, an unordered list is enough to describe a list of items with a single, simple description per item. But, if you have data that’s best described by a matrix, tables are the best choice. -### Best practice: +### Best practice - Use sentence case for table headings. - To keep tables accessible and scannable, tables shouldn't have any empty cells. If there is no otherwise meaningful value for a cell, consider entering N/A for ‘not applicable’ or None. @@ -173,4 +173,4 @@ When you're referring to units of measurement, use the abbreviated form in all c | --- | --- | | 10 GB | 10GB | | 10 GB | 10 gb | - | 10 GB | 10 gigabytes | \ No newline at end of file + | 10 GB | 10 gigabytes | diff --git a/content/contribute/style/grammar.md b/content/contribute/style/grammar.md index b6c9a868a3a0..1b3d985e2f59 100644 --- a/content/contribute/style/grammar.md +++ b/content/contribute/style/grammar.md @@ -13,7 +13,7 @@ An acronym is an abbreviation you would speak as a word, for example, ROM (for r An initialism is a type of acronym that comprises a group of initial letters used as an abbreviation for a name or expression. If you were using the acronym in a spoken conversation, you would enunciate each letter: H-T-M-L for Hypertext Markup Language. -### Best practice: +### Best practice - Spell out lesser-known acronyms or initialisms on first use, then follow with the acronym or initialism in parentheses. After this, throughout the rest of your page or document, use the acronym or initialism alone. > ‘You can use single sign-on (SSO) to sign in to Notion. You may need to ask your administrator to enable SSO.’ @@ -26,7 +26,7 @@ An initialism is a type of acronym that comprises a group of initial letters use Unless you're referring to UI text or user-defined text, you shouldn't add emphasis to text. Clear, front-loaded wording makes the subject of a sentence clear. -### Best practice: +### Best practice - Don't use bold to refer to a feature name. - Use italics sparingly, as this type of formatting can be difficult to read in digital experiences. @@ -63,7 +63,7 @@ A contraction results from letters being left out from the original word or phra Following our conversational approach, it's acceptable to use contractions in almost all content types. Just don't get carried away. Too many contractions in a sentence can make it difficult to read. -### Best practice: +### Best practice - Stay consistent - don't switch between contractions and their spelled-out equivalents in body copy or UI text. - Avoid negative contractions (can't, don't, wouldn't, and shouldn't) whenever possible. Try to rewrite your sentence to align with our helpful approach that puts the focus on solutions, not problems. @@ -79,7 +79,7 @@ When possible, use the month's full name (October 1, 2022). If there are space c In all UI content and technical documentation, use decimals instead of fractions. -### Best practice: +### Best practice - Always carry decimals to at least the hundredth place (33.76). - In tables, align decimals on the decimal point. @@ -89,7 +89,7 @@ In all UI content and technical documentation, use decimals instead of fractions Lists are a great way to break down complex ideas and make them easier to read and scan. -### Best practice: +### Best practice - Bulleted lists should contain relatively few words or short phrases. For most content types, limit the number of items in a list to five. - Don’t add commas (,) or semicolons (;) to the ends of list items. @@ -168,4 +168,4 @@ Don't use parentheses in technical documentation. They can reduce the readabilit ## Third party documentation -If you are documenting a task that requires the use of a third-party product, link out to the third-party's documentation. Don't copy the content because it might violate copyright. It can also result in an unnecessary maintenance burden of having to keep the docs up-to-date when the third-party changes or updates their product. It is best practice to link to the single source of truth. \ No newline at end of file +If you are documenting a task that requires the use of a third-party product, link out to the third-party's documentation. Don't copy the content because it might violate copyright. It can also result in an unnecessary maintenance burden of having to keep the docs up-to-date when the third-party changes or updates their product. It is best practice to link to the single source of truth. diff --git a/content/contribute/style/recommended-words.md b/content/contribute/style/recommended-words.md index 994899adb402..74ea06a20d38 100644 --- a/content/contribute/style/recommended-words.md +++ b/content/contribute/style/recommended-words.md @@ -86,8 +86,12 @@ _In Docker Desktop 4.1 and lower._ What might be easy for you might not be easy for others. Try eliminating this word from the sentence because usually the same meaning can be conveyed without it. + + #### e.g. + + Don't use. Instead, use phrases like `for example` or `such as`. #### enable @@ -160,9 +164,9 @@ _Turn on the dark mode toggle._ Use `upgrade` when describing a higher subscription tier -#### vs. +#### vs -Don't use `vs.` as an abbreviation for versus; instead, use the unabbreviated `versus`. +Don't use `vs` or `vs.` as an abbreviation for versus; instead, use the unabbreviated `versus`. #### we @@ -178,4 +182,4 @@ _We created a feature for you to add widgets._ #### wish -Don't use. Use `want` instead. \ No newline at end of file +Don't use. Use `want` instead. diff --git a/content/desktop/extensions-sdk/design/design-guidelines.md b/content/desktop/extensions-sdk/design/design-guidelines.md index a7e0f41a4ae8..a142e748fb48 100644 --- a/content/desktop/extensions-sdk/design/design-guidelines.md +++ b/content/desktop/extensions-sdk/design/design-guidelines.md @@ -12,7 +12,7 @@ Here is a simple checklist to go through when creating your extension: - Is it easy to get help when needed? -## Create a consistent experience with Docker Desktop. +## Create a consistent experience with Docker Desktop Use the [Docker Material UI Theme](https://www.npmjs.com/package/@docker/docker-mui-theme) and the [Docker Extensions Styleguide](https://www.figma.com/file/U7pLWfEf6IQKUHLhdateBI/Docker-Design-Guidelines?node-id=1%3A28771) to ensure that your extension feels like it is part of Docker Desktop to create a seamless experience for users. @@ -68,4 +68,4 @@ When creating your extension, ensure that first time users of the extension and - Explore our [design principles](design-principles.md). - Take a look at our [UI styling guidelines](index.md). -- Learn how to [publish your extension](../extensions/index.md). \ No newline at end of file +- Learn how to [publish your extension](../extensions/index.md). diff --git a/content/desktop/faqs/releases.md b/content/desktop/faqs/releases.md index c05a5841b57e..519463812471 100644 --- a/content/desktop/faqs/releases.md +++ b/content/desktop/faqs/releases.md @@ -12,6 +12,6 @@ New releases are available roughly every month, unless there are critical fixes Previously you had to manage this yourself. Now, it happens automatically as a side effect of all users being on the latest version. -### My colleague has got a new version but I haven’t got it yet. +### My colleague has got a new version but I haven’t got it yet Sometimes we may roll out a new version gradually over a few days. Therefore, if you wait, it will turn up soon. Alternatively, you can select **Check for Updates** from the Docker menu to jump the queue and get the latest version immediately. diff --git a/content/desktop/hardened-desktop/settings-management/configure.md b/content/desktop/hardened-desktop/settings-management/configure.md index 8cde902eab7d..27c8465c7377 100644 --- a/content/desktop/hardened-desktop/settings-management/configure.md +++ b/content/desktop/hardened-desktop/settings-management/configure.md @@ -147,18 +147,18 @@ The following `admin-settings.json` code and table provides an example of the re | `configurationFileVersion` | |Specifies the version of the configuration file format. | | `exposeDockerAPIOnTCP2375` | Windows only| Exposes the Docker API on a specified port. If `value` is set to true, the Docker API is exposed on port 2375. Note: This is unauthenticated and should only be enabled if protected by suitable firewall rules.| | `proxy` | |If `mode` is set to `system` instead of `manual`, Docker Desktop gets the proxy values from the system and ignores and values set for `http`, `https` and `exclude`. Change `mode` to `manual` to manually configure proxy servers. If the proxy port is custom, specify it in the `http` or `https` property, for example `"https": "http://myotherproxy.com:4321"`. The `exclude` property specifies a comma-separated list of hosts and domains to bypass the proxy. | -       `windowsDockerdPort` | Windows only | Exposes Docker Desktop's internal proxy locally on this port for the Windows Docker daemon to connect to. If it is set to 0, a random free port is chosen. If the value is greater than 0, use that exact value for the port. The default value is -1 which disables the option. Note: This is available for Windows containers only. | +|        `windowsDockerdPort` | Windows only | Exposes Docker Desktop's internal proxy locally on this port for the Windows Docker daemon to connect to. If it is set to 0, a random free port is chosen. If the value is greater than 0, use that exact value for the port. The default value is -1 which disables the option. Note: This is available for Windows containers only. | | `enhancedContainerIsolation` | | If `value` is set to true, Docker Desktop runs all containers as unprivileged, via the Linux user-namespace, prevents them from modifying sensitive configurations inside the Docker Desktop VM, and uses other advanced techniques to isolate them. For more information, see [Enhanced Container Isolation](../enhanced-container-isolation/index.md).| |        `dockerSocketMount` | | By default, enhanced container isolation blocks bind-mounting the Docker Engine socket into containers (e.g., `docker run -v /var/run/docker.sock:/var/run/docker.sock ...`). This allows admins to relax this in a controlled way. See [ECI Configuration](../enhanced-container-isolation/config.md) for more info. | |               `imageList` | | Indicates which container images are allowed to bind-mount the Docker Engine socket. | |               `commandList` | | Restricts the commands that containers can issue via the bind-mounted Docker Engine socket. | | `linuxVM` | |Parameters and settings related to Linux VM options - grouped together here for convenience. | -|        `wslEngineEnabled` | Windows only | If `value` is set to true, Docker Desktop uses the WSL 2 based engine. This overrides anything that may have been set at installation using the `--backend=` flag. +|        `wslEngineEnabled` | Windows only | If `value` is set to true, Docker Desktop uses the WSL 2 based engine. This overrides anything that may have been set at installation using the `--backend=` flag. | |       `dockerDaemonOptions`| |If `value` is set to true, it overrides the options in the Docker Engine config file. See the [Docker Engine reference](/engine/reference/commandline/dockerd/#daemon-configuration-file). Note that for added security, a few of the config attributes may be overridden when Enhanced Container Isolation is enabled. | |       `vpnkitCIDR` | |Overrides the network range used for vpnkit DHCP/DNS for `*.docker.internal` | |`kubernetes`| | If `enabled` is set to true, a Kubernetes single-node cluster is started when Docker Desktop starts. If `showSystemContainers` is set to true, Kubernetes containers are displayed in the UI and when you run `docker ps`. `imagesRepository` allows you to specify which repository Docker Desktop pulls the Kubernetes images from. For example, `"imagesRepository": "registry-1.docker.io/docker"`. | | `windowsContainers` | | Parameters and settings related to `windowsContainers` options - grouped together here for convenience. | -|        `dockerDaemonOptions` | | Overrides the options in the Linux daemon config file. See the [Docker Engine reference](/engine/reference/commandline/dockerd/#daemon-configuration-file).| | +|        `dockerDaemonOptions` | | Overrides the options in the Linux daemon config file. See the [Docker Engine reference](/engine/reference/commandline/dockerd/#daemon-configuration-file).| |`disableUpdate`| |If `value` is set to true, checking for and notifications about Docker Desktop updates is disabled.| |`analyticsEnabled`| |If `value` is set to false, Docker Desktop doesn't send usage statistics to Docker. | |`extensionsEnabled`| |If `value` is set to false, Docker extensions are disabled. | diff --git a/content/develop/develop-images/dockerfile_best-practices.md b/content/develop/develop-images/dockerfile_best-practices.md index 78f4469e1a71..f626a77f9ffb 100644 --- a/content/develop/develop-images/dockerfile_best-practices.md +++ b/content/develop/develop-images/dockerfile_best-practices.md @@ -44,7 +44,7 @@ When you run an image and generate a container, you add a new writable layer, al the running container, such as writing new files, modifying existing files, and deleting files, are written to this writable container layer. -## Additional resources: +## Additional resources * [Dockerfile reference](../../engine/reference/builder.md) * [More about Automated builds](../../docker-hub/builds/index.md) diff --git a/content/engine/reference/commandline/README.md b/content/engine/reference/commandline/README.md index 8c72c20fca6c..aaa2ff54813c 100644 --- a/content/engine/reference/commandline/README.md +++ b/content/engine/reference/commandline/README.md @@ -1,5 +1,8 @@ --- -{} +_build: + list: never + publishResources: false + render: never --- # About these files @@ -22,7 +25,7 @@ The output files are composed from two sources: Specifically, the Markdown inside the `## Description` and `## Examples` headings are parsed. Submit corrections to the text in those repositories. -# Updating the YAML files +## Updating the YAML files The process for generating the YAML files is still in flux. Check with @thaJeztah. Be sure to generate the YAML files with the correct @@ -30,4 +33,4 @@ release branch of `docker/cli`, for example, the `19.03` branch. After generating the YAML files, replace the YAML files in [https://github.com/docker/docs/tree/main/_data/engine-cli](https://github.com/docker/docs/tree/main/_data/engine-cli) -with the newly-generated files. Submit a pull request. \ No newline at end of file +with the newly-generated files. Submit a pull request. diff --git a/content/engine/security/https/README.md b/content/engine/security/https/README.md index bd7cb5e5b74c..85562d083541 100644 --- a/content/engine/security/https/README.md +++ b/content/engine/security/https/README.md @@ -1,5 +1,8 @@ --- -published: false +_build: + list: never + publishResources: false + render: never --- This is an initial attempt to make it easier to test the TLS (HTTPS) examples in the protect-access.md @@ -26,4 +29,4 @@ Start another terminal: root@boot2docker:/# cd docker/docs/articles/https root@boot2docker:/# make client -The last connects first with `--tls` and then with `--tlsverify`, both should succeed. \ No newline at end of file +The last connects first with `--tls` and then with `--tlsverify`, both should succeed. diff --git a/content/engine/tutorials/_index.md b/content/engine/tutorials/_index.md index 73920f628aaa..9934c6c648a1 100644 --- a/content/engine/tutorials/_index.md +++ b/content/engine/tutorials/_index.md @@ -7,9 +7,9 @@ aliases: - /engine/userguide/containers/ --- -# Learn by example +Learn by example: * [Network containers](networkingcontainers.md) * [Manage data in containers](../../storage/volumes.md) * [Samples](../../samples/index.md) -* [Get Started](../../get-started/index.md) \ No newline at end of file +* [Get Started](../../get-started/index.md) diff --git a/content/faq/security/general.md b/content/faq/security/general.md index f7ee6ae8ce08..00720fdbe9bb 100644 --- a/content/faq/security/general.md +++ b/content/faq/security/general.md @@ -60,7 +60,7 @@ Docker Desktop utilizes the host operating system's secure key management for ha This is applicable only when using Docker Hub's application-level password versus SSO/SAML. When using SSO, Docker Hub doesn't store passwords. Application-level passwords are hashed in storage (SHA-256) and encrypted in transit (TLS). -### How do we de-provision access to CLI users who use personal access tokens instead of our IdP? We use SSO but not SCIM. +### How do we de-provision access to CLI users who use personal access tokens instead of our IdP? We use SSO but not SCIM If SCIM isn't enabled, you have to manually remove PAT users from the organization in our system. Using SCIM automates this. diff --git a/content/security/for-admins/scim.md b/content/security/for-admins/scim.md index 323e2ead5bed..0ffc7afe17a6 100644 --- a/content/security/for-admins/scim.md +++ b/content/security/for-admins/scim.md @@ -25,7 +25,7 @@ The following lists the supported provisioning features: The following table lists the supported attributes. Note that your attribute mappings must match for SSO to prevent duplicating your members. -| Attribute | Description +| Attribute | Description | |:---------------------------------------------------------------|:-------------------------------------------------------------------------------------------| | userName | User's primary email address. This is the unique identifier of the user. | | name.givenName | User’s first name | diff --git a/content/security/for-admins/single-sign-on/manage/_index.md b/content/security/for-admins/single-sign-on/manage/_index.md index a68dd9c4da83..a265f0641450 100644 --- a/content/security/for-admins/single-sign-on/manage/_index.md +++ b/content/security/for-admins/single-sign-on/manage/_index.md @@ -45,7 +45,7 @@ aliases: {{< /tab >}} {{< /tabs >}} - ## What's next? +## What's next? - [Set up SCIM](../../scim.md) - [Enable Group mapping](../../group-mapping.md) diff --git a/content/trusted-content/insights-analytics.md b/content/trusted-content/insights-analytics.md index 4e565e00bf21..3218830d8bbe 100644 --- a/content/trusted-content/insights-analytics.md +++ b/content/trusted-content/insights-analytics.md @@ -160,19 +160,19 @@ The following table describes the rules applied for determining intent behind pulls. To provide feedback or ask questions about these rules, [fill out the Google Form](https://forms.gle/nb7beTUQz9wzXy1b6). -| Starting event | Reference | Followed by | Resulting action | Use case(s) | Notes | -| :------------- | :-------- | :-------------------------------------------------------------- | :--------------- | :------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Starting event | Reference | Followed by | Resulting action | Use case(s) | Notes | +| :------------- | :-------- | :-------------------------------------------------------------- | :--------------- | :------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | HEAD | tag | N/A | Version check | User already has all layers existing on local machine | This is similar to the use case of a pull by tag when the user already has all the image layers existing locally, however, it differentiates the user intent and classifies accordingly. | -| GET | tag | N/A | Pull by tag | User already has all layers existing on local machine and/or the image is single-arch | -| GET | tag | Get by different digest | Pull by tag | Image is multi-arch | Second GET by digest must be different from the first. | -| HEAD | tag | GET by same digest | Pull by tag | Image is multi-arch but some or all image layers already exist on the local machine | The HEAD by tag sends the most current digest, the following GET must be by that same digest. There may occur an additional GET, if the image is multi-arch (see the next row in this table). If the user doesn't want the most recent digest, then the user performs HEAD by digest. | +| GET | tag | N/A | Pull by tag | User already has all layers existing on local machine and/or the image is single-arch | | +| GET | tag | Get by different digest | Pull by tag | Image is multi-arch | Second GET by digest must be different from the first. | +| HEAD | tag | GET by same digest | Pull by tag | Image is multi-arch but some or all image layers already exist on the local machine | The HEAD by tag sends the most current digest, the following GET must be by that same digest. There may occur an additional GET, if the image is multi-arch (see the next row in this table). If the user doesn't want the most recent digest, then the user performs HEAD by digest. | | HEAD | tag | GET by the same digest, then a second GET by a different digest | Pull by tag | Image is multi-arch | The HEAD by tag sends the most recent digest, the following GET must be by that same digest. Since the image is multi-arch, there is a second GET by a different digest. If the user doesn't want the most recent digest, then the user performs HEAD by digest. | | HEAD | tag | GET by same digest, then a second GET by different digest | Pull by tag | Image is multi-arch | The HEAD by tag sends the most current digest, the following GET must be by that same digest. Since the image is multi-arch, there is a second GET by a different digest. If the user doesn't want the most recent digest, then the user performs HEAD by digest. | -| GET | digest | N/A | Pull by digest | User already has all layers existing on local machine and/or the image is single-arch | -| HEAD | digest | N/A | Pull by digest | User already has all layers existing on their local machine | -| GET | digest | GET by different digest | Pull by digest | Image is multi-arch | The second GET by digest must be different from the first. | -| HEAD | digest | GET by same digest | Pull by digest | Image is single-arch and/or image is multi-arch but some part of the image already exists on the local machine | -| HEAD | digest | GET by same digest, then a second GET by different digest | Pull by Digest | Image is multi-arch | +| GET | digest | N/A | Pull by digest | User already has all layers existing on local machine and/or the image is single-arch | | +| HEAD | digest | N/A | Pull by digest | User already has all layers existing on their local machine | | +| GET | digest | GET by different digest | Pull by digest | Image is multi-arch | The second GET by digest must be different from the first. | +| HEAD | digest | GET by same digest | Pull by digest | Image is single-arch and/or image is multi-arch but some part of the image already exists on the local machine | | +| HEAD | digest | GET by same digest, then a second GET by different digest | Pull by Digest | Image is multi-arch | | ## Changes in data over time