Add a /recipes folder

Created on 17 May 2024, about 1 month ago
Updated 25 June 2024, 3 days ago

Problem/Motivation

The recipe runner should look for recipes in /recipes as we should store all recipes in a single location so dependent recipes are found.

Proposed resolution

Add the folder and a README.txt

Remaining tasks

Doing it.

πŸ“Œ Task
Status

Closed: won't fix

Version

11.0 πŸ”₯

Component
recipe systemΒ  β†’

Last updated 14 minutes ago

Created by

πŸ‡ΊπŸ‡ΈUnited States thejimbirch Cape Cod, Massachusetts

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @thejimbirch
  • πŸ‡ΊπŸ‡ΈUnited States thejimbirch Cape Cod, Massachusetts

    thejimbirch β†’ changed the visibility of the branch 3447822-add-a-recipes to hidden.

  • Merge request !8110Resolve #3447822 "Recipes folder" β†’ (Open) created by thejimbirch
  • Issue was unassigned.
  • Status changed to Needs review about 1 month ago
  • πŸ‡ΊπŸ‡ΈUnited States thejimbirch Cape Cod, Massachusetts

    Folder and readme file added.

  • Pipeline finished with Success
    about 1 month ago
    Total: 653s
    #175037
  • Status changed to RTBC about 1 month ago
  • πŸ‡§πŸ‡ͺBelgium borisson_ Mechelen, πŸ‡§πŸ‡ͺ

    The readme in the folder looks good.

  • πŸ‡ΊπŸ‡ΈUnited States sgroundwater

    The Readme needs a few more items, following template format of the Modules and Themes files.

    ---
    Recipes allow the automation of Drupal module install and configuration.

    Recipes are supported by new APIs in Drupal 10.3 and 11.0. Recipes are automated site builder steps, in technical terms they are a combination of preconfigured Drupal extensions. Recipes can depend on other recipes, they are composable with other recipes and unlike distributions, do not lock the site in. The eventual goal is that Drupal core itself will offer up recipes instead of install profiles.

    DOWNLOAD ADDITIONAL RECIPES
    --------------------------
    Contributed recipes from the Drupal community may be downloaded at
    . (Maybe hold back for now?)

    MULTISITE CONFIGURATION
    -----------------------
    ??? We don't want to put in wrong technical info here, so need to confirm if similar text is needed:

    In multisite configurations, recipes found in this directory are available to
    all sites. You may also put themes in the sites/all/themes directory, and the
    versions in sites/all/themes will take precedence over versions of the same
    themes that are here. Alternatively, the sites/your_site_name/themes directory
    pattern may be used to restrict themes to a specific site instance.

    MORE INFORMATION
    -----------------
    ??? Point to the /docs/readme.md, or incorporate it's info here.

  • πŸ‡ΊπŸ‡ΈUnited States thejimbirch Cape Cod, Massachusetts

    Great review @sgroundwater. I contemplated all of those things, but they are all "to be determined". Instead of adding the headers and TBD, I elected to just leave it simple for now. We can make additions as we go.

  • πŸ‡ΊπŸ‡ΈUnited States sgroundwater

    It's understood that this Readme needs some sections to be TBD for now.
    For me, while recipes are in flux, it was helpful to find this development Document:
    https://git.drupalcode.org/project/distributions_recipes/-/blob/1.0.x/re...

    Here's my updated suggestion. (Yes, it's a readme link to another readme, but the project Readme was the info I needed. )

    MORE INFORMATION:
    The Distributions and Recipes initiative is evolving rapidly, and so is our documentation. This Readme provides a good starting point, but please note that information will change frequently as the project progresses.
    Additional information may be found in the project’s Initiative documentation page.
    https://git.drupalcode.org/project/distributions_recipes/-/blob/1.0.x/re...

  • Status changed to Postponed: needs info about 1 month ago
  • πŸ‡¬πŸ‡§United Kingdom alexpott πŸ‡ͺπŸ‡ΊπŸŒ

    I'd rather decide how we're going to implement the composer plugin first before we add this. There's lots of efforts to try to make recipes work like modules and I feel this is a mistake. The recipe runner looks were you tell it to. As far as I know it does not look in /recipes. This change needs more justification as to why it is correct.

  • πŸ‡ΊπŸ‡ΈUnited States sgroundwater

    Giving space to implement the composer plugin first is valid. My head just goes to idea that "/recipe" is where I should look for more information.

    Modules|Themes|Recipes, these are all different areas. People know to look in /modules and /themes, so it's second nature to want to look in /recipes too.

  • πŸ‡ΊπŸ‡ΈUnited States thejimbirch Cape Cod, Massachusetts

    The recipe runner looks were you tell it to. As far as I know it does not look in /recipes. This change needs more justification as to why it is correct.

    You are correct. I was mistaken.

    I updated the description to:

    The recipe runner should look for recipes in /recipes as we should store all recipes in a single location so dependent recipes are found.

    I'd rather decide how we're going to implement the composer plugin first before we add this.

    How will that affect where we store recipes? I still believe there are going to be times when we want to ship recipes with a site. If I am spinning up new sites for university departments, and allowing the admins to apply their needed recipes. Thinking along the lines of what Starshot needs.

  • πŸ‡ΊπŸ‡ΈUnited States thejimbirch Cape Cod, Massachusetts

    The need for the recipes folder is also on the roadmap.

  • πŸ‡ΊπŸ‡ΈUnited States thejimbirch Cape Cod, Massachusetts
  • πŸ‡¬πŸ‡§United Kingdom alexpott πŸ‡ͺπŸ‡ΊπŸŒ

    I think the recipes directory should be configured in the root composer.json - we don't need to configure it somewhere else... and now this has been added to composer so this should be possible... https://github.com/composer/installers/pull/534/files

  • Status changed to Closed: won't fix 3 days ago
  • πŸ‡ΊπŸ‡ΈUnited States thejimbirch Cape Cod, Massachusetts

    Closing this as Won't Fix.

    In the following issue, it was decided to have recipes at /recipes above the webroot.

    πŸ“Œ Add support for recipes to drupal/recommended-project Needs review

Production build 0.69.0 2024