Skip to content

Commit ae53957

Browse files
authored
[docs] Rescue intentional line breaks (ddev#4763) [skip ci]
1 parent 3fa2810 commit ae53957

11 files changed

+59
-60
lines changed

.editorconfig

-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ indent_style = space
1212
# embedded yaml in markdown.
1313
# indent_size = 4
1414
insert_final_newline = true
15-
trim_trailing_whitespace = true
1615

1716
# GO files
1817
[*.go]

docs/content/developers/writing-style-guide.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Writing Style Guide
22

3-
This page formalizes the writing conventions we aspire to use in the documentation.
3+
This page formalizes the writing conventions we aspire to use in the documentation.
44
It’s a living statement of intent and a reference for all contributors.
55

66
## Voice and Tone
@@ -68,7 +68,7 @@ We “run” commands. We don’t “do” them, and the command itself is not a
6868

6969
### Use Active Third Person
7070

71-
Avoid impersonal language featuring unknown individuals or shadowy organizations.
71+
Avoid impersonal language featuring unknown individuals or shadowy organizations.
7272
“It is recommended,” for example, could be a warmer “we recommend” or “Laravel users recommend”.
7373

7474
Write on behalf of the community and not yourself—use “we” and not “I”.
@@ -149,7 +149,7 @@ DDEV is a product and `ddev` is a binary or console command. DDEV should always
149149

150150
#### Products, Organizations, and Protocols
151151

152-
When in doubt, honor whatever name a product or organization uses in its official materials.
152+
When in doubt, honor whatever name a product or organization uses in its official materials.
153153
Use backticks to differentiate between a product and command, just like DDEV vs. `ddev`.
154154

155155
| Write This 👍 | Not This ❌

docs/content/users/debugging-profiling/step-debugging.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ All IDEs basically work the same, listening on a port and reacting when they’r
1111

1212
**Key facts:**
1313

14-
* Enable Xdebug by running [`ddev xdebug`](../usage/commands.md#xdebug) or `ddev xdebug on` from your project directory.
14+
* Enable Xdebug by running [`ddev xdebug`](../usage/commands.md#xdebug) or `ddev xdebug on` from your project directory.
1515
It will remain enabled until you start or restart the project.
1616
* Disable Xdebug for better performance when not debugging with `ddev xdebug off`.
1717
* `ddev xdebug status` will show Xdebug’s current status.
@@ -57,7 +57,7 @@ When using this zero-configuration option:
5757
PhpStorm [run/debug configurations](https://www.jetbrains.com/help/phpstorm/creating-and-editing-run-debug-configurations.html) require more setup but may be easier and more flexible for some people.
5858

5959
1. Under the *Run* menu select *Edit configurations*.
60-
2. Click the *+* in the upper left and choose *PHP Web Application* to create a configuration.
60+
2. Click the *+* in the upper left and choose *PHP Web Application* to create a configuration.
6161
Give it a reasonable name.
6262
3. Create a “server” for the project. Make sure *Name* is exactly the same as your host (e.g. `my-site.ddev.site`):
6363
![PhpStorm server creation](../../images/phpstorm-config-server-config.png)

docs/content/users/install/ddev-installation.md

+23-24
Original file line numberDiff line numberDiff line change
@@ -115,16 +115,16 @@ Installing and upgrading DDEV are nearly the same thing, because you're upgradin
115115

116116
### Important Considerations for WSL2 and DDEV
117117

118-
* WSL2 is supported on Windows 10 and 11.
119-
All Windows 10/11 editions, including Windows 10 Home support WSL2.
120-
* WSL2 offers a faster, smoother experience.
121-
It’s vastly more performant, and you’re less likely to have obscure Windows problems.
122-
* Projects should live in the Linux filesystem.
123-
WSL2’s Linux filesystem (e.g. `/home/<your_username>`) is much faster, so keep your projects there and **not** in the slower Windows filesystem (`/mnt/c`).
124-
* Custom hostnames are managed via the Windows hosts file, not within WSL2.
125-
DDEV attempts to manage custom hostnames via the Windows-side hosts file—usually at `C:\Windows\system32\drivers\etc\hosts`—and it can only do this if it’s installed on the Windows side. (DDEV inside WSL2 uses `ddev.exe` on the Windows side as a proxy to update the Windows hosts file.) If `ddev.exe --version` shows the same version as `ddev --version` you’re all set up. Otherwise, install DDEV on Windows using `choco upgrade -y ddev` or by downloading and running the Windows installer. (The WSL2 scripts below install DDEV on the Windows side, taking care of that for you.) If you frequently run into Windows UAC Escalation, you can calm it down by running `gsudo.exe cache on` and `gsudo.exe config CacheMode auto`, see [gsudo docs](https://github.com/gerardog/gsudo#credentials-cache).
126-
* WSL2 is not the same as Docker Desktop’s WSL2 engine.
127-
Using WSL2 to install and run DDEV is not the same as using Docker Desktop’s WSL2 engine, which itself runs in WSL2, but can serve applications running in both traditional Windows and inside WSL2.
118+
* WSL2 is supported on Windows 10 and 11.
119+
All Windows 10/11 editions, including Windows 10 Home support WSL2.
120+
* WSL2 offers a faster, smoother experience.
121+
It’s vastly more performant, and you’re less likely to have obscure Windows problems.
122+
* Projects should live in the Linux filesystem.
123+
WSL2’s Linux filesystem (e.g. `/home/<your_username>`) is much faster, so keep your projects there and **not** in the slower Windows filesystem (`/mnt/c`).
124+
* Custom hostnames are managed via the Windows hosts file, not within WSL2.
125+
DDEV attempts to manage custom hostnames via the Windows-side hosts file—usually at `C:\Windows\system32\drivers\etc\hosts`—and it can only do this if it’s installed on the Windows side. (DDEV inside WSL2 uses `ddev.exe` on the Windows side as a proxy to update the Windows hosts file.) If `ddev.exe --version` shows the same version as `ddev --version` you’re all set up. Otherwise, install DDEV on Windows using `choco upgrade -y ddev` or by downloading and running the Windows installer. (The WSL2 scripts below install DDEV on the Windows side, taking care of that for you.) If you frequently run into Windows UAC Escalation, you can calm it down by running `gsudo.exe cache on` and `gsudo.exe config CacheMode auto`, see [gsudo docs](https://github.com/gerardog/gsudo#credentials-cache).
126+
* WSL2 is not the same as Docker Desktop’s WSL2 engine.
127+
Using WSL2 to install and run DDEV is not the same as using Docker Desktop’s WSL2 engine, which itself runs in WSL2, but can serve applications running in both traditional Windows and inside WSL2.
128128

129129
The WSL2 install process involves:
130130

@@ -307,31 +307,30 @@ Installing and upgrading DDEV are nearly the same thing, because you're upgradin
307307

308308
```json
309309
{
310-
"image": "mcr.microsoft.com/devcontainers/universal:2",
311-
"features": {
312-
"ghcr.io/devcontainers/features/docker-in-docker:1": {},
313-
"ghcr.io/ddev/ddev/install-ddev:latest": {}
314-
},
315-
"portsAttributes": {
310+
"image": "mcr.microsoft.com/devcontainers/universal:2",
311+
"features": {
312+
"ghcr.io/devcontainers/features/docker-in-docker:1": {},
313+
"ghcr.io/ddev/ddev/install-ddev:latest": {}
314+
},
315+
"portsAttributes": {
316316
"3306": {
317-
"label": "database"
317+
"label": "database"
318318
},
319319
"8027": {
320-
"label": "mailhog"
320+
"label": "mailhog"
321321
},
322322
"8036": {
323-
"label": "phpmyadmin"
323+
"label": "phpmyadmin"
324324
},
325325
"8080": {
326-
"label": "web http"
326+
"label": "web http"
327327
},
328328
"8443": {
329-
"label": "web https"
329+
"label": "web https"
330330
}
331-
},
332-
"postCreateCommand": "bash -c 'ddev config global --omit-containers=ddev-router && ddev config --auto && ddev debug download-images'"
331+
},
332+
"postCreateCommand": "bash -c 'ddev config global --omit-containers=ddev-router && ddev config --auto && ddev debug download-images'"
333333
}
334-
335334
```
336335

337336
!!!note "Normal Linux installation also works"

docs/content/users/install/shell-completion.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Shells like bash and zsh need help to do this though, they have to know what the
3636
curl -sSLf https://github.com/ddev/ddev/releases/download/${VERSION}/ddev_shell_completion_scripts.${VERSION}.tar.gz
3737
tar -zxf ddev_shell_completion_scripts.${VERSION}.tar.gz
3838
```
39-
2. Then `sudo mkdir -p /usr/share/bash-completion/completions && sudo cp ddev_bash_completion.sh /usr/share/bash-completion/completions/ddev`. This deploys the `ddev_bash_completion.sh` script where it needs to be. Again, every Linux distro has a different technique, and you may have to figure yours out.
39+
2. Run `sudo mkdir -p /usr/share/bash-completion/completions && sudo cp ddev_bash_completion.sh /usr/share/bash-completion/completions/ddev`. This deploys the `ddev_bash_completion.sh` script where it needs to be. Again, every Linux distro has a different technique, and you may have to figure yours out.
4040

4141
If you installed DDEV using `apt install` then the `ddev_bash_completion.sh` file is already available in `/usr/bin/ddev_bash_completion.sh`. Starting with DDEV v1.21.2 this will be automatically installed into `/usr/share/bash-completion/completions`.
4242

docs/content/users/topics/hosting.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This may be appropriate for small or abandoned sites that have special requireme
1212
Here’s how to try it for yourself:
1313

1414
1. Install DDEV on an internet-connected Linux server. (You’re responsible for your firewall and maintenance of the server!)
15-
2. On Debian/Ubuntu, you can set up a simple firewall with
15+
2. On Debian/Ubuntu, you can set up a simple firewall with
1616
`ufw allow 80 && ufw allow 443 && ufw allow 22 && ufw enable`.
1717
3. Point DNS for the site you’re going to host to the server.
1818
4. Before proceeding, your system and your project must be accessible on the internet on port 80 and your project DNS name (`myproject.example.com`) must resolve to the appropriate server.
@@ -29,7 +29,7 @@ Here’s how to try it for yourself:
2929
3030
```
3131
if ($http_x_forwarded_proto = "http") {
32-
return 301 https://$host$request_uri;
32+
return 301 https://$host$request_uri;
3333
}
3434
```
3535

docs/content/users/usage/architecture.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# How DDEV Works
22

3-
DDEV is a [Go](https://go.dev) application that stores its configuration in [files on your workstation](#directory-tour).
3+
DDEV is a [Go](https://go.dev) application that stores its configuration in [files on your workstation](#directory-tour).
44
It uses those blueprints to mount your project files into [Docker containers](#container-architecture) that facilitate the operation of a local development environment.
55

66
DDEV writes and uses [docker-compose](https://docs.docker.com/compose/) files for you, which is a detail you can cheerfully ignore unless you’re Docker-curious or [defining your own services](../extend/custom-compose-files.md).
@@ -16,7 +16,7 @@ The [global configuration directory](#global-files) is used to keep track of you
1616
A project’s `.ddev` directory can be intimidating at first, so let’s take a look at what lives in there.
1717

1818
!!!tip "Yours May Differ Slightly"
19-
You may have some directories or files that aren’t listed here, likely added by custom services.
19+
You may have some directories or files that aren’t listed here, likely added by custom services.
2020
For example, if you see a `solr` directory, it probably pertains to a custom Solr [add-on service](../extend/additional-services.md).
2121

2222
`apache` directory

docs/content/users/usage/cms-settings.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@ While this reduces setup time for new users, makes it easier to try out a CMS, a
1414

1515
There are several ways to back off DDEV’s CMS settings management:
1616

17-
1. **Take control of files by removing the `#ddev-generated` comment.**
17+
1. **Take control of files by removing the `#ddev-generated` comment.**
1818
DDEV will automatically update any it’s added containing a `#ddev-generated` comment. This means you don’t need to touch that file, but also that any changes you make will be overwritten. As soon as you remove the comment, DDEV will ignore that file and leave you fully in control over it. (Don’t forget to check it into version control!)
1919

2020
!!!tip "Reversing the change"
2121
If you change your mind and want DDEV to take over the file again, delete it and run [`ddev start`](../usage/commands.md#start). DDEV will recreate its own version, which you may want to remove from your Git project.
2222

23-
2. **Disable settings management.**
23+
2. **Disable settings management.**
2424
You can tell DDEV to use a specific project type without creating settings files by either setting [`disable_settings_management`](../configuration/config.md#disable_settings_management) to `true` or running [`ddev config --disable-settings-management`](../configuration/config.md#type).
2525

26-
3. **Switch to the generic PHP project type.**
26+
3. **Switch to the generic PHP project type.**
2727
If you don’t want DDEV’s CMS-specific settings, you can switch your project to the generic `php` type by editing [`type: php`](../configuration/config.md#type) in the project’s settings or running [`ddev config --project-type=php`](../usage/commands.md#config). DDEV will no longer create or tweak any settings files. You’ll lose any perks from the nginx configuration for the CMS, but you can always customize [nginx settings](../extend/customization-extendibility.md#custom-nginx-configuration) or [Apache settings](../extend/customization-extendibility.md#custom-apache-configuration) separately.
2828

29-
4. **Un-set the `$IS_DDEV_PROJECT` environment variable.**
29+
4. **Un-set the `$IS_DDEV_PROJECT` environment variable.**
3030
This environment variable is set `true` by default in DDEV’s environment, and can be used to fence off DDEV-specific behavior. When it’s empty, the important parts of `settings.ddev.php` and `AdditionalSettings.php` (for TYPO3) are not executed. This means that DDEV’s `settings.ddev.php` won’t be invoked if it somehow ends up in a production environment or in a non-DDEV local development environment.
3131

3232
!!!tip "Ignore `.ddev/.gitignore`"
@@ -61,42 +61,42 @@ $settings['container_yamls'][] = DRUPAL_ROOT . '/sites/development.services.yml'
6161

6262
```php
6363
/**
64-
* DDEV environments will have $databases (and other settings) set
65-
* by an auto-generated file. Make alterations here for this site
66-
* in a multisite environment.
67-
*/
64+
* DDEV environments will have $databases (and other settings) set
65+
* by an auto-generated file. Make alterations here for this site
66+
* in a multisite environment.
67+
*/
6868
elseif (getenv('IS_DDEV_PROJECT') == 'true') {
69-
/**
70-
* Alter database settings and credentials for DDEV environment.
71-
* Includes loading the DDEV-generated `default/settings.ddev.php`.
72-
*/
73-
include $app_root . '/' . $site_path . '/settings.databases.ddev.inc';
69+
/**
70+
* Alter database settings and credentials for DDEV environment.
71+
* Includes loading the DDEV-generated `default/settings.ddev.php`.
72+
*/
73+
include $app_root . '/' . $site_path . '/settings.databases.ddev.inc';
7474
}
7575
```
7676

7777
2. Add a `settings.databases.ddev.inc` in each `site/{site_name}/`:
7878

7979
```php
8080
/**
81-
* Fetch DDEV-generated database credentials and other settings.
82-
*/
81+
* Fetch DDEV-generated database credentials and other settings.
82+
*/
8383
require $app_root . '/sites/default/settings.ddev.php';
8484

85-
/*
86-
* Alter default database for this site. `settings.ddev.php` will have
87-
* “reset” this to 'db'.
88-
*/
85+
/**
86+
* Alter default database for this site. `settings.ddev.php` will have
87+
* “reset” this to 'db'.
88+
*/
8989
$databases['default']['default']['database'] = 'site_name';
9090
```
9191

9292
3. Update your [`web_environment`](../configuration/config.md#web_environment) config option if you’re using site aliases:
9393

9494
```yaml
9595
web_environment:
96-
# Make DDEV Drush shell PIDs last for entire life of the container
97-
# so `ddev drush site:set @alias` persists for all Drush connections.
98-
# https://chrisfromredfin.dev/posts/drush-use-ddev/
99-
- DRUSH_SHELL_PID=PERMANENT
96+
# Make DDEV Drush shell PIDs last for entire life of the container
97+
# so `ddev drush site:set @alias` persists for all Drush connections.
98+
# https://chrisfromredfin.dev/posts/drush-use-ddev/
99+
- DRUSH_SHELL_PID=PERMANENT
100100
```
101101

102102
### TYPO3 Specifics

docs/content/users/usage/database-management.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ DDEV provides lots of flexibility for managing your databases between your local
77

88
## Database Imports
99

10-
Import a database with one command, from one of the following file formats:
10+
Import a database with one command, from one of the following file formats:
1111
**.sql, .sql.gz, .mysql, .mysql.gz, .tar, .tar.gz, and .zip**.
1212

1313
Here’s an example of a database import using DDEV:

docs/content/users/usage/developer-tools.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Use [`ddev composer`](../usage/commands.md#composer) (Composer inside the contai
5858
* On some older configurations of Docker Desktop for Windows, symlinks are created in the container as “simulated symlinks”, or XSym files. These special text files behave as symlinks inside the container (on CIFS filesystem), but appear as simple text files on the Windows host. (On the CIFS filesystem used by Docker for Windows, inside the container, there is no capability to create real symlinks even though Windows now has this capability.)
5959
* DDEV attempts to clean up for this situation. Since Windows 10/11+ (in developer mode) can create real symlinks, DDEV scans your repository after a `ddev composer` command and attempts to convert XSym files into real symlinks. On older versions of Windows 10, it can only do this if your Windows 10 workstation is set to “Developer Mode”.
6060
* To enable developer mode on Windows 10/11+, search for “developer” in settings:
61-
![Finding developer mode](../../images/developer-mode-1.png)
61+
![Finding developer mode](../../images/developer-mode-1.png)
6262
![Setting developer mode](../../images/developer-mode-2.png)
6363

6464
## Email Capture and Review (MailHog)

docs/content/users/usage/troubleshooting.md

+1
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@ If you get a 404 with “No input file specified” (nginx) or a 403 with “For
174174
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.
175175

176176
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:
177+
177178
![Docker disk space](../../images/docker-disk-image-size.png)
178179

179180
If you see “no space left on device” on Linux, it most likely means your filesystem is full.

0 commit comments

Comments
 (0)