Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update faq with new questions, fix menus #5924

Merged
merged 11 commits into from
Mar 4, 2024
1 change: 1 addition & 0 deletions .spellcheckwordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ Flags
Flatpak
FQDNs
Fritzbox
GitLab
GUI
GUIs
Get
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ mkdocs-serve:
if command -v mkdocs >/dev/null ; then \
mkdocs serve; \
else \
docker run -it -p 8000:8000 -v "${PWD}:/docs" -e "ADD_MODULES=mkdocs-material mkdocs-redirects mkdocs-minify-plugin mdx_truly_sane_lists mkdocs-git-revision-date-localized-plugin" -e "LIVE_RELOAD_SUPPORT=true" -e "FAST_MODE=true" -e "DOCS_DIRECTORY=./docs" polinux/mkdocs:1.2.3; \
docker run -it --rm -p 8000:8000 -v "${PWD}:/docs" -e "ADD_MODULES=mkdocs-material mkdocs-redirects mkdocs-minify-plugin mdx_truly_sane_lists mkdocs-git-revision-date-localized-plugin" -e "LIVE_RELOAD_SUPPORT=true" -e "FAST_MODE=true" -e "DOCS_DIRECTORY=./docs" polinux/mkdocs:1.2.3; \
fi

# Install markdown-link-check locally with "npm install -g markdown-link-check"
Expand Down
2 changes: 2 additions & 0 deletions docs/content/users/providers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

DDEV offers hosting provider integration and sample integrations for [Pantheon](https://pantheon.io), [Platform.sh](https://platform.sh) and [Acquia](https://www.acquia.com) hosting, along with other examples.

Hosting provider integration allows connecting with your upstream hosting. `ddev pull <provider>` downloads and `ddev push <provider>` uploads the **database** and the **user-generated files** to an upstream provider. It does *not* push (deploy) or pull your code. Your code should be under version control in for example Git.

DDEV provides ready-to-go integrations for Platform.sh, Acquia, and Lagoon in every project, see the .ddev/providers directory. These can be used as is, or they can be modified as you see fit (but remove the `#ddev-generated` line so DDEV doesn't replace them with the defaults).

In addition, each project includes [example recipes](https://github.com/ddev/ddev/tree/master/pkg/ddevapp/dotddev_assets/providers) for Pantheon, Git, local files, and `rsync` in its `.ddev/providers` directory, which you can use and adapt however you’d like.
Expand Down
8 changes: 8 additions & 0 deletions docs/content/users/topics/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Hosting, Deployment, and Sharing

DDEV does not provide capabilities for deploying your code, as it's focused on being a **local development** solution. Teams almost universally use Git to manage their code and some Git provider like GitHub or GitLab to store it. They use many different types of deployment tools to actually get the code to their upstream servers or integration environments. For local development, DDEV provides capabilities to pull upstream databases and user-generated files as well as push those in some circumstances.

* [Sharing your project](sharing.md)
* [Casual hosting with DDEV](hosting.md)
* [Remote Docker environments](remote-docker.md)
* [Hosting integrations](../providers/index.md) including Acquia, Lagoon, Pantheon, Platform.sh, Upsun, rsync-based solutions, Git-based solutions, local files (like Dropbox), etc.
41 changes: 28 additions & 13 deletions docs/content/users/usage/faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 2
---

# FAQ

Frequently-asked questions organized into high-level functionality, investigating issues, daily usage, and connecting with our community.
Expand All @@ -6,21 +11,29 @@ Frequently-asked questions organized into high-level functionality, investigatin

### What operating systems will DDEV work with?

DDEV works nearly anywhere Docker will run, including macOS, Windows 10/11 Pro/Enterprise and Home, and every Linux variant we’ve ever tried. It also runs in many Linux-like environments, like ChromeOS (in Linux machine) and Windows 10/11’s WSL2. DDEV works the same on each of these platforms since the important work is done inside identical Docker containers.
DDEV works nearly anywhere Docker will run, including macOS, WSL2, Windows 10/11 Pro/Enterprise and Home, and every Linux variant we’ve ever tried. It also runs in many Linux-like environments, like ChromeOS (in Linux machine). DDEV works the same on each of these platforms since the important work is done inside identical Docker containers. This means that a team using diverse environments can share everything just fine.

### Does DDEV change or deploy my code?

You are responsible for your code and its deployment. DDEV does not alter any code or fix any bugs in it. DDEV *does* add DDEV-specific settings for some CMSes if the [settings management](cms-settings.md) is enabled. These items are excluded by `.gitignore` so they won't affect a deployed project, but in most cases they would do no harm if deployed, because they check to see if they're running in DDEV context.

### Are there alternate Docker providers I can use?
### Where is my database stored in my DDEV project?

Many users report good results with alternate Docker providers.
The MariaDB, MySQL, or PostgreSQL database for your project lives in a Docker volume, which means it does not appear in your DDEV project's filesystem, and is not checked in. This configuration is for performance and portability reasons, but it means that if you change Docker providers or do a factory reset on your Docker provider, you will lose databases. By default many Docker providers do not keep Docker volumes where they are backed up by normal backup solutions. Remember to keep backups using `ddev export-db` or `ddev snapshot`. See [#How can I migrate from one Docker provider to another](#how-can-i-migrate-from-one-docker-provider-to-another).
stasadev marked this conversation as resolved.
Show resolved Hide resolved

| Docker Provider | Support Level |
|----------------------------|----------------------------------------------------------------------------|
| OrbStack (macOS) | officially tested and supported on macOS |
| Docker Desktop for Mac | officially tested and supported on both Intel and Apple Silicon |
| Docker Desktop for Windows | officially tested and supported on WSL2 and traditional Windows |
| Colima (macOS) | officially tested and supported |
| Colima (Linux) | reported working in DDEV v1.22.2+, but poor solution compared to docker-ce |
| docker-ce (Linux/WSL2) | Officially supported with automated tests on WSL2/Ubuntu |
| Rancher Desktop (macOS) | officially tested and supported on macOS |
### What Docker providers can I use?

We have automated testing and support for a staggering range of Docker providers.

| Docker Provider | Support Level |
|----------------------------|--------------------------------------------------------------------------|
| OrbStack (macOS) | officially tested and supported on macOS |
| Docker Desktop for Mac | officially tested and supported on both Intel and Apple Silicon |
| Docker Desktop for Windows | officially tested and supported on WSL2 and traditional Windows |
| Colima (macOS) | officially tested and supported |
| Colima (Linux) | reported working in DDEV v1.22+, but poor solution compared to docker-ce |
| docker-ce (Linux/WSL2) | Officially supported with automated tests on WSL2/Ubuntu |
| Rancher Desktop (macOS) | officially tested and supported on macOS |

* Docker Desktop for Linux does *not* work with DDEV because it mounts all files into the container owned as root.
* Rancher Desktop for Windows does not work with DDEV.
Expand All @@ -42,7 +55,9 @@ Check out [this Stack Overflow answer](https://stackoverflow.com/a/69964995/8972

### Do I need to install PHP, Composer, nginx, or Node.js/npm on my workstation?

No. These tools live inside DDEV’s Docker containers, so you only need to [install Docker](../install/docker-installation.md) and [install DDEV](../install/ddev-installation.md). This is especially handy for Windows users where there’s more friction getting these things installed.
No. Tools like PHP, Composer, nginx, and Node.js/npm live inside DDEV’s Docker containers, so you only need to [install Docker](../install/docker-installation.md) and [install DDEV](../install/ddev-installation.md).

For most users we recommend that you do *not* install PHP or composer on your workstation, so you get in the habit of using `ddev composer`, which will use the configured composer and PHP versions for your project, which can be different for each project. See [DDEV and Composer](developer-tools.md#ddev-and-composer).

### Do I lose data when I run `ddev poweroff`, `ddev stop`, or `ddev restart`?

Expand Down
10 changes: 5 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -196,12 +196,12 @@ nav:
- users/debugging-profiling/xhprof-profiling.md
- users/debugging-profiling/xdebug-profiling.md
- 'Hosting & Deployment':
- users/providers/index.md
- 'Beyond Local':
- users/topics/sharing.md
- users/topics/hosting.md
- users/topics/remote-docker.md
- users/topics/index.md
- users/topics/sharing.md
- users/topics/hosting.md
- users/topics/remote-docker.md
- 'Hosting Provider Integrations':
- users/providers/index.md
- 'Acquia': users/providers/acquia.md
- 'Lagoon': users/providers/lagoon.md
- 'Pantheon': users/providers/pantheon.md
Expand Down