[docs] Improve formatting, fix typos, remove duplicates (ddev#4726)

stasadev · web-flow · commit 88a053f4387d · 2023-03-11T12:47:54.000-07:00
diff --git a/docs/content/developers/release-management.md b/docs/content/developers/release-management.md
@@ -42,9 +42,11 @@ The following “Repository secret” environment variables must be added to <ht
 
 * Create and execute a test plan.
 * Make sure [`version-history.md`](https://github.com/ddev/ddev/blob/master/version-history.md) is up to date.
+* Push the new version of `drud/ddev-php-base`.
+* Update `drud/ddev-webserver` to use the new version of `drud/ddev-php-base` and push it with the proper tag.
 * Make sure the Docker images are all tagged and pushed.
 * Make sure [`pkg/versionconstants/versionconstants.go`](https://github.com/ddev/ddev/blob/master/pkg/versionconstants/versionconstants.go) is all set to point to the new images and tests have been run.
-* If the devcontainer-feature.json (for GitHub Codespaces) needs to be updated, use the [`devcontainer` CLI](https://github.com/devcontainers/cli):
+* If the [`devcontainer-feature.json`](https://github.com/ddev/ddev/blob/master/.github/devcontainers/src/install-ddev/devcontainer-feature.json) (for GitHub Codespaces) needs to be updated, use the [`devcontainer` CLI](https://github.com/devcontainers/cli):
 
     ```bash
     cd .github/devcontainers/source
@@ -55,44 +57,31 @@ The following “Repository secret” environment variables must be added to <ht
 ### Actual Release Creation
 
 1. Create a [release](https://github.com/ddev/ddev/releases) for the new version using the GitHub UI. It should be “prerelease” if it’s an edge release.
-2. Use the “Auto-generate release notes” option to get the commit list, then edit to add all the other necessary info.
-3. Verify that Homebrew (Linux and macOS) and Chocolatey and AUR are working correctly with the right versions.
+2. Make sure you're about to create the right release tag.
+3. Use the “Auto-generate release notes” option to get the commit list, then edit to add all the other necessary info.
 
 ### Post-Release Tasks
 
 1. After the release has been created, the new gitpod image must be pushed.
-   1. `cd .gitpod/images && DOCKER_TAG="<YYMMDD>" ./push.sh
-   2. PR to update .gitpod.yml with the new image.
+   1. `cd .gitpod/images && DOCKER_TAG="<YYMMDD>" ./push.sh`
+   2. PR to update `.gitpod.yml` with the new image.
    3. PR to update [ddev-gitpod-launcher](https://github.com/ddev/ddev-gitpod-launcher) with the new image.
 
 ## Pushing Docker Images with the GitHub Actions Workflow
 
 The easiest way to push Docker images is to use the GitHub Actions workflow, especially if the code for the image is already in the [ddev/ddev](https://github.com/ddev/ddev) repository.
 
-### Prerelease tasks
-
-1. Push the new version of drud/ddev-php-base
-2. Update drud/ddev-webserver to use the new version of drud/ddev-php-base and push it with the proper tag
-3. Make sure the `version-history.md` file is up to date.
-4. Make sure the docker images for the new tag are all tagged and pushed.
-5. Make sure the pkg/version/version.go is all set to point to the new images (and tests have been run)
-6. Make sure you're about to create the right release tag.
-
 ### Actual release creation
 
-1. Create a release for the new version using the GitHub UI. It should be "prerelease" if it's an edge release. Use the right tag!
-2. Use the "Auto-generate release notes" option to get the commit list, then edit to add all the other necessary info.
-3. Verify that homebrew (linux and macOS) and Chocolatey and AUR are working correctly with the right versions
-
-## Pushing docker images with the GitHub Actions workflow
-
-The easiest way to push docker images is to use the GitHub Actions workflow, especially if the code for the image is already in the ddev repo.
+1. Create a [release](https://github.com/ddev/ddev/releases) for the new version using the GitHub UI. It should be “prerelease” if it’s an edge release.
+2. Use the “Auto-generate release notes” option to get the commit list, then edit to add all the other necessary info.
+3. Verify that Homebrew (Linux and macOS) and Chocolatey and AUR are working correctly with the right versions.
 
 <!-- markdown-link-check-disable-next-line -->
 You can push an image at <https://github.com/ddev/ddev/actions/workflows/push-tagged-image.yml>
 
 <!-- markdown-link-check-disable-next-line -->
-If you need to push from a forked PR, you’ll have to do this from your fork (for example, `https://github.com/drud/rfay/actions/workflows/push-tagged-image.yml`), and you’ll have to specify the branch on the fork. This requires setting the `DOCKERHUB_TOKEN` and `DOCKERHUB_USERNAME` secrets on the forked PR, for example `https://github.com/rfay/ddev/settings/secrets/actions`.
+If you need to push from a forked PR, you’ll have to do this from your fork (for example, `https://github.com/rfay/ddev/actions/workflows/push-tagged-image.yml`), and you’ll have to specify the branch on the fork. This requires setting the `DOCKERHUB_TOKEN` and `DOCKERHUB_USERNAME` secrets on the forked PR, for example `https://github.com/rfay/ddev/settings/secrets/actions`.
 
 * Visit `https://github.com/ddev/ddev/actions/workflows/push-tagged-image.yml`.
 * Click the “Push tagged image” workflow on the left side of the page.
diff --git a/docs/content/users/configuration/config.md b/docs/content/users/configuration/config.md
@@ -83,7 +83,7 @@ The type and version of the database engine the project should use.
 
 | Type | Default | Usage
 | -- | -- | --
-| :octicons-file-directory-16: project | MariaDB 10.4 | Can be MariaDB 5.5–10.7, MySQL 5.5–8.0, or PostgreSQL 9–15.<br>See [Database Server Types](../extend/database-types.md) for examples and caveats.
+| :octicons-file-directory-16: project | MariaDB 10.4 | Can be MariaDB 5.5–10.8, MySQL 5.5–8.0, or PostgreSQL 9–15.<br>See [Database Server Types](../extend/database-types.md) for examples and caveats.
 
 !!!note
     DDEV v1.18 and earlier used `mariadb_version` and `mysql_version`, which are now automatically converted to the `database` format.
diff --git a/docs/content/users/topics/remote-docker.md b/docs/content/users/topics/remote-docker.md
@@ -6,7 +6,7 @@ You can use remote Docker instances, whether on the internet, inside your networ
 
 * On the remote machine, the Docker port must be exposed if it’s not already. See [instructions](https://gist.github.com/styblope/dc55e0ad2a9848f2cc3307d4819d819f) for how to do this on a systemd-based remote server. **Be aware that this has serious security implications and must not be done without taking those into consideration.** In fact, `dockerd` will complain:
 
-    > Binding to IP address without --tlsverify is insecure and gives root access on this machine to everyone who has access to your network.  host="tcp://0.0.0.0:2375".
+    > Binding to IP address without `--tlsverify` is insecure and gives root access on this machine to everyone who has access to your network.  host="tcp://0.0.0.0:2375".
 
 * If you do not already have the Docker client installed (like you would from Docker Desktop), install *just* the client with `brew install docker`.
 * Create a Docker context that points to the remote Docker instance. For example, if the remote hostname is `debian-11`, then `docker context create debian-11 --docker host=tcp://debian-11:2375 && docker use debian-11`. Alternately, you can use the `DOCKER_HOST` environment variable, e.g. `export DOCKER_HOST=tcp://debian-11:2375`.
diff --git a/docs/content/users/topics/sharing.md b/docs/content/users/topics/sharing.md
@@ -46,7 +46,7 @@ This set of steps assumes an ngrok subdomain `mg2`:
 * Run `bin/magento setup:store-config:set --base-url="https://mg2.ngrok.io/`.
 * Run [`ddev share`](../usage/commands.md#share) and you’ll see your project at `mg2.ngrok.io`.
 
-### Using nip.io or Custom Name Resolution on Your Local Network
+## Using nip.io or Custom Name Resolution Locally
 
 Another solution is to **not** use `*.ddev.site` as your project URLs, but to use DNS that you control and that points to the host machine where your project lives. In general, you’ll want to use HTTP URLs with this approach, because it requires manual configuration of the client machine to get it to trust the development certificate that DDEV uses and configures with `mkcert` on the local machine.
 
diff --git a/docs/content/users/usage/architecture.md b/docs/content/users/usage/architecture.md
@@ -44,7 +44,7 @@ A project’s `.ddev` directory can be intimidating at first, so let’s take a
 : Files to be copied into the web container on startup. You could use this, for example, to override the default home directory contents (`.profile`, `.bashrc`, `.composer`, `.ssh`), or include scripts that you’d like to be available inside the container. (You can do the same thing globally in `~/.ddev/homeadditions`.) Check out the [homeadditions docs](../extend/in-container-configuration.md) for more.
 
 `mutagen` directory
-: Contains `mutagen/mutagen.yml`, where you can [override the default Mutagen configuration](../install/performance.md#advanced-mutagen-configuration-options).
+: Contains `mutagen.yml`, where you can [override the default Mutagen configuration](../install/performance.md#advanced-mutagen-configuration-options).
 
 `mysql` directory
 : Contains [optional `mysql` or `mariadb` configuration](../extend/customization-extendibility.md#providing-custom-mysqlmariadb-configuration-mycnf).
@@ -56,7 +56,7 @@ A project’s `.ddev` directory can be intimidating at first, so let’s take a
 : Contains the nginx configuration used by the web container, which [can be customized](../extend/customization-extendibility.md#providing-custom-nginx-configuration).
 
 `postgres` directory
-: Contains `postgres/postgresql.conf`, which can be edited if needed. Remove the `#ddev-generated` line at the top to take it over.
+: Contains `postgresql.conf`, which can be edited if needed. Remove the `#ddev-generated` line at the top to take it over.
 
 `providers` directory
 : Contains examples and implementations to demonstrate how the [`ddev pull`](../usage/commands.md#pull) command can work with [hosting providers](../providers/index.md).
diff --git a/docs/content/users/usage/commands.md b/docs/content/users/usage/commands.md
@@ -233,13 +233,13 @@ ddev config global --omit-containers=dba,ddev-ssh-agent
 * `--letsencrypt-email`: Email associated with Let’s Encrypt; `ddev global --letsencrypt-email=me@example.com`.
 * `--mutagen-enabled`: If `true`, web container will use Mutagen caching/asynchronous updates.
 * `--nfs-mount-enabled`: Enable NFS mounting on all projects globally.
-* `--no-bind-mounts`: If `true`, don’t use bind-mounts. Useful for environments like remote Docker where bind-mounts are impossible. (default `true`)
+* `--no-bind-mounts`: If `true`, don’t use bind-mounts. Useful for environments like remote Docker where bind-mounts are impossible. (default is equal to `--no-bind-mounts=true`)
 * `--omit-containers`: For example, `--omit-containers=dba,ddev-ssh-agent`.
 * `--required-docker-compose-version`: Override default docker-compose version.
 * `--router-bind-all-interfaces`: `router-bind-all-interfaces=true`.
 * `--simple-formatting`: If `true`, use simple formatting and no color for tables.
 * `--table-style`: Table style for list and describe, see `~/.ddev/global_config.yaml` for values.
-* `--use-docker-compose-from-path`: If `true`, use docker-compose from path instead of private `~/.ddev/bin/docker-compose`. (default `true`)
+* `--use-docker-compose-from-path`: If `true`, use docker-compose from path instead of private `~/.ddev/bin/docker-compose`. (default is equal to `--use-docker-compose-from-path=true`)
 * `--use-hardened-images`: If `true`, use more secure 'hardened' images for an actual internet deployment.
 * `--use-letsencrypt`: Enables experimental Let’s Encrypt integration; `ddev global --use-letsencrypt` or `ddev global --use-letsencrypt=false`.
 * `--web-environment`: Set the environment variables in the web container: `--web-environment="TYPO3_CONTEXT=Development,SOMEENV=someval"`
diff --git a/docs/content/users/usage/database-management.md b/docs/content/users/usage/database-management.md
@@ -23,7 +23,7 @@ You can also:
 
 ## Database Backends and Defaults
 
-You can use a [variety of different database types](../extend/database-types.md#database-server-types), including MariaDB (5.5–10.8), MySQL (5.5–8.0), and PostgreSQL (9–14). If you want to _change_ database type, you need to export your database, run [`ddev delete`](../usage/commands.md#delete) to remove the project (and its existing database), change to a new database type, run [`ddev start`](../usage/commands.md#start) again, and [import your data](../usage/commands.md#import-db).
+You can use a [variety of different database types](../extend/database-types.md#database-server-types), including MariaDB (5.5–10.8), MySQL (5.5–8.0), and PostgreSQL (9–15). If you want to _change_ database type, you need to export your database, run [`ddev delete`](../usage/commands.md#delete) to remove the project (and its existing database), change to a new database type, run [`ddev start`](../usage/commands.md#start) again, and [import your data](../usage/commands.md#import-db).
 
 DDEV creates a default database named `db` and default permissions for the `db` user with password `db`, and it’s on the (inside Docker) hostname `db`.
 
@@ -58,7 +58,7 @@ The PostgreSQL database container includes normal `pg` commands like `pgdump`.
 If you’d like to use a GUI database client, you’ll need the right connection details and there may even be a command to launch it for you:
 
 * The [`ddev describe`](../usage/commands.md#describe) command displays the URL for the built-in phpMyAdmin GUI. (Something like `https://<yourproject>.ddev.site:8037`.) It also includes the `Host:` details you’ll need to connect to the `db` container externally.
-* macOS users can use `ddev sequelace` to launch the free [Sequel Ace](https://sequel-ace.com/) database browser, [`ddev tableplus`](../usage/commands.md#tableplus) to launch [TablePlus](https://tableplus.com), [`ddev querious`] for [Querious](https://www.araelium.com/querious), and the obsolete [Sequel Pro](https://sequelpro.com/) is also supported with `ddev sequelpro`. (Each must be installed for the command to exist.)
+* macOS users can use `ddev sequelace` to launch the free [Sequel Ace](https://sequel-ace.com/) database browser, [`ddev tableplus`](../usage/commands.md#tableplus) to launch [TablePlus](https://tableplus.com), [`ddev querious`](../usage/commands.md#querious) for [Querious](https://www.araelium.com/querious), and the obsolete [Sequel Pro](https://sequelpro.com/) is also supported with `ddev sequelpro`. (Each must be installed for the command to exist.)
 * PhpStorm (and all JetBrains tools) have a nice database browser. (If you use the [DDEV Integration plugin](https://plugins.jetbrains.com/plugin/18813-ddev-integration) this is all done for you.)
     * Choose a static [`host_db_port`](../configuration/config.md#host_db_port) setting for your project. For example `host_db_port: 59002` (each project’s database port should be different if you’re running more than one project at a time). Use [`ddev start`](../usage/commands.md#start) for it to take effect.
     * Use the “database” tool to create a source from “localhost”, with the proper type “mysql” or “postgresql” and the port you chose, username `db` + password `db`.
diff --git a/docs/content/users/usage/offline.md b/docs/content/users/usage/offline.md
@@ -3,7 +3,7 @@
 DDEV attempts to work smoothly offline, and you shouldn’t have to do anything to make it work:
 
 * It doesn’t attempt instrumentation or update reporting if offline
-* It falls back to using `/etc/hosts` entries DNS resolution fails
+* It falls back to using `/etc/hosts` entries if DNS resolution fails
 
 However, it does not (yet) attempt to prevent Docker pulls if a new Docker image is required, so you’ll want to make sure that you try a [`ddev start`](../usage/commands.md#start) before going offline to make sure everything has been pulled.
 
