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 Windows installation docs to use 'Docker Engine' terminology #7092

Merged
merged 5 commits into from
Mar 17, 2025

Conversation

Nick-Hope
Copy link
Contributor

@Nick-Hope Nick-Hope commented Mar 15, 2025

The Issue

The documents for Docker Installation and DDEV Installation refer to "Docker CE". While the package name is still docker-ce, the official name is now 'Docker Engine' (see https://docs.docker.com/engine/). This can be particularly confusing to a newcomer, puzzled by the various terminology for Docker implementation.

How This PR Solves The Issue

Changes the name from 'Docker CE' to 'Docker Engine' and updates links where necessary.

Review at https://ddev--7092.org.readthedocs.build/en/7092/users/install/ddev-installation/#ddev-installation-windows

Release/Deployment Notes

Any external links direct to the heading anchors within the page will be affected. If the PR is merged, I will personally update the link on Drupal documentation from https://www.drupal.org/docs/develop/local-server-setup/windows-development-environment/installing-drupal-with-ddev-in-wsl2-on-windows/installing-docker-ddev-drupal-in-wsl2.

Use official 'Docker Engine' terminology rather than 'Docker CE'.
@Nick-Hope Nick-Hope requested a review from a team as a code owner March 15, 2025 05:48
@Nick-Hope Nick-Hope changed the title Update docker-installation.md to use 'Docker Engine' terminology Update Windows installation docs to use 'Docker Engine' terminology Mar 15, 2025
@Nick-Hope Nick-Hope changed the title Update Windows installation docs to use 'Docker Engine' terminology docs: update Windows installation docs to use 'Docker Engine' terminology Mar 15, 2025
@rfay
Copy link
Member

rfay commented Mar 15, 2025

Thanks for this thoughtful contribution!

Your point is valid, but of course you'll note that the actual installation is sudo apt-get install docker-ce

One reason we use "Docker CE" is that they use "docker engine" for any Docker Desktop usage, including on macOS and Windows. Other Docker Providers don't use "engine" even though that's what they are too.

Let's continue the conversation. We don't want to confuse people, but also Docker's terminology isn't perfect.

What do you think about just adding a note about what "Docker CE" is (The open-source Community Edition of the Docker Engine) ?

Copy link
Member

@rfay rfay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As in the previous note, this can definitely be improved. But shouldn't you be doing the Linux instructions at the same time, since Docker CE in WSL2 is almost completely the same thing as the Linux install.

@@ -149,7 +149,7 @@ Once you’ve [installed a Docker provider](docker-installation.md), you’re re

You can install DDEV on Windows three ways:

1. [Using WSL2 with Docker inside](#wsl2-docker-ce-inside-install-script) **Recommended, best performance, most reliable**
1. [Using WSL2 with Docker Engine](#wsl2-docker-engine-install-script) **Recommended, best performance, most reliable**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Docker inside" is in fact very poor usage here, and we can do better. "Docker Engine" isn't great, because it allows confusion with Docker Desktop, which also has "Docker Engine" in it.

@@ -182,9 +182,9 @@ Once you’ve [installed a Docker provider](docker-installation.md), you’re re
* Installing DDEV inside your distro; this is normally done by running one of the two scripts below, but can be done manually step-by-step as well.
* Verify that your distro uses WSL version 2 with `wsl.exe -l -v`.

### WSL2 + Docker CE Inside Install Script
### WSL2 + Docker Engine Install Script
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "Docker CE" rather than "Docker CE Inside" might be better.

@@ -109,13 +109,13 @@ You’ll need a Docker provider on your system before you can [install DDEV](dde

## Windows

If you’re working inside WSL2, which we recommend, you can [install Docker Engine (docker-ce) inside of it](#docker-ce-inside-windows-wsl2). Otherwise, you can [install Docker Desktop](#docker-desktop-for-windows), which works with both traditional Windows and WSL2.
If you’re working inside WSL2, which we recommend, you can [install Docker Engine (docker-ce) inside of it](#docker-engine-inside-windows-wsl2). Otherwise, you can [install Docker Desktop](#docker-desktop-for-windows), which works with both traditional Windows and WSL2.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is OK, although can use more standardization.

Revert proposed changes from "Docker CE" to "Docker Engine" but clarify terminology.
Revert proposed changes from "Docker CE" to "Docker Engine" but clarify terminology.
@Nick-Hope
Copy link
Contributor Author

@rfay It is difficult because "Docker CE" doesn't really seem to have a home on the web under that name. A Google for "Docker CE" takes you to https://docs.docker.com/engine/install/, which does refer to it as "Docker Engine on Linux, also known as Docker CE". Anyway, I have reverted back to "Docker CE", added clarification about what it is in both documents, and cleaned up a few bits and pieces.

One subtle change is the lower case 'i' in the heading "WSL2 + Docker CE inside Install Script". I remember misguidedly searching for a product called 'Docker CE Inside' at one point.

"But shouldn't you be doing the Linux instructions at the same time, since Docker CE in WSL2 is almost completely the same thing as the Linux install."
I had the same thought but I could not find any references to "Docker CE" in those docs.

@rfay
Copy link
Member

rfay commented Mar 15, 2025

Thanks for the good thinking on this! It is a problem, and glad to see it get some cleaning action.

Copy link
Member

@rfay rfay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome, thanks!


This technique is our favorite, as it uses the most reliable WSL2 Docker provider (`docker-ce`), which is also free and open-source.
This technique is our favorite, as it uses the most reliable WSL2 Docker provider, Docker CE - the free, open-source Community Edition of [Docker Engine](https://docs.docker.com/engine/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this phrasing.

@rfay rfay merged commit 88ccceb into ddev:main Mar 17, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants