From 54344bdd84c960eff8348df2b03693de734d3a38 Mon Sep 17 00:00:00 2001 From: Aaron Feledy Date: Wed, 15 Jan 2025 13:25:57 -0600 Subject: [PATCH 1/3] add Drupal CMS to getting started docs --- CHANGELOG.md | 2 ++ docs/getting-started.md | 23 +++++++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index f7b58a8..8b99a07 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,8 @@ ## {{ UNRELEASED_VERSION }} - [{{ UNRELEASED_DATE }}]({{ UNRELEASED_LINK }}) * Updated globally installed Drush to `v8.5.0`. +* Added `Drupal CMS` instructions to the Getting Started docs. + * Updated to [@lando/php@1.7.1](https://github.com/lando/php/releases/tag/v1.7.1). * Updated to [@lando/mysql@1.5.0](https://github.com/lando/mysql/releases/tag/v1.5.0). diff --git a/docs/getting-started.md b/docs/getting-started.md index 66e4658..4bf44e6 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -46,6 +46,29 @@ lando drush site:install --db-url=mysql://drupal11:drupal11@database/drupal11 -y lando info ``` +```bash:no-line-numbers [DRUPAL CMS] +# Initialize a drupal11 recipe +mkdir my-drupalcms-app \ + && cd my-drupalcms-app \ + && lando init \ + --source cwd \ + --recipe drupal11 \ + --webroot web \ + --name my-drupalcms-app + +# Start the environment +lando start + +# Create latest Drupal CMS project via composer +lando composer create-project drupal/cms tmp && cp -r tmp/. . && rm -rf tmp + +# Install drupal +lando drush site:install --db-url=mysql://drupal11:drupal11@database/drupal11 -y + +# List information about this app +lando info +``` + ```bash:no-line-numbers [DRUPAL 10] # Initialize a drupal10 recipe mkdir my-first-drupal10-app \ From 4c5e4c12cd6d7850f30ce01b56b4943497b8340a Mon Sep 17 00:00:00 2001 From: Aaron Feledy Date: Wed, 15 Jan 2025 13:39:35 -0600 Subject: [PATCH 2/3] drupal.org rate limiting is fairly strict --- netlify.toml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/netlify.toml b/netlify.toml index 75ab042..99fed5a 100644 --- a/netlify.toml +++ b/netlify.toml @@ -10,7 +10,14 @@ [[context.deploy-preview.plugins]] package = "netlify-plugin-checklinks" [context.deploy-preview.plugins.inputs] - todoPatterns = [ "load", "CHANGELOG.html", "x.com", "twitter.com", "/v/" ] + todoPatterns = [ + "load", + "CHANGELOG.html", + "x.com", + "twitter.com", + "https://www.drupal.org", + "/v/" + ] skipPatterns = [ ".rss", ".gif", ".jpg" ] checkExternal = true From 8d7c7a79db396a21a4462314699a68841f23e950 Mon Sep 17 00:00:00 2001 From: Aaron Feledy Date: Wed, 15 Jan 2025 17:28:56 -0600 Subject: [PATCH 3/3] drupal cms guide --- CHANGELOG.md | 3 +- docs/config.md | 6 +- docs/getting-started.md | 2 +- docs/guides/drupal-cms.md | 175 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 182 insertions(+), 4 deletions(-) create mode 100644 docs/guides/drupal-cms.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 8b99a07..f47f0e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,7 @@ ## {{ UNRELEASED_VERSION }} - [{{ UNRELEASED_DATE }}]({{ UNRELEASED_LINK }}) * Updated globally installed Drush to `v8.5.0`. -* Added `Drupal CMS` instructions to the Getting Started docs. - +* Added docs for setting up [Drupal CMS](https://drupal.org/docs/drupal-cms). * Updated to [@lando/php@1.7.1](https://github.com/lando/php/releases/tag/v1.7.1). * Updated to [@lando/mysql@1.5.0](https://github.com/lando/mysql/releases/tag/v1.5.0). diff --git a/docs/config.md b/docs/config.md index 8ae697e..e6bde08 100644 --- a/docs/config.md +++ b/docs/config.md @@ -26,7 +26,11 @@ config: vhosts: SEE BELOW ``` -Note that if the above config options are not enough all Lando recipes can be further [extended and overriden](https://docs.lando.dev/landofile/recipes.html#extending-and-overriding-recipes). +Note that if the above config options are not enough, all Lando recipes can be further [extended and overriden](https://docs.lando.dev/landofile/recipes.html#extending-and-overriding-recipes). + +::: tip Applying Configuration Changes +After making changes to service configurations, you'll need to run `lando rebuild` for the changes to take effect. This rebuilds your app's services with the new configuration. +::: ## Choosing a Drupal version diff --git a/docs/getting-started.md b/docs/getting-started.md index 4bf44e6..874dbc1 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -63,7 +63,7 @@ lando start lando composer create-project drupal/cms tmp && cp -r tmp/. . && rm -rf tmp # Install drupal -lando drush site:install --db-url=mysql://drupal11:drupal11@database/drupal11 -y +lando drush site:install recipes/drupal_cms_starter --db-url=mysql://drupal11:drupal11@database/drupal11 -y # List information about this app lando info diff --git a/docs/guides/drupal-cms.md b/docs/guides/drupal-cms.md new file mode 100644 index 0000000..67fcb8e --- /dev/null +++ b/docs/guides/drupal-cms.md @@ -0,0 +1,175 @@ +--- +title: Installing Drupal CMS Locally with Lando +description: This guide will walk you through setting up Drupal CMS locally for development using Lando + +authors: + - name: Aaron Feledy + pic: https://avatars.githubusercontent.com/u/1000487 + link: https://x.com/aaronfeledy +--- + +# Installing Drupal CMS with Lando + +[Drupal CMS](https://drupal.org/drupal-cms) is a new product that puts the power of Drupal into the hands of marketers, designers and content creators. It's built on Drupal 11 and comes with smart defaults and AI-powered features to help you launch your site quickly. + +This guide will walk you through setting up Drupal CMS locally for development using Lando. + +
+TLDR; Quick Install Commands + +::: code-group + +```bash:no-line-numbers [Bash] +# Prompt for app name (or change this line to set it directly) +read -p "Enter your app name [my-drupalcms-app]: " APP_NAME +APP_NAME=${APP_NAME:-my-drupalcms-app} # Default if no input provided + +# Create and initialize project +mkdir $APP_NAME \ + && cd $APP_NAME \ + && lando init \ + --source cwd \ + --recipe drupal11 \ + --webroot web \ + --name $APP_NAME + +# Start environment and install Drupal CMS +lando start +lando composer create-project drupal/cms tmp && cp -r tmp/. . && rm -rf tmp +lando drush site:install recipes/drupal_cms_starter --db-url=mysql://drupal11:drupal11@database/drupal11 -y + +# Get site URL to login +lando drush user:login /admin/dashboard/welcome --uri="$(lando info -s appserver --path 'urls[1]' | tr -d '\n' | tr -d "'")" +``` + +```powershell:no-line-numbers [PowerShell] +# Prompt for app name (or change this line to set it directly) +$APP_NAME = Read-Host "Enter your app name [my-drupalcms-app]: " +if ([string]::IsNullOrWhiteSpace($APP_NAME)) { $APP_NAME = "my-drupalcms-app" } + +# Create and initialize project +mkdir $APP_NAME; ` +cd $APP_NAME; ` +lando init ` + --source cwd ` + --recipe drupal11 ` + --webroot web ` + --name $APP_NAME + +# Start environment and install Drupal CMS +lando start +lando composer create-project drupal/cms tmp; cp -r tmp/* .; rm -rf tmp +lando drush site:install recipes/drupal_cms_starter --db-url=mysql://drupal11:drupal11@database/drupal11 -y + +# Get the login link +lando drush user:login /admin/dashboard/welcome --uri="$(lando info -s appserver --path 'urls[1]' | tr -d '\n' | tr -d "'")" +``` + +::: + +
+ +## Prerequisites + +Before starting, you'll need: + +1. [Lando installed on your system](https://docs.lando.dev/getting-started/installation.html) +2. Basic familiarity with command line tools +3. A terminal application + +## Installation Steps + +1. **Create and enter project directory** + +First, we'll create a new directory for our Drupal CMS project files and navigate into it: + +```bash:no-line-numbers +mkdir my-drupalcms-app +cd my-drupalcms-app +``` + +2. **Initialize a new Lando app with Drupal 11 recipe** + +Now that we have our project directory, let's set up the Lando configuration. We'll use the `lando init` command to create a `.lando.yml` file that will define our development environment. We'll tell it to use the `drupal11` recipe since that's what Drupal CMS is built on, and specify that our web files will live in a 'web' directory: + +```bash:no-line-numbers +lando init \ + --source cwd \ + --recipe drupal11 \ + --webroot web \ + --name my-drupalcms-app +``` + +3. **Start the Lando environment** + +With the Lando configuration in place, start the development environment by running the command below. This +will take a few minutes the first time as Lando downloads and configures everything needed to host Drupal CMS locally: + +```bash:no-line-numbers +lando start +``` + +4. **Install Project Files via Composer** + +Now that the environment is running, we use Composer to download and install the Drupal CMS project files. + +```bash:no-line-numbers +lando composer create-project drupal/cms tmp && cp -r tmp/. . && rm -rf tmp +``` + +5. **Install Drupal** + +With the environment running and the project files in place, we need to configure Drupal to use Lando's database service, create the database, and run Drupal's installation process. Fortunately, Drush makes this easy with its `site:install` command: + +```bash:no-line-numbers +lando drush site:install recipes/drupal_cms_starter --db-url=mysql://drupal11:drupal11@database/drupal11 -y +``` + +## Post-Installation + +Now that Drupal CMS is installed and running, it's time to login. We'll use the `lando drush user:login` command to generate a one-time login link: + +```bash:no-line-numbers +lando drush user:login /admin/dashboard/welcome --uri="$(lando info -s appserver --path 'urls[1]' | tr -d '\n' | tr -d "'")" +``` + +2. Start exploring the [Drupal CMS interface](https://new.drupal.org/docs/drupal-cms/get-started/get-to-know-drupal-cms/getting-around-drupal-cms) and its features like: + - The Dashboard + - Content management tools + - Built-in SEO tools + - [Smart default recipes](https://new.drupal.org/docs/drupal-cms/get-started/get-to-know-drupal-cms/adding-functionality-with-smart-defaults) for common functionality + - [AI tools](https://new.drupal.org/docs/drupal-cms/get-to-know-drupal-cms/ai-tools-in-drupal-cms) for site administrators and content creators + +## Customizing Your Setup + +Lando's Drupal plugin offers many configuration options. You can customize: + +- PHP version +- Web server (Apache or Nginx) +- Database backend (MySQL, MariaDB, or PostgreSQL) +- Composer version +- And more + +For detailed configuration options, see the [Lando Drupal Plugin Configuration Documentation](https://docs.lando.dev/plugins/drupal/config.html). + +## Starting and Stopping + +- To stop your local environment: `lando stop` +- To start it again: `lando start` +- To rebuild the environment: `lando rebuild` + +## Next Steps + +Now that you have Drupal CMS running locally, you can: + +1. [Get familiar with the Drupal CMS features and interface](https://new.drupal.org/docs/drupal-cms/get-started/get-to-know-drupal-cms) + +## Troubleshooting + +If you encounter issues during installation: + +- Try running `lando rebuild -y` to rebuild your app with the latest configuration +- Check Lando's [troubleshooting guide](https://docs.lando.dev/help/troubleshooting.html) +- Join the [Lando Slack](https://www.launchpass.com/devwithlando) for community support + +Remember to check the [Drupal CMS documentation](https://drupal.org/docs/drupal-cms) for detailed information about working with Drupal CMS.