20240626 docs textlint (#3)

* docs: Warn about Codespaces (ddev#6321) [skip ci]

Co-authored-by: Matthias Andrasch <[email protected]>

* docs: Improve ddev debug test by offering suggestions early [skip ci] (ddev#6323)

* feat: add support for MariaDB 11.4 LTS, fixes ddev#6061 (ddev#6243)

Co-authored-by: Stanislav Zhuk <[email protected]>

* docs: pacify textlint on mysql/https (ddev#6336) [skip ci]

* docs: revisit WSL Docker Desktop setup instructions (ddev#6330)

* fix: autodownload yarn from corepack, and set cache-folder, fixes ddev#6332 (ddev#6333)

* docs: windows-wsl2-dd needs apt install for ngrok (ddev#6341) [skip ci]

* build: check docker-compose 2.28.1 (ddev#6340) [skip ci]

* fix: use real path to global config location, fixes ddev#6328 (ddev#6329)

* test: stop running nightly tests [skip ci] (ddev#6347)

* test: Improve reliability of TestProcessHooks (intermittent failures), fixes ddev#6313 (ddev#6314)

* fix: Drupal 10 and Drupal 11 settings have migrated, set state_cache (ddev#6346) [skip ci]

Co-authored-by: Stanislav Zhuk <[email protected]>

* build: use IPv4 inside a container, mariadb-client 11.4 for the webserver (ddev#6334) [skip ci]

* fix: pass all valid options to nested commands in `ddev composer create`, fixes ddev#6300, fixes ddev#6246, for ddev#5058 (ddev#6303)

Co-authored-by: Randy Fay <[email protected]>
Co-authored-by: Ralf Koller <[email protected]>

* docs: fix up textlint complaints

* Turn off defaultTerms

* Use exclude properly with textlint for VS Code

* update for additional textlint complaints

* remove redundant empty exclude section

* Try to get textlint/reviewdog to report

---------

Co-authored-by: Matthias Andrasch <[email protected]>
Co-authored-by: hussainweb <[email protected]>
Co-authored-by: Stanislav Zhuk <[email protected]>
Co-authored-by: Ralf Koller <[email protected]>

.github/workflows/docscheck.yml

@@ -24,6 +24,10 @@ concurrency:
 
 env:
   HOMEBREW_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+permissions:
+  actions: write
 
 jobs:
   build:

.textlintignore

@@ -0,0 +1 @@
+version-history.md

.textlintrc

@@ -6,7 +6,10 @@
     "no-todo": true,
     "terminology": {
       "defaultTerms": true,
-      "skip": ["Code", "Image"],
+      "skip": [
+        "Code",
+        "Image",
+       ],
       "terms": [
         "AMD64",
         "ARM64",
@@ -20,6 +23,7 @@
         "MySQL",
         "phpMyAdmin",
         "Traefik",
+        ["V[ -]?S[ -]?Code", "VS Code"],
         "Xdebug",
         ["(\\s)ddev", "DDEV"],
         ["(\\s)http", "HTTP"],
@@ -28,6 +32,7 @@
         ["web-?server", "web server"]
       ],
       "exclude": [
+        'V[ -]?S[ -]?Code',
         "back[- ]end(\\w*)",
         "command ?line",
         "front[- ]end(\\w*)",

docs/content/developers/buildkite-testmachine-setup.md

@@ -60,7 +60,7 @@ We are using [Buildkite](https://buildkite.com/ddev) for Windows and macOS testi
      [Environment]::SetEnvironmentVariable("WSLENV", $null, "Machine")
      ```
 
-15. Install homebrew: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
+15. Install Homebrew: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
 16. Configure brew in PATH with:
 
      ```
@@ -139,7 +139,7 @@ We are using [Buildkite](https://buildkite.com/ddev) for Windows and macOS testi
 24. Run `brew services start buildkite-agent`.
 25. Run `bash ~/workspace/ddev/.buildkite/testbot_maintenance.sh`.
 26. Run `bash ~/workspace/ddev/.buildkite/sanetestbot.sh` to check your work.
-27. The `testbot` user's ssh account is used for monitoring, so `ssh-keygen` and then add the public key `id_testbot` from 1Password to `~/.ssh/authorized_keys` and `chmod 600 ~/.ssh/authorized_keys`.
+27. The `testbot` user's SSH account is used for monitoring, so `ssh-keygen` and then add the public key `id_testbot` from 1Password to `~/.ssh/authorized_keys` and `chmod 600 ~/.ssh/authorized_keys`.
 28. Add the new machine to Icinga by copying an existing Icinga service to the new one. This is done in **Icinga Director** → **Services** → **Single Services** → **Select a Service** → **Clone** → **Deploy**. The new service has to have `by-ssh-address` set to the name of the test runner, and that address needs to be added to `pi.ddev.site`'s `/etc/hosts` file.
 29. If `zsh` is the shell configured, add `/etc/zshenv` so that `/usr/local/bin/docker` will be picked up:
 

docs/content/developers/release-management.md

@@ -30,7 +30,7 @@ The following “Repository secret” environment variables must be added to <ht
 * `AMPLITUDE_API_KEY_DEV`: Key that enables Amplitude reporting for development versions e.g. a PR build. Environment variable for Make is `AmplitudeAPIKey`.
 * `AUR_EDGE_GIT_URL`: The Git URL for AUR edge (normally `ddev-edge-bin`), for example `ssh://[email protected]/ddev-edge-bin.git`.
 * `AUR_STABLE_GIT_URL`: The Git URL for AUR stable (normally `ddev-bin`), for example `ssh://[email protected]/ddev-bin.git`.
-* `AUR_SSH_PRIVATE_KEY`: Private ssh key for the `ddev-releaser` user. This must be processed into a single line, for example, `perl -p -e 's/\n/<SPLIT>/' ~/.ssh/id_rsa_ddev_releaser| pbcopy`.
+* `AUR_SSH_PRIVATE_KEY`: Private SSH key for the `ddev-releaser` user. This must be processed into a single line, for example, `perl -p -e 's/\n/<SPLIT>/' ~/.ssh/id_rsa_ddev_releaser| pbcopy`.
 * `CHOCOLATEY_API_KEY`: API key for Chocolatey.
 * `DDEV_GITHUB_TOKEN`: GitHub personal token (`repo` scope, classic PAT) that gives access to create releases and push to the Homebrew repositories.
 * `DDEV_MACOS_APP_PASSWORD`: Password used for notarization, see [signing_tools](https://github.com/ddev/signing_tools).

docs/content/users/configuration/config.md

@@ -712,5 +712,5 @@ For PhpStorm running inside WSL2 (or JetBrains Gateway), use `"wsl2"`. For in-co
 Examples:
 
 * `xdebug_ide_location: 172.16.0.2` when you need to provide an explicit IP address where the IDE is listening. This is very unusual.
-* `xdebug_ide_location: container` when the IDE is actually listening inside the `ddev-webserver` container. This is only done very occasionally with obscure vscode setups like VS Code Language Server.
+* `xdebug_ide_location: container` when the IDE is actually listening inside the `ddev-webserver` container. This is only done very occasionally with obscure Visual Studio Code setups like VS Code Language Server.
 * `xdebug_ide_location: wsl2` when an IDE is running (or listening) in WSL2. This is the situation when running an IDE directly inside WSL2 instead of running it on Windows.

docs/content/users/extend/additional-services.md

@@ -118,7 +118,7 @@ Anyone can create an add-on for `ddev get`. See [this screencast](https://www.yo
 5. Add the `ddev-get` label and a good short description to the GitHub repository.
 6. When you’re ready for the add-on to become official, open an issue in the [DDEV issue queue](https://github.com/ddev/ddev/issues/new) requesting upgrade to official. You’ll be expected to maintain it, and subscribe to all activity and be responsive to questions.
 
-### Sections and Features of ddev-get Add-On install.yaml
+### Sections and Features of ddev-get Add-On `install.yaml`
 
 The `install.yaml` is a simple YAML file with a few main sections:
 

docs/content/users/providers/index.md

@@ -18,7 +18,7 @@ Each provider recipe is a YAML file that can have whatever name you want. The ex
 
 Each provider recipe is a file named `<provider>.yaml` and consists of several mostly-optional stanzas:
 
-* `environment_variables`: Environment variables will be created in the web container for each of these during pull or push operations. They’re used to provide context (project ID, environment name, etc.) for each of the other stanzas. This stanza is not used in more recent hosting integrations, since providing the environment variables in config.yaml or via `ddev pull xxx --environment=VARIABLE=value` is preferred.
+* `environment_variables`: Environment variables will be created in the web container for each of these during pull or push operations. They’re used to provide context (project ID, environment name, etc.) for each of the other stanzas. This stanza is not used in more recent hosting integrations, since providing the environment variables in `config.yaml` or via `ddev pull xxx --environment=VARIABLE=value` is preferred.
 * `db_pull_command`: A script that determines how DDEV should obtain a database. Its job is to create a gzipped database dump in `/var/www/html/.ddev/.downloads/db.sql.gz`. This is optional; if nothing has to be done to obtain the database dump, this step can be omitted.
 * `db_import_command`: (optional) A script that imports the downloaded database. This is for advanced usages like multiple databases. The default behavior only imports a single database into the `db` database. The [localfile example](https://github.com/ddev/ddev/blob/master/pkg/ddevapp/dotddev_assets/providers/localfile.yaml.example) uses this technique.
 * `files_pull_command`: A script that determines how DDEV can get user-generated files from upstream. Its job is to copy the files from upstream to `/var/www/html/.ddev/.downloads/files`. If nothing has to be done to obtain the files, this step can run `true`.

docs/content/users/usage/commands.md

@@ -402,7 +402,7 @@ ddev debug get-volume-db-version
 
 ### `debug migrate-database`
 
-Migrate a MySQL or MariaDB database to a different `dbtype:dbversion`. Works only with MySQL and MariaDB, not with PostgreSQL. It will export your database, create a snapshot, destroy your current database, and import into the new database type. It only migrates the 'db' database. It will update the database version in your project's config.yaml file.
+Migrate a MySQL or MariaDB database to a different `dbtype:dbversion`. Works only with MySQL and MariaDB, not with PostgreSQL. It will export your database, create a snapshot, destroy your current database, and import into the new database type. It only migrates the 'db' database. It will update the database version in your project's `config.yaml` file.
 
 Example:
 

version-history.md

@@ -12,7 +12,7 @@ This version history has been driven by what we hear from our wonderful communit
 - [x] `nodejs_version` now defaults to 20
 - [x] `php_version` defaults to 8.2
 - [x] PHP 8.3
-- [x] Corepack and yarn v4 support
+- [x] Corepack and Yarn v4 support
 - [x] Drupal 11 support
 - [x] New "drupal", "cakephp" and "silverstripe" project types.
 - [x] Support for even more Docker providers, especially on macOS
@@ -55,7 +55,7 @@ This version history has been driven by what we hear from our wonderful communit
 
 ## v1.20 (Released 2022-08)
 
-- [x] Improved Node.js support**. You can now run a Node.js daemon with simple `config.yaml` support (`web_extra_daemons`) and if it listens on a port you can expose it via `ddev-router` with `web_extra_exposed_ports`. (Both of these features can be used for daemons other than nodejs daemons.)
+- [x] Improved Node.js support**. You can now run a Node.js daemon with simple `config.yaml` support (`web_extra_daemons`) and if it listens on a port you can expose it via `ddev-router` with `web_extra_exposed_ports`. (Both of these features can be used for daemons other than Node.js daemons.)
 - [x] Default PHP version for new projects is now 8.0; the default database version is now MariaDB 10.4.
 - [x] `config.*.yaml` are now *merged* instead of overwriting other values. For example, if `config.yaml` has hooks, and `config.something.yaml` has hooks, the values will be merged, getting all of the hooks. Scalar values (like `php_version`, for example) still are overwritten by the last value loaded.
 - [x] `ddev craft` command is now included for projects of type `php`.
@@ -125,7 +125,7 @@ This version history has been driven by what we hear from our wonderful communit
 - [x] Global homeadditions
 - [x] WSL2 support
 - [x] Reworked Nginx/Apache configurations
-- [x] zsh completions
+- [x] Zsh completions
 - [x] MariaDB 10.5 support
 - [x] Remove obsolete support for `drud-aws`.
 
@@ -172,7 +172,7 @@ This version history has been driven by what we hear from our wonderful communit
 - [x] [Contrib-pointers for additional Services and techniques](https://github.com/ddev/ddev/issues/1474): We want to make another place for the outstanding content and pointers and applications that our users are developing. This will probably be a contrib repository for ddev.
 - [x] [NFS Setup Security Review](https://github.com/ddev/ddev/issues/1474): More docs and improved NFS setup scripts so people can think clearly and plan carefully for how they’re using NFS with DDEV.
 - [x] [Use DNS to provide name resolution when internet available](https://github.com/ddev/ddev/issues/416)
-- [x] [Manage ddev project list in ~/.ddev/global_config.yaml](https://github.com/ddev/ddev/issues/642): Since the beginning of DDEV, `ddev list` and everything that depended on it couldn’t work if the project was shut down. This should fix that.
+- [x] [Manage ddev project list in `~/.ddev/global_config.yaml`](https://github.com/ddev/ddev/issues/642): Since the beginning of DDEV, `ddev list` and everything that depended on it couldn’t work if the project was shut down. This should fix that.
 - [x] [Allow specifying a target container for hook execution](https://github.com/ddev/ddev/issues/1038)
 - [x] [Support ngrok to allow web access remotely](https://github.com/ddev/ddev/issues/375)
 - [x] [Hook system overhaul](https://github.com/ddev/ddev/issues/1372)
@@ -216,7 +216,7 @@ This version history has been driven by what we hear from our wonderful communit
     - Note that because of problems with symlinks on Windows, it is *not* recommended to use code from the host (Windows) side, or to check it in. That means it will not be appropriate to check in the vendor directory on the host (although it would be safe inside the container), but most people do a composer build anyway.
     - The `ddev composer create` command is almost the same as `composer create-project` but we couldn’t make it exactly the same. See [docs](https://ddev.readthedocs.io/en/latest/users/basics/developer-tools/#ddev-and-composer) for its usage.
 - Composer caching: Composer downloads are now cached in a shared Docker volume, making in-container composer builds far faster.
-- Shared SSH authentication in web container: You can now `ddev auth ssh` to authenticate your keys in the automatically-started `ddev-ssh-agent` container, which shares auth information with ever project’s web container. This allows access to private composer repositories without the pain of manually mounting ssh keys and authenticating each time you need them in each web container. It also allows easier use of facilities like `drush rsync` that need SSH auth. This means that the previous [manual workaround for mounting ssh keys](https://stackoverflow.com/questions/51065054/how-can-i-get-my-ssh-keys-and-identity-into-ddevs-web-container) is now obsolete. Please use `ddev auth ssh` instead.
+- Shared SSH authentication in web container: You can now `ddev auth ssh` to authenticate your keys in the automatically-started `ddev-ssh-agent` container, which shares auth information with ever project’s web container. This allows access to private composer repositories without the pain of manually mounting SSH keys and authenticating each time you need them in each web container. It also allows easier use of facilities like `drush rsync` that need SSH auth. This means that the previous [manual workaround for mounting SSH keys](https://stackoverflow.com/questions/51065054/how-can-i-get-my-ssh-keys-and-identity-into-ddevs-web-container) is now obsolete. Please use `ddev auth ssh` instead.
 - Configurable working and destination directories. You can now specify the container directory you land in with `ddev ssh`, `ddev exec`, and exec hooks in `config.yaml` (#1214). This also means that TYPO3 users will land in the project root by default; Drupal/Backdrop users land in the project root by default.
 - [`ddev export-db`](https://ddev.readthedocs.io/en/stable/users/cli-usage/#exporting-a-database) makes textual exports of the database easier; Don’t forget about `ddev snapshot` as well.