Improve project description

Edit Issue summary

Other quick edits for consideration at this point to help people onboard to the project.

1. We might reference https://www.velir.com/ideas/2023/05/03/exploring-the-new-recipes-feature... as an example for testing recipes.
2. Add link to the docs repo https://git.drupalcode.org/project/distributions_recipes/-/tree/1.0.x/

I think there's one important detail missing from the "Apply the recipe" section. In particular, the recipe command, php core/scripts/drupal recipe PATH/TO/RECIPE, must be run from the same directory that contains the `core` folder.

• If cloning the project for development, then you'd run this command from the directory you cloned into (because there's no web docroot in these cases).
• BUT, if using the patch to use recipes with a more standard Drupal project, e.g. following @kevinquillen's guide, then this command must be run from the web root directory, typically `/web`.

Also, +1 to ideas mentioned in #2

We should also edit instructions for installing the patch with composer.json

I am creating another related issue to create a Getting started page in the docs

Suggested changes applied.

This project exists to hold documentation and development code from the Distributions and Recipes initiative 🌱 Distributions and Recipes initiative overview and roadmap Needs work .

Work is happening in this project in contrib so that rapid iteration can happen.  Once complete, it can then be worked into Drupal core.

This page is intentionally detailless. Details should be added to the initiative page → or documentation inside the repository.

How to configure and apply Recipes

NOTE: This requires PHP 8.1

Patch core

Recipes functionality can be applied to Drupal 9.4.x and higher by applying this patch:

curl https://git.drupalcode.org/project/distributions_recipes/-/raw/patch/recipe.patch | git apply

from the root directory of a Drupal install. The patch can also be applied using the composer patches plugin. The patch is automatically updated when changes are merged to 10.0.x branch of

https://git.drupalcode.org/project/distributions_recipes.

Create a recipe

You can create your own test recipes using the examples in this project.

Apply the recipe

Recipes can be applied by using the provided CLI command run from the same directory that contains the `core` folder.

• If cloning the project for development, you'd run this command from the directory you cloned into (because there's no web docroot in these cases).
• But, if using the patch to use recipes with a more standard Drupal project, e.g., following @kevinquillen's guide, then this command must be run from the web root directory, typically `/web` or `/docroot`.

php core/scripts/drupal recipe PATH/TO/RECIPE

for example:

php core/scripts/drupal recipe core/tests/fixtures/recipes/install_node_with_config/

Give feedback and join the conversation!

Submit issues to this issue queue, or join the conversation in the #distributions-and-recipes of the Drupal Slack.

Automatically closed - issue fixed for 2 weeks with no activity.