Skip to content

Commit

Permalink
docs: fix assorted typos (#942)
Browse files Browse the repository at this point in the history
  • Loading branch information
samdark authored Jul 26, 2024
1 parent fb23c64 commit 93859e3
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/github-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/known-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/production.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 93859e3

Please sign in to comment.