From f47cec1a33ef16626f3a23f6c5c0a34e12e686e7 Mon Sep 17 00:00:00 2001 From: Arie Heinrich Date: Thu, 24 Oct 2024 17:29:44 +0200 Subject: [PATCH] Align grammar to official contribution guideline (#21233) Align grammar to official contribution guideline - https://docs.docker.com/contribute/style/grammar/ --- .../docker-concepts/running-containers/sharing-local-files.md | 2 +- content/guides/golang/build-images.md | 2 +- content/guides/golang/develop.md | 2 +- content/guides/localstack.md | 2 +- content/guides/pre-seeding.md | 2 +- content/manuals/desktop/dev-environments/create-dev-env.md | 2 +- content/manuals/desktop/previous-versions/2.x-windows.md | 2 +- .../manuals/desktop/previous-versions/edge-releases-mac.md | 4 ++-- content/manuals/desktop/troubleshoot/topics.md | 2 +- content/manuals/engine/security/trust/trust_automation.md | 2 +- .../manuals/extensions/extensions-sdk/architecture/_index.md | 2 +- .../extensions/extensions-sdk/design/mui-best-practices.md | 4 ++-- 12 files changed, 14 insertions(+), 14 deletions(-) diff --git a/content/get-started/docker-concepts/running-containers/sharing-local-files.md b/content/get-started/docker-concepts/running-containers/sharing-local-files.md index 93ead5d5bd..844a4cc415 100644 --- a/content/get-started/docker-concepts/running-containers/sharing-local-files.md +++ b/content/get-started/docker-concepts/running-containers/sharing-local-files.md @@ -59,7 +59,7 @@ $ docker run -v HOST-DIRECTORY:/CONTAINER-DIRECTORY:rw nginx Read-only bind mounts let the container access the mounted files on the host for reading, but it can't change or delete the files. With read-write bind mounts, containers can modify or delete mounted files, and these changes or deletions will also be reflected on the host system. Read-only bind mounts ensures that files on the host can't be accidentally modified or deleted by a container. -> **Synchronised File Share** +> **Synchronized File Share** > > As your codebase grows larger, traditional methods of file sharing like bind mounts may become inefficient or slow, especially in development environments where frequent access to files is necessary. [Synchronized file shares](/desktop/synchronized-file-sharing/) improve bind mount performance by leveraging synchronized filesystem caches. This optimization ensures that file access between the host and virtual machine (VM) is fast and efficient. diff --git a/content/guides/golang/build-images.md b/content/guides/golang/build-images.md index 012058d60f..68696baf2b 100644 --- a/content/guides/golang/build-images.md +++ b/content/guides/golang/build-images.md @@ -265,7 +265,7 @@ build context is the set of files located in the specified path or URL. The Docker build process can access any of the files located in the context. The build command optionally takes a `--tag` flag. This flag is used to label -the image with a string value, which is easy for humans to read and recognise. +the image with a string value, which is easy for humans to read and recognize. If you don't pass a `--tag`, Docker will use `latest` as the default value. Build your first Docker image. diff --git a/content/guides/golang/develop.md b/content/guides/golang/develop.md index fd8e1d629c..53497bc9af 100644 --- a/content/guides/golang/develop.md +++ b/content/guides/golang/develop.md @@ -222,7 +222,7 @@ func main() { db, err := initStore() if err != nil { - log.Fatalf("failed to initialise the store: %s", err) + log.Fatalf("failed to initialize the store: %s", err) } defer db.Close() diff --git a/content/guides/localstack.md b/content/guides/localstack.md index 4d0ef10d77..b1c43ee3f0 100644 --- a/content/guides/localstack.md +++ b/content/guides/localstack.md @@ -215,7 +215,7 @@ To start the frontend service, open a new terminal and follow these steps: ## Connecting to LocalStack from containerized Node app -Now that you have learnt how to connect a non-containerized Node.js application to LocalStack, it's time to explore the necessary changes to run the complete application stack in a containerised environment. To achieve this, you will create a Compose file specifying all required services - frontend, backend, database, and LocalStack. +Now that you have learnt how to connect a non-containerized Node.js application to LocalStack, it's time to explore the necessary changes to run the complete application stack in a containerized environment. To achieve this, you will create a Compose file specifying all required services - frontend, backend, database, and LocalStack. 1. Examine the Docker Compose file. diff --git a/content/guides/pre-seeding.md b/content/guides/pre-seeding.md index a707540f36..dd0252bade 100644 --- a/content/guides/pre-seeding.md +++ b/content/guides/pre-seeding.md @@ -152,7 +152,7 @@ Assuming that you have an existing Postgres database instance up and running, fo In Docker, mounting refers to making files or directories from the host system accessible within a container. This let you to share data or configuration files between the host and the container, enabling greater flexibility and persistence. -Now that you have learned how to launch Postgres and pre-seed the database using an SQL script, it’s time to learn how to mount an SQL file directly into the Postgres containers’ initialisation directory (`/docker-entrypoint-initdb.d`). The `/docker-entrypoint-initdb.d` is a special directory in PostgreSQL Docker containers that is used for initializing the database when the container is first started +Now that you have learned how to launch Postgres and pre-seed the database using an SQL script, it’s time to learn how to mount an SQL file directly into the Postgres containers’ initialization directory (`/docker-entrypoint-initdb.d`). The `/docker-entrypoint-initdb.d` is a special directory in PostgreSQL Docker containers that is used for initializing the database when the container is first started Make sure you stop any running Postgres containers (along with volumes) to prevent port conflicts before you follow the steps: diff --git a/content/manuals/desktop/dev-environments/create-dev-env.md b/content/manuals/desktop/dev-environments/create-dev-env.md index 074d4b403c..f1676b3229 100644 --- a/content/manuals/desktop/dev-environments/create-dev-env.md +++ b/content/manuals/desktop/dev-environments/create-dev-env.md @@ -48,7 +48,7 @@ If your WSL 2 distribution doesn't have an `ssh-agent` running, you can append t ```bash SSH_ENV="$HOME/.ssh/agent-environment" function start_agent { - echo "Initialising new SSH agent..." + echo "Initializing new SSH agent..." /usr/bin/ssh-agent | sed 's/^echo/#echo/' > "${SSH_ENV}" echo succeeded chmod 600 "${SSH_ENV}" diff --git a/content/manuals/desktop/previous-versions/2.x-windows.md b/content/manuals/desktop/previous-versions/2.x-windows.md index c567f52244..3db8701020 100644 --- a/content/manuals/desktop/previous-versions/2.x-windows.md +++ b/content/manuals/desktop/previous-versions/2.x-windows.md @@ -87,7 +87,7 @@ Docker Desktop 2.4.0.0 contains a Kubernetes upgrade. Your local Kubernetes clus - Copy container logs without ansi colors to clipboard. Fixes [docker/for-mac#4786](https://github.com/docker/for-mac/issues/4786). - Fix application startup if `hosts` is specified inside the Docker `daemon.json`. See [docker/for-win#6895](https://github.com/docker/for-win/issues/6895#issuecomment-637429117) - Fixed DNS resolution of short names. See [docker/for-win#4425](https://github.com/docker/for-win/issues/4425). -- Switched from `chronyd` to `sntpcd` to work around host time synchronisation problems. Fixes [docker/for-win#4526](https://github.com/docker/for-win/issues/4526). +- Switched from `chronyd` to `sntpcd` to work around host time synchronization problems. Fixes [docker/for-win#4526](https://github.com/docker/for-win/issues/4526). - Avoid blocking startup if "Expose daemon on tcp://localhost:2375 without TLS" is set and `localhost:2375` is in use by another program. See [docker/for-win#6929](https://github.com/docker/for-win/issues/6929) [docker/for-win#6961](https://github.com/docker/for-win/issues/6961). - Fixed an issue where adding a folder on a non-existing drive in the settings would create an empty entry. See [docker/for-win#6797](https://github.com/docker/for-win/issues/6797). - Avoid failing with "Function not implemented" during file I/O on shared volumes. Fixes [docker/for-win#5955](https://github.com/docker/for-win/issues/5955) diff --git a/content/manuals/desktop/previous-versions/edge-releases-mac.md b/content/manuals/desktop/previous-versions/edge-releases-mac.md index c1a50d545d..c02a414599 100644 --- a/content/manuals/desktop/previous-versions/edge-releases-mac.md +++ b/content/manuals/desktop/previous-versions/edge-releases-mac.md @@ -767,7 +767,7 @@ This release contains a Kubernetes upgrade. Note that your local Kubernetes clus - Allow orchestrator selection from the UI in the "Kubernetes" pane, to allow "docker stack" commands to deploy to Swarm clusters, even if Kubernetes is enabled in Docker for Mac. * Bug fixes and minor changes - - Use Simple NTP to minimise clock drift between the virtual machine and the host. Fixes [docker/for-mac#2076](https://github.com/docker/for-mac/issues/2076) + - Use Simple NTP to minimize clock drift between the virtual machine and the host. Fixes [docker/for-mac#2076](https://github.com/docker/for-mac/issues/2076) - Fix filesystem event notifications for Swarm services and those using the new-style --mount option. Fixes [docker/for-mac#2216](https://github.com/docker/for-mac/issues/2216), [docker/for-mac#2375](https://github.com/docker/for-mac/issues/2375) - Fix filesystem event delivery to Kubernetes pods when the path to the bind mount is a symlink. - Fix a race between calling stat on a file and calling close of a file descriptor referencing the file that could result in the stat failing with EBADF (often presented as "File not found"). Fixes [docker/for-mac#2870](https://github.com/docker/for-mac/issues/2870) @@ -824,7 +824,7 @@ This release contains a Kubernetes upgrade. Note that your local Kubernetes clus * Bug fixes and minor changes - Fix support for AUFS. Fixes [docker/for-win#1831](https://github.com/docker/for-win/issues/1831) - - Fix synchronisation between CLI `docker login` and GUI login. + - Fix synchronization between CLI `docker login` and GUI login. ### Docker Community Edition 18.03.0-ce-rc3-mac56 2018-03-13 diff --git a/content/manuals/desktop/troubleshoot/topics.md b/content/manuals/desktop/troubleshoot/topics.md index 40c611da64..3ec1c1b37d 100644 --- a/content/manuals/desktop/troubleshoot/topics.md +++ b/content/manuals/desktop/troubleshoot/topics.md @@ -296,7 +296,7 @@ Performance tab on the Task Manager. Alternatively, you can type 'systeminfo' in If you manually uninstall Hyper-V, WSL 2 or turn off virtualization, Docker Desktop cannot start. -To turn on nested virtualisation, see [Run Docker Desktop for Windows in a VM or VDI environment](../vm-vdi.md#turn-on-nested-virtualization). +To turn on nested virtualization, see [Run Docker Desktop for Windows in a VM or VDI environment](../vm-vdi.md#turn-on-nested-virtualization). #### Hypervisor enabled at Windows startup diff --git a/content/manuals/engine/security/trust/trust_automation.md b/content/manuals/engine/security/trust/trust_automation.md index 6a972f9fca..311840d8d1 100644 --- a/content/manuals/engine/security/trust/trust_automation.md +++ b/content/manuals/engine/security/trust/trust_automation.md @@ -41,7 +41,7 @@ $ export DOCKER_CONTENT_TRUST_ROOT_PASSPHRASE="rootpassphrase123" # Export the Repository Passphrase $ export DOCKER_CONTENT_TRUST_REPOSITORY_PASSPHRASE="repopassphrase123" -# Initialise Repo and Push Delegation +# Initialize Repo and Push Delegation $ docker trust signer add --key delegation.crt jeff registry.example.com/admin/demo Adding signer "jeff" to registry.example.com/admin/demo... Initializing signed repository for registry.example.com/admin/demo... diff --git a/content/manuals/extensions/extensions-sdk/architecture/_index.md b/content/manuals/extensions/extensions-sdk/architecture/_index.md index d3dde08030..9112351d06 100644 --- a/content/manuals/extensions/extensions-sdk/architecture/_index.md +++ b/content/manuals/extensions/extensions-sdk/architecture/_index.md @@ -14,7 +14,7 @@ Docker Extensions CLI. Extensions can be composed of three (optional) components: - A frontend (or User Interface): A web application displayed in a tab of the dashboard in Docker Desktop -- A backend: One or many containerised services running in the Docker Desktop VM +- A backend: One or many containerized services running in the Docker Desktop VM - Executables: Shell scripts or binaries that Docker Desktop copies on the host when installing the extension ![Overview of the three components of an extension](images/extensions-architecture.png?w=600h=400) diff --git a/content/manuals/extensions/extensions-sdk/design/mui-best-practices.md b/content/manuals/extensions/extensions-sdk/design/mui-best-practices.md index 0c406c638f..f0f44bb301 100644 --- a/content/manuals/extensions/extensions-sdk/design/mui-best-practices.md +++ b/content/manuals/extensions/extensions-sdk/design/mui-best-practices.md @@ -1,13 +1,13 @@ --- title: MUI best practices -description: Guidelines for using MUI to maximise compatibility with Docker Desktop +description: Guidelines for using MUI to maximize compatibility with Docker Desktop keywords: Docker, extensions, mui, theme, theming, material-ui, material aliases: - /desktop/extensions-sdk/design/mui-best-practices/ --- This article assumes you're following our recommended practice by using our [Material UI theme](https://www.npmjs.com/package/@docker/docker-mui-theme). -Following the steps below maximises compatibility with Docker Desktop and minimises the work you need to do as an +Following the steps below maximizes compatibility with Docker Desktop and minimizes the work you need to do as an extension author. They should be considered supplementary to the non-MUI-specific guidelines found in the [UI Styling overview](index.md).