- Issue created by @thejimbirch
- π―π΅Japan ultrabob Japan
In the issue description, it says that "site feature" is commonly used, but the wordpress.com example is using "your site's features." These are just English words used together in a sentence, not a unit that is commonly used. I'm not sure what the benefit of prepending "site" to "feature" is, unless this issue is a proposal for core or Drupal CMS recipes only, which is not clear from the description. Feature seems a better alternative than site feature.
I'm likely missing some context that isn't in the description, but it seems to me, that just like modules and themes, recipes will need short descriptions for both their page on drupal.org, and eventually for project browser. I'm not sure that mandating a name is all that useful or enforceable.
I think it is hard for the name to provide enough information about the type of things done in the recipe, the intention of the recipe, and the scope of the recipe. I feel like it would be better to focus on better descriptions, and consider some type of mechanism for automating a summary of the actions a recipe will take in a way that it can be more easily absorbed than by reading the yml file, etc.
Something along the lines of headings like:
Modules Installed
Config Modified
Actions Invoked
Content Added
with summaries in them. We wouldn't want to dig into deep detail, but could give a summary that should along with a short description, give a good idea that the recipe does what you think it does.
- πΊπΈUnited States thejimbirch Cape Cod, Massachusetts
Prioritized the epics for Starshot.
- π¬π§United Kingdom alexpott πͺπΊπ
@thejimbirch many thanks for this great work.
One thing that I think is missing is working out how to support automated tests of recipes. There are several parts to this:
- Testing that the recipe can be successfully
- Testing that that provided config conforms to config schema
- Testing the functionality it claims to provide - this might be the least important because it really is incumbent on the modules to test their functionality
One thing that is exciting is that I think we could potentially provide some code (in core) and a gitlab template that could do parts 1 and 2 - so all a recipe author would have to do it add a gitlab file that includes the template and they'll get test coverage.
- πΊπΈUnited States thejimbirch Cape Cod, Massachusetts
Created #3452995: [Meta] Support automated tests of recipes β and added it here per @alexpott in #32
- πΊπΈUnited States thejimbirch Cape Cod, Massachusetts
thejimbirch β changed the visibility of the branch 3446089-update-roadmap to hidden.
- πΊπΈUnited States thejimbirch Cape Cod, Massachusetts
Added a couple more Starshot blockers
- πΊπΈUnited States thejimbirch Cape Cod, Massachusetts
Removed #3452652: Recipes in Drupal core should have a logo for findability in Project Browser/Starshot as Drupal CMS will not show core recipes in Project Browser.