backdrop-contrib / digital_agency

A package of recipes to provide content and configuration for a digital agency website for Backdrop CMS.
GNU General Public License v3.0
1 stars 0 forks source link

Suggestions for Readme file #2

Open izmeez opened 3 months ago

izmeez commented 3 months ago

What is digital_agency? Technically, it's just another recipe. It includes other recipes and becomes what? A package?

package = Recipes

stpaultim commented 3 months ago

@izmeez One of the problems I'm having is settling on terminology to describe the different components in this project. I was using the term "Package" for a little while, but that is problematic for the reason that you highlight here. We already use that term in our project system for BackdropCMS. The "Package" in the .info file for projects refers to how projects are organzed and displayed on the modules page. Anything with "package = recipes" will show up in the Recipe package on the modules page.

I've started to call this a "Recipe Package" instead, but I'm not sure I like that either. I'm thinking maybe I should call it a "Recipe Bundle". It bundles together other recipes.

One of the working definitions for a recipe (but not official) is that a recipe can be disabled after installation without loosing anything. This is not true of Digital Agency. Digital Agency includes CSS that requires the modules stay enabled. So, is it really a "recipe"?

I'm thinking, maybe "Recipes" can be disabled, but maybe "Recipe Bundles" don't have to meet that requirement? We seem to discuss this every week. I'd love more help coming to a decision on what makes a recipe a recipe? Or do we care, is it an arbitrary decision made by the maintainer?

image

izmeez commented 3 months ago

Terminology is always a challenge.