Browse Source

docs: fix assorted typos (#942)

Alexander Makarov 7 months ago
parent
commit
93859e3149
5 changed files with 10 additions and 10 deletions
  1. 2 2
      docs/docker.md
  2. 2 2
      docs/github-actions.md
  3. 4 4
      docs/known-issues.md
  4. 1 1
      docs/production.md
  5. 1 1
      docs/worker.md

+ 2 - 2
docs/docker.md

@@ -4,7 +4,7 @@
 
 Variants for PHP 8.2 and PHP 8.3 are provided.
 
-The tags follows this pattern: `dunglas/frankenphp:<frankenphp-version>-php<php-version>-<os>`
+The tags follow this pattern: `dunglas/frankenphp:<frankenphp-version>-php<php-version>-<os>`
 
 * `<frankenphp-version>` and `<php-version>` are version numbers of FrankenPHP and PHP respectively, with specifities ranging from major (e.g. `1`), minor (e.g. `1.2`) to patch versions (e.g. `1.2.3`).
 * `<os>` is either `bookworm` (for Debian Bookworm) or `alpine` (for the latest stable version of Alpine).
@@ -182,7 +182,7 @@ RUN \
 USER ${USER}
 ```
 
-Next, set the `SERVER_NAME` environment variable to use an unpriviliegied port.
+Next, set the `SERVER_NAME` environment variable to use an unprivileged port.
 Example: `:8000`
 
 ## Updates

+ 2 - 2
docs/github-actions.md

@@ -8,8 +8,8 @@ every approved pull request or on your own fork once setup.
 In the repository settings, under secrets, add the following secrets:
 
 - `REGISTRY_LOGIN_SERVER`: The docker registry to use (e.g. `docker.io`).
-- `REGISTRY_USERNAME`: The username to use to login to the registry (e.g. `dunglas`).
-- `REGISTRY_PASSWORD`: The password to use to login to the registry (e.g. an access key).
+- `REGISTRY_USERNAME`: The username to use to log in to the registry (e.g. `dunglas`).
+- `REGISTRY_PASSWORD`: The password to use to log in to the registry (e.g. an access key).
 - `IMAGE_NAME`: The name of the image (e.g. `dunglas/frankenphp`).
 
 ## Building and Pushing the Image

+ 4 - 4
docs/known-issues.md

@@ -34,10 +34,10 @@ $fiber->resume();
 
 The following extensions are known not to be compatible with FrankenPHP:
 
-| Name                                                                                                       | Reason          | Alternatives                                                                                                         |
-| ---------------------------------------------------------------------------------------------------------- | --------------- | -------------------------------------------------------------------------------------------------------------------- |
-| [imap](https://www.php.net/manual/en/imap.installation.php)                                                | Not thread-safe | [javanile/php-imap2](https://github.com/javanile/php-imap2), [webklex/php-imap](https://github.com/Webklex/php-imap) |
-| [newrelic](https://docs.newrelic.com/docs/apm/agents/php-agent/getting-started/introduction-new-relic-php/)| Not thread-safe | -                                                                                                                    |
+| Name                                                                                                        | Reason          | Alternatives                                                                                                         |
+|-------------------------------------------------------------------------------------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------|
+| [imap](https://www.php.net/manual/en/imap.installation.php)                                                 | Not thread-safe | [javanile/php-imap2](https://github.com/javanile/php-imap2), [webklex/php-imap](https://github.com/Webklex/php-imap) |
+| [newrelic](https://docs.newrelic.com/docs/apm/agents/php-agent/getting-started/introduction-new-relic-php/) | Not thread-safe | -                                                                                                                    |
 
 ## Buggy PHP Extensions
 

+ 1 - 1
docs/production.md

@@ -127,7 +127,7 @@ Go into the directory containing your project (`<project-name>`), and start the
 docker compose up -d --wait
 ```
 
-Your server is up and running, and a HTTPS certificate has been automatically generated for you.
+Your server is up and running, and an HTTPS certificate has been automatically generated for you.
 Go to `https://your-domain-name.example.com` and enjoy!
 
 > [!CAUTION]

+ 1 - 1
docs/worker.md

@@ -124,7 +124,7 @@ The previous worker snippet allows configuring a maximum number of request to ha
 ## Superglobals Behavior
 
 [PHP superglobals](https://www.php.net/manual/en/language.variables.superglobals.php) (`$_SERVER`, `$_ENV`, `$_GET`...)
-behave as follow:
+behave as follows:
 
 * before the first call to `frankenphp_handle_request()`, superglobals contain values bound to the worker script itself
 * during and after the call to `frankenphp_handle_request()`, superglobals contain values generated from the processed HTTP request, each call to `frankenphp_handle_request()` changes the superglobals values