From ae3eec2c7060ea18f47a820b9800a0c78e2ef50f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ville=20Skytt=C3=A4?= Date: Fri, 28 Feb 2025 21:13:37 -0100 Subject: [PATCH] docs: grammar and spelling fixes (#22136) ## Description Fix a few grammar and spelling errors. ## Reviews - [ ] Technical review - [ ] Editorial review - [ ] Product review --- content/guides/genai-leveraging-rag/index.md | 2 +- content/guides/python/deploy.md | 2 +- content/guides/ruby/develop.md | 2 +- content/manuals/desktop/features/dev-environments/set-up.md | 2 +- content/manuals/desktop/use-desktop/volumes.md | 2 +- content/manuals/engine/logging/drivers/gelf.md | 2 +- content/manuals/engine/release-notes/28.md | 2 +- content/manuals/engine/security/rootless.md | 2 +- content/manuals/engine/security/trust/trust_delegation.md | 2 +- content/manuals/engine/storage/drivers/overlayfs-driver.md | 2 +- content/reference/compose-file/merge.md | 2 +- data/samples.yaml | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/content/guides/genai-leveraging-rag/index.md b/content/guides/genai-leveraging-rag/index.md index cb23aea024..e77c1b3b71 100644 --- a/content/guides/genai-leveraging-rag/index.md +++ b/content/guides/genai-leveraging-rag/index.md @@ -38,7 +38,7 @@ The system operates as follows: 3. The found information gets added to the original question before passed to LLM 4. The LLM generates responses that blend the model's inherent knowledge with the this extra information. -To hold this vector information in a efficient manner, we need a special type of database. +To hold this vector information in an efficient manner, we need a special type of database. ## Introduction to Graph databases diff --git a/content/guides/python/deploy.md b/content/guides/python/deploy.md index e77e045135..81f04dba2e 100644 --- a/content/guides/python/deploy.md +++ b/content/guides/python/deploy.md @@ -161,7 +161,7 @@ In these Kubernetes YAML file, there are various objects, separated by the `---` your Python application](configure-ci-cd.md). - A Service, which will define how the ports are mapped in the containers. - A PersistentVolumeClaim, to define a storage that will be persistent through restarts for the database. -- A Secret, Keeping the database password as a example using secret kubernetes resource. +- A Secret, Keeping the database password as an example using secret kubernetes resource. - A NodePort service, which will route traffic from port 30001 on your host to port 8001 inside the pods it routes to, allowing you to reach your app from the network. diff --git a/content/guides/ruby/develop.md b/content/guides/ruby/develop.md index 96aabf8443..4e67a9e4c0 100644 --- a/content/guides/ruby/develop.md +++ b/content/guides/ruby/develop.md @@ -176,7 +176,7 @@ $ docker compose watch Any changes to the application's source files on your local machine will now be immediately reflected in the running container. -Open `docker-ruby-on-rails/app/views/whales/index.html.erb` in an IDE or text editor and update the `Whales` string by adding a exclamation marks. +Open `docker-ruby-on-rails/app/views/whales/index.html.erb` in an IDE or text editor and update the `Whales` string by adding an exclamation mark. ```diff -

Whales

diff --git a/content/manuals/desktop/features/dev-environments/set-up.md b/content/manuals/desktop/features/dev-environments/set-up.md index 18423bcae3..8239abb934 100644 --- a/content/manuals/desktop/features/dev-environments/set-up.md +++ b/content/manuals/desktop/features/dev-environments/set-up.md @@ -18,7 +18,7 @@ aliases: To set up a dev environment, there are additional configuration steps to tell Docker Desktop how to build, start, and use the right image for your services. -Dev Environments use an `compose-dev.yaml` file located at the root of your project. This file allows you to define the image required for a dedicated service, the ports you'd like to expose, along with additional configuration options. +Dev Environments use a `compose-dev.yaml` file located at the root of your project. This file allows you to define the image required for a dedicated service, the ports you'd like to expose, along with additional configuration options. The following is an example `compose-dev.yaml` file. diff --git a/content/manuals/desktop/use-desktop/volumes.md b/content/manuals/desktop/use-desktop/volumes.md index b065d83a5e..7c504802d6 100644 --- a/content/manuals/desktop/use-desktop/volumes.md +++ b/content/manuals/desktop/use-desktop/volumes.md @@ -119,7 +119,7 @@ To empty a volume: ## Export a volume -You can export the content of a volume to a local file, a local image, an to an +You can export the content of a volume to a local file, a local image, and to an image in Docker Hub, or to a supported cloud provider. When exporting content from a volume used by one or more running containers, the containers are temporarily stopped while Docker exports the content, and then restarted when diff --git a/content/manuals/engine/logging/drivers/gelf.md b/content/manuals/engine/logging/drivers/gelf.md index 7676fe4f18..5416bdc946 100644 --- a/content/manuals/engine/logging/drivers/gelf.md +++ b/content/manuals/engine/logging/drivers/gelf.md @@ -66,7 +66,7 @@ The `gelf` logging driver supports the following options: | `gelf-address` | required | The address of the GELF server. `tcp` and `udp` are the only supported URI specifier and you must specify the port. | `--log-opt gelf-address=udp://192.168.0.42:12201` | | `gelf-compression-type` | optional | `UDP Only` The type of compression the GELF driver uses to compress each log message. Allowed values are `gzip`, `zlib` and `none`. The default is `gzip`. Note that enabled compression leads to excessive CPU usage, so it's highly recommended to set this to `none`. | `--log-opt gelf-compression-type=gzip` | | `gelf-compression-level` | optional | `UDP Only` The level of compression when `gzip` or `zlib` is the `gelf-compression-type`. An integer in the range of `-1` to `9` (BestCompression). Default value is 1 (BestSpeed). Higher levels provide more compression at lower speed. Either `-1` or `0` disables compression. | `--log-opt gelf-compression-level=2` | -| `gelf-tcp-max-reconnect` | optional | `TCP Only` The maximum number of reconnection attempts when the connection drop. An positive integer. Default value is 3. | `--log-opt gelf-tcp-max-reconnect=3` | +| `gelf-tcp-max-reconnect` | optional | `TCP Only` The maximum number of reconnection attempts when the connection drop. A positive integer. Default value is 3. | `--log-opt gelf-tcp-max-reconnect=3` | | `gelf-tcp-reconnect-delay` | optional | `TCP Only` The number of seconds to wait between reconnection attempts. A positive integer. Default value is 1. | `--log-opt gelf-tcp-reconnect-delay=1` | | `tag` | optional | A string that's appended to the `APP-NAME` in the `gelf` message. By default, Docker uses the first 12 characters of the container ID to tag log messages. Refer to the [log tag option documentation](log_tags.md) for customizing the log tag format. | `--log-opt tag=mailer` | | `labels` | optional | Applies when starting the Docker daemon. A comma-separated list of logging-related labels this daemon accepts. Adds additional key on the `extra` fields, prefixed by an underscore (`_`). Used for advanced [log tag options](log_tags.md). | `--log-opt labels=production_status,geo` | diff --git a/content/manuals/engine/release-notes/28.md b/content/manuals/engine/release-notes/28.md index bcd3db7d9d..784d1cbb88 100644 --- a/content/manuals/engine/release-notes/28.md +++ b/content/manuals/engine/release-notes/28.md @@ -317,6 +317,6 @@ For a full list of pull requests and changes in this release, refer to the relev - `api/types/system/Commit.Expected` field is deprecated and should no longer be used. [moby/moby#48478](https://github.com/moby/moby/pull/48478) - `daemon/graphdriver`: Deprecate `GetDriver()` [moby/moby#48079](https://github.com/moby/moby/pull/48079) - `libnetwork/iptables`: Deprecate `Passthrough`. This function was only used internally, and will be removed in the next release. [moby/moby#49115](https://github.com/moby/moby/pull/49115) -- `pkg/directory.Size()` function is deprecated, an will be removed in the next release. [moby/moby#48057](https://github.com/moby/moby/pull/48057) +- `pkg/directory.Size()` function is deprecated, and will be removed in the next release. [moby/moby#48057](https://github.com/moby/moby/pull/48057) - `registry`: Deprecate `APIEndpoint.TrimHostName`; hostname is now trimmed unconditionally for remote names. This field will be removed in the next release. [moby/moby#49005](https://github.com/moby/moby/pull/49005) - `allow-nondistributable-artifacts` field in `daemon.json`. Setting either option will no longer take effect, but a deprecation warning log is added to raise awareness about the deprecation. This warning is planned to become an error in the next release. [moby/moby#49065](https://github.com/moby/moby/pull/49065) diff --git a/content/manuals/engine/security/rootless.md b/content/manuals/engine/security/rootless.md index 6f42a9296b..f267d59f4c 100644 --- a/content/manuals/engine/security/rootless.md +++ b/content/manuals/engine/security/rootless.md @@ -490,7 +490,7 @@ The value is automatically set to `/run/user/$UID` and cleaned up on every logou **`systemctl --user` fails with "Failed to connect to bus: No such file or directory"** -This error occurs mostly when you switch from the root user to an non-root user with `sudo`: +This error occurs mostly when you switch from the root user to a non-root user with `sudo`: ```console # sudo -iu testuser diff --git a/content/manuals/engine/security/trust/trust_delegation.md b/content/manuals/engine/security/trust/trust_delegation.md index 1c0d250120..df4b8d933a 100644 --- a/content/manuals/engine/security/trust/trust_delegation.md +++ b/content/manuals/engine/security/trust/trust_delegation.md @@ -122,7 +122,7 @@ Successfully generated and loaded private key. Corresponding public key availabl ### Manually generating keys -If you need to manually generate a private key (either RSA or ECDSA) and a x509 +If you need to manually generate a private key (either RSA or ECDSA) and an X.509 certificate containing the public key, you can use local tools like openssl or cfssl along with a local or company-wide Certificate Authority. diff --git a/content/manuals/engine/storage/drivers/overlayfs-driver.md b/content/manuals/engine/storage/drivers/overlayfs-driver.md index 2d28af9308..5064fb0c32 100644 --- a/content/manuals/engine/storage/drivers/overlayfs-driver.md +++ b/content/manuals/engine/storage/drivers/overlayfs-driver.md @@ -104,7 +104,7 @@ its compatibility with different backing filesystems. OverlayFS layers two directories on a single Linux host and presents them as a single directory. These directories are called layers, and the unification process is referred to as a union mount. OverlayFS refers to the lower directory -as `lowerdir` and the upper directory a `upperdir`. The unified view is exposed +as `lowerdir` and the upper directory as `upperdir`. The unified view is exposed through its own directory called `merged`. The `overlay2` driver natively supports up to 128 lower OverlayFS layers. This diff --git a/content/reference/compose-file/merge.md b/content/reference/compose-file/merge.md index ccd0390b00..2c50ce4359 100644 --- a/content/reference/compose-file/merge.md +++ b/content/reference/compose-file/merge.md @@ -161,7 +161,7 @@ services: FOO: BAR ``` -And an `compose.override.yaml` file: +And a `compose.override.yaml` file: ```yaml services: diff --git a/data/samples.yaml b/data/samples.yaml index a2e6b7db67..deae29f0a7 100644 --- a/data/samples.yaml +++ b/data/samples.yaml @@ -37,7 +37,7 @@ samples: - mysql - title: NGINX / ASP.NET / MySQL url: https://github.com/docker/awesome-compose/tree/master/nginx-aspnet-mysql - description: A sample Nginx reverse proxy with an C# backend using ASP.NET. + description: A sample Nginx reverse proxy with a C# backend using ASP.NET. services: - nginx - .net