Skip to content

Commit

Permalink
[docs] Massive formatting and proper noun tune-up (#4200)
Browse files Browse the repository at this point in the history
  • Loading branch information
mattstein committed Oct 5, 2022
1 parent a61a893 commit a94f9d7
Show file tree
Hide file tree
Showing 84 changed files with 5,800 additions and 2,037 deletions.
2 changes: 1 addition & 1 deletion .ci-scripts/bump_aur.sh
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ cat >PKGBUILD <<END
pkgname="${AUR_REPO}"
pkgver=$(echo ${VERSION_NUMBER} | tr '-' '_')
pkgrel=1
pkgdesc='DDEV-Local: a local PHP development environment system${EDGE_DESCRIPTION}'
pkgdesc='DDEV: a local PHP development environment system${EDGE_DESCRIPTION}'
arch=('x86_64')
url='https://github.com/drud/ddev'
license=('Apache')
Expand Down
4 changes: 2 additions & 2 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ aurs:
ids:
- ddev
homepage: "https://github.com/drud/ddev"
description: "DDEV-Local: a local web development environment"
description: "DDEV: a local web development environment"
maintainers:
- 'Randy Fay <randy at randyfay.com>'
license: "Apache 2"
Expand Down Expand Up @@ -313,7 +313,7 @@ aurs:
ids:
- ddev
homepage: "https://github.com/drud/ddev"
description: "DDEV-Local: a local web development environment (edge)"
description: "DDEV: a local web development environment (edge)"
maintainers:
- 'Randy Fay <randy at randyfay.com>'
license: "Apache 2"
Expand Down
19 changes: 17 additions & 2 deletions .spellcheckwordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ CIFS
CLI
CMD
CMS
CMSs
CMSes
Colima
CPUs
CTRL
Expand All @@ -26,8 +26,9 @@ Commands
Completely
Create
DDEV's
DDEV-Local
DDEV
DHCP
DKIM
DNS
Docker
Docker's
Expand Down Expand Up @@ -72,6 +73,7 @@ MAMP
Magento
Magento's
MailHog
MailHog's
Mailgun
Manage
MariaDB
Expand All @@ -95,6 +97,7 @@ PID
PWD
PartOf
PathMaps
phpMyAdmin's
PhpStorm
PowerShell
Pull
Expand Down Expand Up @@ -173,6 +176,7 @@ beanstalkd
belonging
behat
blackfire
blackfire's
bool
breakpoint
browser
Expand Down Expand Up @@ -218,6 +222,7 @@ cron
cson
current
customizations
daemon's
daemonize
data
database
Expand All @@ -228,6 +233,7 @@ dbimage
dbname
dbpass
dbserver
DBTypes
dbuser
ddev
ddev's
Expand Down Expand Up @@ -316,10 +322,12 @@ help
homeadditions
homebrew
host
HostBinaryExists
hostenv
hostfile
hostname
hostnames
HostWorkingDir
htaccess
html
http
Expand Down Expand Up @@ -431,6 +439,7 @@ one
oneshot
or
oriented
OSTypes
output
pause
pdfreactor
Expand Down Expand Up @@ -470,6 +479,7 @@ projdir
project
projectname
projects
ProjectTypes
proot
proto
provided
Expand All @@ -478,6 +488,7 @@ ps
psql
public
quickstart
quickstarts
rabbitmq
rc
readme
Expand Down Expand Up @@ -553,6 +564,7 @@ supervisord
sur
susi
svg
symfony
symlink
symlinked
symlinks
Expand All @@ -567,6 +579,7 @@ tcp
tcpview
template
templated
templating
test
testbot
testbots
Expand Down Expand Up @@ -636,9 +649,11 @@ wsl2
wslg
www
xdebug
xdebug's
xtrabackup
xeyes
xhprof
xz'd
yaml
yml
you
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
The ddev project code of conduct is included [in ddev's documentation](docs/content/users/code-of-conduct.md).
The DDEV project code of conduct is included [in DDEV’s documentation](docs/content/users/code-of-conduct.md).
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ If you find a bug in this project, have trouble following the documentation, or

## Stack Overflow Questions and Documentation

There are a number of situations where a particular approach to a ddev solution can be stated more easily in [Stack Overflow](https://stackoverflow.com/tags/ddev) (use the "ddev" tag). We respond there quickly, but if you know the answer already, create the question there and then click the checkbox at the bottom "Answer your own question". Stack Overflow is often the best place to incubate documentation that affects just a few people or that just needs time to get responses. And it's highly searchable on the web.
There are a number of situations where a particular approach to a DDEV solution can be stated more easily in [Stack Overflow](https://stackoverflow.com/tags/ddev) (use the "ddev" tag). We respond there quickly, but if you know the answer already, create the question there and then click the checkbox at the bottom "Answer your own question". Stack Overflow is often the best place to incubate documentation that affects just a few people or that just needs time to get responses. And it's highly searchable on the web.

## Pull Request

Expand Down
37 changes: 19 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,41 @@
# ddev
# DDEV

[![CircleCI](https://circleci.com/gh/drud/ddev.svg?style=shield)](https://circleci.com/gh/drud/ddev) ![project is maintained](https://img.shields.io/maintenance/yes/2022.svg)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/drud/ddev)

![ddev logo](images/ddev_logo.png)
![DDEV logo](images/ddev_logo.png)

ddev is an open source tool that makes it simple to get local PHP development environments up and running in minutes. It's powerful and flexible as a result of its per-project environment configurations, which can be extended, version controlled, and shared. In short, ddev aims to allow development teams to use Docker in their workflow without the complexities of bespoke configuration.
DDEV is an open source tool for running local PHP development environments in minutes. Its powerful, flexible per-project environment configurations can be extended, version controlled, and shared. DDEV allows development teams to adopt a consistent Docker workflow without the complexities of bespoke configuration.

## Get Started

1. **Check [System Requirements](https://ddev.readthedocs.io/):** DDEV runs the same on macOS (M1 and amd64), Windows 10/11, WSL2, Linux, and Gitpod.io.
2. **Install [docker/colima and DDEV](https://ddev.readthedocs.io/en/latest/users/install/)**.
1. **Check [System Requirements](https://ddev.readthedocs.io/):** macOS (Intel and Apple Silicon), Windows 10/11, WSL2, Linux, and [Gitpod](https://www.gitpod.io).
2. **Install [Docker/Colima and DDEV](https://ddev.readthedocs.io/en/latest/users/install/)**.
3. **Try a [CMS Quick Start Guide](https://ddev.readthedocs.io/en/latest/users/quickstart/)**.

Having trouble? This community has [great support](https://ddev.readthedocs.io/en/latest/users/support).
If you need help, our friendly community provides [great support](https://ddev.readthedocs.io/en/latest/users/support).

## Partial Feature List
## Partial Features

* Quickly create multiple local web development environments based on code repositories.
* Import a database for a project you're working on.
* Import upload files to match the project (e.g. Drupal sites/default/files or WordPress wp-content/uploads).
* Customizable integration with hosting platforms like Platform.sh, Pantheon, Acquia and others.
* Run commands within the docker environment using `ddev exec`.
* View logs from the web and db containers.
* Use `ddev ssh` to explore the linux environment inside the container.
* Quickly create local web development environments based on code repositories, with minimal configuration.
* Import a database to any of your local environments.
* Import upload files to match the project (e.g. Drupal sites/default/files or WordPress `wp-content/uploads`).
* Customizable integration with hosting platforms like [Platform.sh](https://platform.sh), [Pantheon](https://pantheon.io), [Acquia](https://www.acquia.com) and others.
* Run commands within the Docker environment using `ddev exec`.
* View logs from the web and database containers.
* Use `ddev ssh` to explore the Linux environment inside the container.
* List running projects with `ddev list`.
* Snapshot databases with `ddev snapshot`.
* Temporarily share your development website with other using `ddev share`.
* Temporarily share your development website with others using `ddev share`.
* Create custom commands as simple shell scripts.
* Trusted HTTPS support.
* Enjoy effortless, trusted HTTPS support.
* Extend and customize environments as much (or as little!) as you need to.

Just running `ddev` will show you all the commands.
Run `ddev` to see all the [commands](https://ddev.readthedocs.io/en/stable/users/basics/cli-usage/).

## Contributing

See the "How can I contribute" question in the [FAQ](https://ddev.readthedocs.io/en/latest/users/basics/faq/) and [Contributing.md](CONTRIBUTING.md).
See How can I contribute to DDEV?” in the [FAQ](https://ddev.readthedocs.io/en/latest/users/basics/faq/), and the [Contributing](CONTRIBUTING.md) page.

## Wonderful Sponsors

Expand Down
2 changes: 1 addition & 1 deletion cmd/ddev/cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ var (
// RootCmd represents the base command when called without any subcommands
var RootCmd = &cobra.Command{
Use: "ddev",
Short: "DDEV-Local local development environment",
Short: "DDEV local development environment",
Long: `Create and maintain a local web development environment.
Docs: https://ddev.readthedocs.io
Support: https://ddev.readthedocs.io/en/stable/users/support`,
Expand Down
2 changes: 1 addition & 1 deletion containers/ddev-dbserver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ddev-dbserver for ddev

This docker image builds database server images (MariaDB and MySQL) for DDEV-Local.
This Docker image builds database server images (MariaDB and MySQL) for DDEV.

```
make container
Expand Down
3 changes: 1 addition & 2 deletions containers/ddev-php-base/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@ RUN apt-get -qq install --no-install-recommends --no-install-suggests -y \

### ---------------------------ddev-php-base--------------------------------------
### Build ddev-php-base, which is the base for ddev-php-prod and ddev-webserver-*
### This combines the packages and features of DDEV-Local's ddev-webserver and
### DDEV-Live's PHP image
### This combines the packages and features of DDEV’s ddev-webserver and PHP image
FROM base AS ddev-php-base
ARG PHP_DEFAULT_VERSION="8.0"
ENV DDEV_PHP_VERSION=$PHP_DEFAULT_VERSION
Expand Down
6 changes: 3 additions & 3 deletions containers/ddev-php-base/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# ddev-images
# ddev-php-base

This repository provides the build techniques for the webserving/php DDEV-Live Docker images and provides the base for DDEV-Local to build ddev-webserver images:
This repository provides the build techniques for the webserving/php DDEV Docker images and provides the base for DDEV to build ddev-webserver images:

* *ddev-php-base* is the base for ddev-php-prod, and will be used by DDEV-Local to build ddev-webserver images.
* *ddev-php-base* is the base for ddev-php-prod, and will be used by DDEV to build ddev-webserver images.

![Block Diagram](docs-pics/ddev-images-block-diagram.png)

Expand Down
6 changes: 3 additions & 3 deletions containers/ddev-router/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
## Information

This project is based on the [jwilder/nginx-proxy](https://github.com/jwilder/nginx-proxy) project and contains overrides to the nginx config template specific to [ddev](https://github.com/drud/ddev). If you are looking for a generalized docker router solution, we recommend you look there.
This project is based on the [jwilder/nginx-proxy](https://github.com/jwilder/nginx-proxy) project and contains overrides to the nginx config template specific to [DDEV](https://github.com/drud/ddev). If you are looking for a generalized Docker router solution, we recommend you look there.

Previously this project was also named drud/nginx-proxy, but has been renamed to drud/docker.ddev-router
Previously this project was also named `drud/nginx-proxy`, but has been renamed to `drud/docker.ddev-router`.

## Usage

This container is used to allow all [ddev](https://github.com/drud/ddev) sites to exist side by side on a shared port (typically 80). It serves as a proxy to those sites, and forwards traffic to the appropriate dev site depending on the hostname used.
This container is used to allow all [DDEV](https://github.com/drud/ddev) sites to exist side by side on a shared port (typically 80). It serves as a proxy to those sites, and forwards traffic to the appropriate site depending on the hostname.
4 changes: 2 additions & 2 deletions containers/ddev-ssh-agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ at `fb6822d0003d1c0a795e183f5d257c2540fa74a4`.
[![Pulls](https://img.shields.io/docker/pulls/nardeas/ssh-agent.svg)](https://img.shields.io/docker/pulls/nardeas/ssh-agent.svg?style=flat-square)
[![Size](https://images.microbadger.com/badges/image/nardeas/ssh-agent.svg)](https://microbadger.com/images/nardeas/ssh-agent "Get your own image badge on microbadger.com")

Lets you store your SSH authentication keys in a dockerized ssh-agent that can provide the SSH authentication socket for other containers. Works in OSX and Linux environments.
Lets you store your SSH authentication keys in a dockerized ssh-agent that can provide the SSH authentication socket for other containers. Works in macOS and Linux environments.

## Why?

On OSX you cannot simply forward your authentication socket to a docker container to be able to e.g clone private repositories that you have access to. You don't want to copy your private key to all containers either. The solution is to add your keys only once to a long-lived ssh-agent container that can be used by other containers and stopped when not needed anymore.
On macOS you cannot simply forward your authentication socket to a Docker container to be able to e.g clone private repositories that you have access to. You don't want to copy your private key to all containers either. The solution is to add your keys only once to a long-lived ssh-agent container that can be used by other containers and stopped when not needed anymore.

## hub.docker.com

Expand Down

0 comments on commit a94f9d7

Please sign in to comment.