Merge pull request #135 from wunderio/feature/WNDR-399

WNDR-399: Update internal documentation

Author: jheinon2021

docs/anatomy_of_a_silta_project.md

@@ -158,11 +158,10 @@ This file is actually not part of the repository, but gets mounted into the runn
 It loads the database credential and additional Silta-specific configuration. You don't need to modify it (you can't), but you need to make sure
 that it gets included from your settings.php.
 
-### Lando configuration file
-This file is not actually needed to deploy a project to Silta, but it configures the project for
-usage in local developemnt environments with Lando. Silta doesn't specify how you should run your code locally, but Lando and Silta have compatible of working.
+### DDEV configuration file
+This file is not required to deploy a project to Silta, but it configures the project for use in local development environments with DDEV. Silta does not specify how you should run your code locally, but DDEV and Silta are compatible ways of working.
 
-There is no plan to consolidate Silta and Lando, as they have very different requirements (for example Lando mounts the codebase as a volume, whereas Silta copies it into dedicated Docker images). 
+There is no plan to consolidate Silta and DDEV, as they have very different requirements (for example, DDEV mounts the codebase as a volume, whereas Silta copies it into dedicated Docker images).
 
 ### phpcs.xml
 This file is also not required for Silta, but we use phpcs for validation by default.

docs/creating_a_new_project.md

@@ -6,10 +6,10 @@ title: Creating a new project
 
 - Make a copy of Wunder's [drupal-project](https://github.com/wunderio/drupal-project), and push it as a new repository within the wunderio Github organisation.
 - Setup your project:
-    - Run your project locally with [lando](https://docs.devwithlando.io): `lando start` (follow local environment setup instructions at https://github.com/wunderio/drupal-project#setup)  
-    - Install composer dependencies with `lando composer install` and commit composer.lock and generated files in the `web` folder. If Drupal adds additional database credentials in settings.php, these should not be committed and can be discarded.
+    - Run your project locally with [DDEV](https://docs.ddev.com/en/stable/): `ddev start` (follow local environment setup instructions at https://github.com/wunderio/drupal-project#setup)  
+    - Install composer dependencies with `ddev composer install` and commit composer.lock and generated files in the `web` folder. If Drupal adds additional database credentials in settings.php, these should not be committed and can be discarded.
     - Install javascript dependencies with `npm install` and commit the package-lock.json file.
-    - Install Drupal with `lando drush site-install` and export the default configuration with `lando drush config-export`.
+    - Install Drupal with `ddev drush site-install` / `ddev drush si` and export the default configuration with `ddev drush config-export` / `ddev drush cex`.
 - Log in to CircleCI with your Github credentials, select "wunderio" and [enable your project](https://circleci.com/add-projects/gh/wunderio).
 - Watch your project build, the CircleCI output has a link to your deployed environment.
 

docs/migrating_existing_project.md

@@ -17,20 +17,8 @@ title: Migrating an existing Drupal project
    ```bash
    curl -s https://raw.githubusercontent.com/wunderio/silta/master/scripts/drupal-migrate.sh | bash
    ```
-   For Drupal 7 with composer.json run      
-   ```bash
-   curl -s https://raw.githubusercontent.com/wunderio/silta/master/scripts/drupal7-migrate.sh | bash
-   ```
-   Please check [troubleshooting](troubleshooting.md) for other Drupal 7 cases  
-   
-   Migration script will create `.circleci/config.yml` file for CircleCI builds. You might need to adapt branch names or contexts.
 
-   **Important**  
-   Add this to silta.yml config if You use Drupal 7 
-   ```yaml
-   php:
-     drupalCoreVersion: "7"
-   ```
+   Migration script will create `.circleci/config.yml` file for CircleCI builds. You might need to adapt branch names or contexts.
 
 1. Read through the output of the script and check for any instructions to perform manual steps.
 
@@ -60,40 +48,4 @@ title: Migrating an existing Drupal project
    This is the _reference environment_ by default, meaning that new environments
    will be created with a copy of this content.
 
-1. Congratulations, your project is now up and running! Please share any issues you had or ideas for improvements.
-
-## Drupal 7 migration tips
-
-### Project uses make file for builds  
-Have something like this in .circleci/config.yml
-```yaml
-codebase-build:
-   - run:
-      name: Build from makefile
-      command: |
-         composer install
-         vendor/drush/drush/drush make ~/project/drupal/conf/site.make ~/project/drupal/web/
-         mkdir -p web/sites/all/modules
-         cp -r code/modules/custom web/sites/all/modules/
-```
-
-### Missing drush
-Add composer.json in Drupal folder
-```json
-{
-    "require": {
-        "drush/drush": "8.*"
-    },
-    "extra": {
-        "installer-paths": {
-            "web/": ["type:drupal-core"]
-        }
-    }
-}
-```
-
-And then in .circleci/config.yml add
-```yaml
-command: |
-   composer install
-```
+1. Congratulations, your project is now up and running! Please share any issues you had or ideas for improvements.

docs/troubleshooting.md

@@ -275,7 +275,7 @@ Some known references are:
 - `composer.json` & `composer.lock`
 - `.dockerignore`
 - `.gitignore`
-- `.lando.yml`
+- `.ddev/config.yaml`
 - `grumphp.yml`
 - `phpcs.xml`
 

scripts/drupal-migrate.sh

@@ -4,31 +4,51 @@ echo "This script will convert your Drupal project to be compatible with Silta."
 echo "Make sure you are in the git root of your project."
 
 echo "Checking dependencies"
+if ! command -v git >/dev/null 2>&1; then
+  echo "git not found. Please install git first."
+  exit 1
+fi
+
 git --version
-composer --version
 
-if  grep -q "drupal/core" "drupal/composer.json" ; then
-         echo 'Drupal 8+ detected' ;
+if command -v composer >/dev/null 2>&1; then
+  composer --version
+else
+  echo "composer not found. Continuing, but some generated build steps may need composer."
+fi
+
+drupal_root=""
+
+if [ -f composer.json ] && grep -q "drupal/core" composer.json; then
+  drupal_root="."
+elif [ -f drupal/composer.json ] && grep -q "drupal/core" drupal/composer.json; then
+  drupal_root="drupal"
 else
-         echo 'Unsupported Drupal version. Please follow documentation how to migrate projects' ;
-         exit ;
+  composer_path=$(find . -name composer.json -not -path "*vendor*" -not -path "*modules*" -not -path "*core*" -not -path "*test*" | head -n 1)
+  if [ -n "$composer_path" ] && grep -q "drupal/core" "$composer_path"; then
+    drupal_root=$(dirname "$composer_path")
+  fi
+fi
+
+if [ -z "$drupal_root" ]; then
+  echo "Unsupported Drupal version or composer.json not found. Please follow documentation how to migrate projects"
+  exit 1
 fi
 
+echo "Drupal 8+ detected in $drupal_root"
+
 mkdir -p .circleci
 
-if [ -f drupal/composer.json ] && [ -f drupal/build.sh ]
+if [ -f "$drupal_root/composer.json" ] && [ -f "$drupal_root/build.sh" ]
 then
   echo "This looks like a D8 Wundertools project."
-  drupal_root="drupal"
   echo "Adding Wunderools CircleCI configuration"
   curl -s https://raw.githubusercontent.com/wunderio/Wundertools/master/.circleci/config.yml > .circleci/config.yml
 else
   echo "Adding standard CircleCI configuration"
   curl -s https://raw.githubusercontent.com/wunderio/drupal-project/master/.circleci/config.yml > .circleci/config.yml
 
-  # Try to detect the default path
-  composer_path=`find . -name composer.json -not -path "*vendor*" -not -path "*modules*" -not -path "*core*" -not -path "*test*"`
-  drupal_root_guess=`dirname $composer_path`
+  drupal_root_guess="$drupal_root"
 
   while ! [[ $drupal_root ]] || ! [ -d $drupal_root ]
   do
@@ -46,7 +66,7 @@ else
   done
 fi
 
-cd $drupal_root
+cd "$drupal_root"
 
 echo "Adding Dockerfiles"
 mkdir -p silta
@@ -70,11 +90,11 @@ else
   echo "Your existing phpcs configuration was kept."
 fi
 
-if [ ! -f .lando.yml ]; then
-  echo "Adding our standard .lando.yml"
-  curl -s https://raw.githubusercontent.com/wunderio/drupal-project/master/.lando.yml > .lando.yml
+if [ ! -f .ddev/config.yal ]; then
+  echo "Adding our standard .ddev/config.yaml"
+  curl -s https://raw.githubusercontent.com/wunderio/drupal-project/master/.ddev/config.yaml > .ddev/config.yaml
 else
-  echo "Your existing lando configuration was kept."
+  echo "Your existing DDEV configuration was kept."
 fi
 
 if [ -f composer.json ]; then
@@ -90,18 +110,18 @@ else
   echo "You don't seem to be using composer, this is currently not supported out of the box."
 fi
 
-if ! grep -q "settings.lando.php" web/sites/default/settings.php
+if ! grep -q "settings.ddev.php" web/sites/default/settings.php
 then
   echo '
 /**
- * Lando configuration overrides.
+ * DDEV configuration overrides.
  */
-if (getenv("LANDO_INFO") && file_exists($app_root . "/" . $site_path . "/settings.lando.php")) {
-  include $app_root . "/" . $site_path . "/settings.lando.php";
+if (getenv("DDEV_INFO") && file_exists($app_root . "/" . $site_path . "/settings.ddev.php")) {
+  include $app_root . "/" . $site_path . "/settings.ddev.php";
 }
 ' >>  web/sites/default/settings.php
 fi
-curl -s https://raw.githubusercontent.com/wunderio/drupal-project/master/web/sites/default/settings.lando.php > web/sites/default/settings.lando.php
+curl -s https://raw.githubusercontent.com/wunderio/drupal-project/master/web/sites/default/settings.php > web/sites/default/settings.php
 
 echo "Updating settings.php"
 if ! grep -q "settings.silta.php" web/sites/default/settings.php