Contrib.social

Individual recipe project pages should have descriptions/readmes

Open on Drupal.org →
Created on 8 September 2025, about 1 month ago

Problem/Motivation

As Drupal CMS evolves into a foundation for site templates, and recipe/site template authors will use and extend the individual recipes, we should add descriptions about what each recipe does to the project page.

Currently if you go to any of the recipe project pages, you only get a developer focused bug and feedback message.

This project is part of Drupal CMS. All bug reports and feedback should be filed in the Drupal CMS issue queue.

If you're not using Drupal CMS, you can still use this recipe in your own project. Add it with the following Composer command:

Proposed resolution

For an MVP, we can at least add the descriptions from the composer.json/recipe.yml and a list of modules the recipes installs and/or configures. That will give end users visibility into the functionality the recipe offers without having to look at the code.

I could manage that if @pameeela approves.

✨ Feature request
Status

Active

Component

Documentation

Created by

🇺🇸United States thejimbirch Cape Cod, Massachusetts

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

Comments & Activities

  • Issue created by @thejimbirch
  • Comment about 1 month ago →
    🇺🇸United States phenaproxima Massachusetts

    We could do this, but the only problem is that we can easily add (or remove!) a module from a recipe and forget to update the project page. If we could have links to some part of MODULES.md which lists the modules, that would be better.

  • Comment about 1 month ago →
    🇺🇸United States thejimbirch Cape Cod, Massachusetts

    That is a valid concern, but one that every project on Drupal.org has to endure. I am looking for a more site builder/marketer friendly way of communicating the functionality of the recipes, and linking to a text file, while it would technically help, it does seem developer-y.

    If you wanted to automate the process, would we want to make another script that parses each recipe for name, description, modules, etc and saves that to a README file in each recipe. Then that can be used in the project page desc.

  • Comment about 1 month ago →
    🇺🇸United States phenaproxima Massachusetts

    I think a README.md in each recipe makes a ton of sense! That's easy, and it keeps the "source of truth" in one place. d.o has an easy function to copy README.md into the project description, so that's an even better reason to go with that.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024