Skip to content

Commit

Permalink
docs: use zero width non joiner for markdownlint
Browse files Browse the repository at this point in the history
  • Loading branch information
stasadev committed Feb 2, 2024
1 parent 35bae0c commit d4905ed
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 37 deletions.
30 changes: 15 additions & 15 deletions docs/content/developers/writing-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ If you’d like to reassure the reader something is easy, illustrate it with a d

| Write This 👍 | Not This ❌
| -- | --
| Change your project’s PHP version by either editing `.ddev/config.yaml` to set `php_version: "8.2"`, or by running `ddev config --php-version=8.2`, followed by running `ddev restart`. | It’s easy to change your project’s PHP version! Just edit your project’s `.ddev/config.yaml` to set `php_version: "8.2"`, or run `ddev config --php-version=8.2`, followed by running `ddev restart`. |
| Change your project’s PHP version by either editing `.ddev/config.yaml` to set `php_version: "8.2"`, or by running `ddev config --php-version=8.2`, followed by running `ddev restart`. | It’s easy to change your project’s PHP version! Just edit your project’s `.ddev/config.yaml` to set `php_version: "8.2"`, or run `ddev config --php-version=8.2`, followed by running `ddev restart`.

<!-- textlint-enable -->

Expand Down Expand Up @@ -83,10 +83,10 @@ We “run” commands. We don’t “do” them, and the command itself is not a

<!-- textlint-disable -->

| Write This 👍 | Not This ❌ |
| -- | -- |
| Run `ddev config` to set up your project. | Do `ddev config` to set up your project.<br>You can `ddev config` to set up your project. |
| If you get stuck, run `ddev restart`. | If you get stuck, just `ddev restart`. |
| Write This 👍 | Not This ❌
| -- | --
| Run `ddev config` to set up your project. | Do `ddev config` to set up your project.<br>You can `ddev config` to set up your project.
| If you get stuck, run `ddev restart`. | If you get stuck, just `ddev restart`.

<!-- textlint-enable -->

Expand All @@ -99,10 +99,10 @@ Write on behalf of the community and not yourself—use “we” and not “I”

<!-- textlint-disable -->

| Write This 👍 | Not This ❌ |
| -- | -- |
| We recommend Colima for the best performance. | It is recommended for performance that you use Colima. |
| Some prefer Redis for runtime caches. | I like using Redis for runtime caches. |
| Write This 👍 | Not This ❌
| -- | --
| We recommend Colima for the best performance. | It is recommended for performance that you use Colima.
| Some prefer Redis for runtime caches. | I like using Redis for runtime caches.

<!-- textlint-enable -->

Expand All @@ -119,9 +119,9 @@ It’s easy to get lost in documentation; don’t assume the reader is always fo

<!-- textlint-disable -->

| Write This 👍 | Not This ❌ |
| -- | -- |
| 1. In Docker Desktop, go to *Resources**Advanced* and set “Memory” to 6GB.<br>2. From your terminal, run `ddev restart`.<br>3. In your text editor, open `.ddev/config.yaml` and set `php_version: "8.1"`. | 1. Go to *Resources**Advanced* and set “Memory” to 6GB.<br>2. Run `ddev restart`.<br>3. Set `php_version: "8.1"`. |
| Write This 👍 | Not This ❌
| -- | --
| 1. In Docker Desktop, go to *Resources**Advanced* and set “Memory” to 6GB.<br>2. From your terminal, run `ddev restart`.<br>3. In your text editor, open `.ddev/config.yaml` and set `php_version: "8.1"`. | 1. Go to *Resources**Advanced* and set “Memory” to 6GB.<br>2. Run `ddev restart`.<br>3. Set `php_version: "8.1"`.
| Once you’ve [installed a Docker provider](../users/install/docker-installation.md), you’re ready to install DDEV! | Docker or an alternative is required before anything will work with DDEV. This is pretty easy on most environments; see the [Docker Installation](../users/install/docker-installation.md) page to help sort out the details.

<!-- textlint-enable -->
Expand All @@ -130,7 +130,7 @@ It’s easy to get lost in documentation; don’t assume the reader is always fo

The beginning of a page or section should introduce what the rest of the content is about. Try to avoid starting with asides or reminders that get in the way of this initial statement of purpose.

Never tell the reader to “remember” something they may not have been introduced to yet.
Never tell the reader to “remember” something they may not have been introduced to yet.

### Use Tips

Expand Down Expand Up @@ -251,8 +251,8 @@ One-off tips that don’t fit nicely into any of the sections above:
- Use sequential numbers for numbered lists in the source Markdown, regardless of how they’re eventually rendered.
- Try to maintain parallel format for list items.

| Write This 👍 | Not This ❌ |
| -- | -- |
| Write This 👍 | Not This ❌
| -- | --
| web server | webserver
| add-on | addon
| JSON, YAML, CSS | json, Yaml, css
Expand Down
42 changes: 21 additions & 21 deletions docs/content/users/configuration/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ An array of [extra fully-qualified domain names](../extend/additional-hostnames.

| Type | Default | Usage
| -- | -- | --
| :octicons-file-directory-16: project | `[]` |
| :octicons-file-directory-16: project | `[]` | &zwnj;

Example: `additional_fqdns: ["example.com", "sub1.example.com"]` would provide HTTP and HTTPS URLs for `example.com` and `sub1.example.com`.

Expand All @@ -60,7 +60,7 @@ An array of [extra hostnames](../extend/additional-hostnames.md) to be used for

| Type | Default | Usage
| -- | -- | --
| :octicons-file-directory-16: project | `[]` |
| :octicons-file-directory-16: project | `[]` | &zwnj;

Example: `additional_hostnames: ["somename", "someothername", "*.thirdname"]` would provide HTTP and HTTPS URLs for `somename.ddev.site`, `someothername.ddev.site`, and `one.thirdname.ddev.site` + `two.thirdname.ddev.site`.

Expand All @@ -79,8 +79,8 @@ When the network interfaces of a project should be exposed to the local network,
The relative path, from the project root, to the directory containing `composer.json`. (This is where all Composer-related commands are executed.)

| Type | Default | Usage
| -- | -- | --
| :octicons-file-directory-16: project | |
| -- |--------| --
| :octicons-file-directory-16: project | &zwnj; | &zwnj;

## `composer_version`

Expand All @@ -104,7 +104,7 @@ Extra Debian packages for the project’s database container.

| Type | Default | Usage
| -- | -- | --
| :octicons-file-directory-16: project | `[]` |
| :octicons-file-directory-16: project | `[]` | &zwnj;

Example: `dbimage_extra_packages: ["less"]` will add the `less` package when the database container is built.

Expand Down Expand Up @@ -186,15 +186,15 @@ DDEV-specific lifecycle [hooks](hooks.md) to be executed.

| Type | Default | Usage
| -- | -- | --
| :octicons-file-directory-16: project | `` |
| :octicons-file-directory-16: project | `` | &zwnj;

## `host_db_port`

Port for binding database server to localhost interface.

| Type | Default | Usage
| -- | -- | --
| :octicons-file-directory-16: project | automatic |
| :octicons-file-directory-16: project | automatic | &zwnj;

Not commonly used. Can be a specific port number for a fixed database port. If unset, the port will be assigned automatically and change each time [`ddev start`](../usage/commands.md#start) is run.

Expand All @@ -206,7 +206,7 @@ Specific, persistent HTTPS port for direct binding to localhost interface.

| Type | Default | Usage
| -- | -- | --
| :octicons-file-directory-16: project | automatic |
| :octicons-file-directory-16: project | automatic | &zwnj;

Not commonly used. Can be a specific port number for a fixed HTTPS URL. If unset, the port will be assigned automatically and change each time [`ddev start`](../usage/commands.md#start) is run.

Expand All @@ -218,7 +218,7 @@ Specific, persistent Mailpit port for direct binding to localhost interface.

| Type | Default | Usage
| -- | -- | --
| :octicons-file-directory-16: project | automatic |
| :octicons-file-directory-16: project | automatic | &zwnj;

Not commonly used. Can be a specific port number for a fixed Mailpit URL. If unset, the port will be assigned automatically and change each time [`ddev start`](../usage/commands.md#start) is run.

Expand All @@ -228,7 +228,7 @@ Specific, persistent HTTP port for direct binding to localhost interface.

| Type | Default | Usage
| -- | -- | --
| :octicons-file-directory-16: project | automatic |
| :octicons-file-directory-16: project | automatic | &zwnj;

Not commonly used. Can be a specific port number for a fixed HTTP URL. If unset, the port will be assigned automatically and change each time [`ddev start`](../usage/commands.md#start) is run.

Expand Down Expand Up @@ -276,7 +276,7 @@ Email associated with Let’s Encrypt feature. (Works in conjunction with [`use_

| Type | Default | Usage
| -- | -- | --
| :octicons-globe-16: global | `` |
| :octicons-globe-16: global | `` | &zwnj;

Set with `ddev config global --letsencrypt-email=me@example.com`. Used with the [casual hosting](../topics/hosting.md) feature.

Expand Down Expand Up @@ -332,7 +332,7 @@ Extra flags for [configuring ngrok](https://ngrok.com/docs/ngrok-agent/config) w

| Type | Default | Usage
| -- | -- | --
| :octicons-file-directory-16: project | `` |
| :octicons-file-directory-16: project | `` | &zwnj;

Example: `--basic-auth username:pass1234 --domain foo.ngrok-free.app`.

Expand Down Expand Up @@ -410,7 +410,7 @@ This is typically a global setting. The project-specific value will override glo
The PHP version the project should use.

| Type | Default | Usage
| -- |---------| --
| -- | -- | --
| :octicons-file-directory-16: project | `8.1` | Can be `5.6`, `7.0`, `7.1`, `7.2`, `7.3`, `7.4`, `8.0`, `8.1`, `8.2`, or `8.3`.

You can only specify the major version (`7.3`), not a minor version (`7.3.2`), from those explicitly available.
Expand All @@ -428,8 +428,8 @@ Default TLD to be used for a project’s domains, or globally for all project do
Specific docker-compose version for download.

| Type | Default | Usage
| -- | -- | --
| :octicons-globe-16: global | |
| -- |--------| --
| :octicons-globe-16: global | &zwnj; | &zwnj;

If set to `v2.8.0`, for example, it will download and use that version instead of the expected version for docker-compose.

Expand Down Expand Up @@ -509,7 +509,7 @@ Timezone for container and PHP configuration.
Specify an alternate port for the Traefik (ddev-router) monitor port. This defaults to 10999 and rarely needs to be changed, but can be changed in cases of port conflicts.

| Type | Default | Usage
| -- |---------| --
| -- | -- | --
| :octicons-globe-16: global | `10999` | Can be any unused port below 65535.

## `type`
Expand Down Expand Up @@ -581,23 +581,23 @@ Additional [custom environment variables](../extend/customization-extendibility.

| Type | Default | Usage
| -- | -- | --
| :octicons-file-directory-16: project<br>:octicons-globe-16: global | `[]` |
| :octicons-file-directory-16: project<br>:octicons-globe-16: global | `[]` | &zwnj;

## `web_extra_daemons`

Additional daemons that should [automatically be started in the web container](../extend/customization-extendibility.md#running-extra-daemons-in-the-web-container).

| Type | Default | Usage
| -- | -- | --
| :octicons-file-directory-16: project | `[]` |
| :octicons-file-directory-16: project | `[]` | &zwnj;

## `web_extra_exposed_ports`

Additional named sets of ports to [expose via `ddev-router`](../extend/customization-extendibility.md#exposing-extra-ports-via-ddev-router).

| Type | Default | Usage
| -- | -- | --
| :octicons-file-directory-16: project | `[]` |
| :octicons-file-directory-16: project | `[]` | &zwnj;

## `webimage`

Expand All @@ -616,7 +616,7 @@ Extra Debian packages for the project’s web container.

| Type | Default | Usage
| -- | -- | --
| :octicons-file-directory-16: project | `[]` |
| :octicons-file-directory-16: project | `[]` | &zwnj;

Example: `webimage_extra_packages: [php-yaml, php-bcmath]` will add the `php-yaml` and `php-bcmath` packages when the web container is built.

Expand All @@ -642,7 +642,7 @@ Working directories used by [`ddev exec`](../usage/commands.md#exec) and [`ddev

| Type | Default | Usage
| -- | -- | --
| :octicons-file-directory-16: project | |
| :octicons-file-directory-16: project | &zwnj; | &zwnj;

Example: `working_dir: { web: "/var/www", db: "/etc" }` sets the working directories for the `web` and `db` containers.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/users/usage/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ If you get a 404 with “No input file specified” (nginx) or a 403 with “For
If `ddev start` fails, it’s most often because the `web` or `db` container fails to start. In this case, the error message from `ddev start` says something like “Failed to start <project>: db container failed: log=, err=container exited, please use 'ddev logs -s db' to find out why it failed”. You can`ddev logs -s db` to find out what happened.
If you see any variant of “no space left on device” in the logs when using Docker Desktop, it means you have to increase or clean up Docker’s file space. Increase the “Disk image size” setting under “Resources” in Docker’s Preferences:
If you see any variant of “no space left on device” in the logs when using Docker Desktop, it means you have to increase or clean up Docker’s file space. Increase the “Disk image size” setting under “Resources” in Docker’s Preferences:
![Docker disk space](../../images/docker-disk-image-size.png)
Expand Down

0 comments on commit d4905ed

Please sign in to comment.