diff options
Diffstat (limited to 'doc/src/usage')
| -rw-r--r-- | doc/src/usage/README.md | 8 | ||||
| -rw-r--r-- | doc/src/usage/ddev-commands.md | 7 | ||||
| -rw-r--r-- | doc/src/usage/ddev-composer.md | 14 | ||||
| -rw-r--r-- | doc/src/usage/ddev-delete.md | 14 | ||||
| -rw-r--r-- | doc/src/usage/ddev-phpunit.md | 27 | ||||
| -rw-r--r-- | doc/src/usage/ddev-restart.md | 9 | ||||
| -rw-r--r-- | doc/src/usage/ddev-start.md | 9 | ||||
| -rw-r--r-- | doc/src/usage/ddev-status.md | 9 | ||||
| -rw-r--r-- | doc/src/usage/ddev-stop.md | 9 | ||||
| -rw-r--r-- | doc/src/usage/testing/README.md | 1 |
10 files changed, 107 insertions, 0 deletions
diff --git a/doc/src/usage/README.md b/doc/src/usage/README.md new file mode 100644 index 0000000..3e29683 --- /dev/null +++ b/doc/src/usage/README.md @@ -0,0 +1,8 @@ +# Usage + +Once the ddev environment is started, you can interact with the hub as normal. + +Any changes you do to the source files under the `core` directory, should be +immediately active in the environment. This makes it really convenient to work +on everything from translations, documentation, and even code changes, +features, new addons etc. diff --git a/doc/src/usage/ddev-commands.md b/doc/src/usage/ddev-commands.md new file mode 100644 index 0000000..e293308 --- /dev/null +++ b/doc/src/usage/ddev-commands.md @@ -0,0 +1,7 @@ +# Useful DDEV commands + +DDEV provides out of the box a few convenient commands that can help with some common tasks. In addition we have added a few commands of our own that will be useful when working on Hubzilla. + +We will only document the most common of the built in commands in this guide, but see the [DDEV documentation] for the full list. + +[DDEV documentation]: https://ddev.readthedocs.io/en/stable/users/usage/commands/ diff --git a/doc/src/usage/ddev-composer.md b/doc/src/usage/ddev-composer.md new file mode 100644 index 0000000..d99ddea --- /dev/null +++ b/doc/src/usage/ddev-composer.md @@ -0,0 +1,14 @@ +# ddev composer + +This command works just like the regular composer command, except it runs in the web container. + +**Example:** Install all the dependencies of the project in the web container. + +```bash +$ ddev composer install +``` + + +It is recommended to always run composer via ddev, as this ensures that the +dependencies installed works with the version of PHP that is being used by the +container. This may be different from what is installed on the host system. diff --git a/doc/src/usage/ddev-delete.md b/doc/src/usage/ddev-delete.md new file mode 100644 index 0000000..678e8da --- /dev/null +++ b/doc/src/usage/ddev-delete.md @@ -0,0 +1,14 @@ +# ddev delere + +Delete the environment and the containers completely. + +Any changes you have made to the file system is kept, but the database etc is destroyed. + +The `--omit-snapshots` argument, if specified, tells DDEV to _not_ keep a dump of +the database content for later. If you want it to dump the database so you can +load it back at a later time, don't use this argument. + +**Example:** +```bash +$ ddev delete --omit-snapshot +``` diff --git a/doc/src/usage/ddev-phpunit.md b/doc/src/usage/ddev-phpunit.md new file mode 100644 index 0000000..40b9fcc --- /dev/null +++ b/doc/src/usage/ddev-phpunit.md @@ -0,0 +1,27 @@ +# ddev phpunit + +Runs the unit tests in the web container. + +**Example:** Run the unit tests: +```bash +$ ddev phpunit +``` + +Any additional args[^note] will be passed to the PHPUnit executable in the container: + +**Example:** Run only tests with names mathcing "Access": +```bash +$ ddev phpunit --filter Access +``` + +The command has several special subcommand for common tasks: + +- `ddev phpunit coverage` to generate coverage reports. +- `ddev phpunit debug` to enable step debugging. +- `ddev phpunit provile` to generate profiling info. + +These subcommands will be further described elsewhere. + +This command is provided by the Hubzilla DDEV environment. + +[^note]:Except the special commands as noted below. diff --git a/doc/src/usage/ddev-restart.md b/doc/src/usage/ddev-restart.md new file mode 100644 index 0000000..57d570b --- /dev/null +++ b/doc/src/usage/ddev-restart.md @@ -0,0 +1,9 @@ +# ddev restart + +Restart the environment. Just the same as running `ddev stop` immediately followed by `ddev start`. +This can be useful if you have made changes the DDEV configuration etc. + +**Example:** +```bash +$ ddev restart +``` diff --git a/doc/src/usage/ddev-start.md b/doc/src/usage/ddev-start.md new file mode 100644 index 0000000..49ef271 --- /dev/null +++ b/doc/src/usage/ddev-start.md @@ -0,0 +1,9 @@ +# ddev start + +Starts the environment and boots all the conteiner. This works both to start a +previously stopped environment, and to start the environment the first time. + +**Example:** +```bash +$ ddev start +``` diff --git a/doc/src/usage/ddev-status.md b/doc/src/usage/ddev-status.md new file mode 100644 index 0000000..f4faac1 --- /dev/null +++ b/doc/src/usage/ddev-status.md @@ -0,0 +1,9 @@ +# ddev status + +Displays the status of all containers in the environment, including internal +and external addresses, domains and ports to the terminal. + +**Example:** +```bash +$ ddev status +``` diff --git a/doc/src/usage/ddev-stop.md b/doc/src/usage/ddev-stop.md new file mode 100644 index 0000000..9822f61 --- /dev/null +++ b/doc/src/usage/ddev-stop.md @@ -0,0 +1,9 @@ +# ddev stop + +Stops the environment and all the containers. Useful when you're done with +your session for now, but may want to continue at a later time. + +**Example:** +```bash +$ ddev stop +``` diff --git a/doc/src/usage/testing/README.md b/doc/src/usage/testing/README.md new file mode 100644 index 0000000..f00b526 --- /dev/null +++ b/doc/src/usage/testing/README.md @@ -0,0 +1 @@ +# Testing |