DDEV-documentation: DDEV integration document #455
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for upgrading from Lando to DDEV as the local development environment for Wunder's Drupal projects.
- Introduces a new upgrade guide covering DDEV installation, project setup, and migration of Lando tooling to DDEV commands
- Creates a documentation index to organize project documentation
- Updates the main README to reference the new documentation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| docs/rollout-lando-to-ddev-upgrade.md | Complete migration guide with installation instructions, project setup steps, and command conversion examples |
| docs/README.md | New documentation index page listing available upgrade guides |
| README.md | Adds reference to docs/README.md for upgrade guides and documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| sudo sh -c 'echo ""' | ||
| sudo apt-get update && sudo apt-get install -y curl | ||
| sudo install -m 0755 -d /etc/apt/keyrings | ||
| curl -fsSL https://pkg.ddev.com/apt/gpg.key | gpg --dearmor | sudo tee /etc/apt/keyrings/ddev.gpg > /dev/null | ||
| sudo chmod a+r /etc/apt/keyrings/ddev.gpg | ||
|
|
||
| # Add DDEV releases to your package repository | ||
| sudo sh -c 'echo ""' | ||
| echo "deb [signed-by=/etc/apt/keyrings/ddev.gpg] https://pkg.ddev.com/apt/ * *" | sudo tee /etc/apt/sources.list.d/ddev.list >/dev/null | ||
|
|
||
| # Update package information and install DDEV | ||
| sudo sh -c 'echo ""' |
There was a problem hiding this comment.
These sudo sh -c 'echo \"\"' commands on lines 17, 24, and 28 appear to serve no functional purpose. They echo empty strings and should be removed to improve clarity and reduce confusion in the installation instructions.
| sudo sh -c 'echo ""' | |
| sudo apt-get update && sudo apt-get install -y curl | |
| sudo install -m 0755 -d /etc/apt/keyrings | |
| curl -fsSL https://pkg.ddev.com/apt/gpg.key | gpg --dearmor | sudo tee /etc/apt/keyrings/ddev.gpg > /dev/null | |
| sudo chmod a+r /etc/apt/keyrings/ddev.gpg | |
| # Add DDEV releases to your package repository | |
| sudo sh -c 'echo ""' | |
| echo "deb [signed-by=/etc/apt/keyrings/ddev.gpg] https://pkg.ddev.com/apt/ * *" | sudo tee /etc/apt/sources.list.d/ddev.list >/dev/null | |
| # Update package information and install DDEV | |
| sudo sh -c 'echo ""' | |
| sudo apt-get update && sudo apt-get install -y curl | |
| sudo install -m 0755 -d /etc/apt/keyrings | |
| curl -fsSL https://pkg.ddev.com/apt/gpg.key | gpg --dearmor | sudo tee /etc/apt/keyrings/ddev.gpg > /dev/null | |
| sudo chmod a+r /etc/apt/keyrings/ddev.gpg | |
| # Add DDEV releases to your package repository | |
| echo "deb [signed-by=/etc/apt/keyrings/ddev.gpg] https://pkg.ddev.com/apt/ * *" | sudo tee /etc/apt/sources.list.d/ddev.list >/dev/null | |
| # Update package information and install DDEV |
| ```shell | ||
| # Download and run the install script | ||
| curl -fsSL https://ddev.com/install.sh | bash | ||
| ddev start |
There was a problem hiding this comment.
The ddev start command appears out of context here. It should not be part of the installation script section, as it requires a configured project directory. Consider removing this line or clarifying that it's a separate step to be run after project configuration.
| ddev start |
| ## 2. Setting up the DDEV for a project | ||
|
|
||
| #### Set up the DDEV for your project. | ||
| Setting up the DDEV for your project as a local development environment is a little trickier than the installation. Ensure the root of your actual Drupal project, as depending on the project, it might not be in the actual root of the project, but, e.g., in a subdirectory called `drupal/`. |
There was a problem hiding this comment.
The sentence is grammatically incorrect. 'Ensure the root' should be 'Ensure you're in the root' or 'Locate the root'.
| Setting up the DDEV for your project as a local development environment is a little trickier than the installation. Ensure the root of your actual Drupal project, as depending on the project, it might not be in the actual root of the project, but, e.g., in a subdirectory called `drupal/`. | |
| Setting up the DDEV for your project as a local development environment is a little trickier than the installation. Ensure you're in the root of your actual Drupal project, as depending on the project, it might not be in the actual root of the project, but, e.g., in a subdirectory called `drupal/`. |
| 1. To commence, `cd` into the existing project directory. Ensure that you’re in the actual Drupal root, as this might not always be the root of the project. | ||
| 2. Run `ddev config` to initialize a DDEV project. | ||
| 3. Run `ddev start` to spin up the project. | ||
| 4. Run `ddev launch` to launch the project in a web browser. This is the same command as `lando start` in Lando environment. |
There was a problem hiding this comment.
This statement is incorrect. The documentation states that ddev launch is the same as lando start, but ddev launch opens a web browser while lando start starts the environment. The correct equivalent to lando start is ddev start, not ddev launch.
| 4. Run `ddev launch` to launch the project in a web browser. This is the same command as `lando start` in Lando environment. | |
| 4. (Optional) Run `ddev launch` to open the project in a web browser. |
| img 2 goes here | ||
|
|
There was a problem hiding this comment.
Placeholder text for images should be replaced with actual images or removed before finalizing the documentation.
| img 2 goes here |
| img 3 goes here | ||
|
|
There was a problem hiding this comment.
Placeholder text for images should be replaced with actual images or removed before finalizing the documentation.
| img 3 goes here |
|
|
||
| In order for you to integrate these to DDEV environment, you just need to copy the sh-files from the lando folder to your DDEV commands folder. Please take a look at the next 2 screenshots from Raisio project: | ||
|
|
||
| img 4 goes here |
There was a problem hiding this comment.
Placeholder text for images should be replaced with actual images or removed before finalizing the documentation.
| img 4 goes here |
| ### 3.2 sh-files in Lando and in DDEV | ||
| In Lando projects, there might be custom sh or bash files that contain custom commands to perform different actions, e.g. database synchronisation from the cloud environment. | ||
|
|
||
| In order for you to integrate these to DDEV environment, you just need to copy the sh-files from the lando folder to your DDEV commands folder. Please take a look at the next 2 screenshots from Raisio project: |
There was a problem hiding this comment.
The phrase 'integrate these to DDEV environment' is grammatically incorrect. It should be 'integrate these into the DDEV environment' or 'integrate these with the DDEV environment'.
| In order for you to integrate these to DDEV environment, you just need to copy the sh-files from the lando folder to your DDEV commands folder. Please take a look at the next 2 screenshots from Raisio project: | |
| In order for you to integrate these into the DDEV environment, you just need to copy the sh-files from the lando folder to your DDEV commands folder. Please take a look at the next 2 screenshots from Raisio project: |
| drush search-api:rebuild-tracker | ||
|
|
||
| # # Index all search items. | ||
| drush search-api:index |
There was a problem hiding this comment.
There is trailing whitespace at the end of line 159. This should be removed for consistency.
Rollout - Lando to DDEV upgrade documentation
original document - Rollout - Lando to DDEV upgrade documentation
Changes
addBadDataProviderandaddDataProviderto be static functions.Testing
https://app.circleci.com/pipelines/github/wunderio/drupal-project?branch=feature%2FDDEV-documentation
Enviroment: [Feature environment URL]
Login: [
drush ulicommand]Instructions: