tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #10084 from creative-commoners/pulls/4/recipe-doc

Browse Source 
DOC Clarify recipe usages
This commit is contained in:
Bryn Whyman 2021-09-14 08:36:48 +12:00 committed by GitHub
commit db14ba6159
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/en/00_Getting_Started/05_Recipes.md
View File

@ -4,17 +4,41 @@ summary: What Recipes are, and how they are used in Silverstripe CMS
icon: clipboard
---
# Recipes
# Adding features to your project with Recipes
Silverstripe CMS is powered by a system of components in the form of Composer packages. It consists of two types of
package:
To achieve more complex use cases in Silverstripe CMS, you may need to combine many modules and add extra configuration to integrate these together. Silverstripe CMS Recipes streamline this process for common use cases.
## What are Silverstripe CMS Recipes?
Recipes are used to implement common broad feature sets by shipping a collection of modules along with the relevant integration logic. They allow developers to quickly get started while retaining the ability to customise their integration to their specific needs.
Before each version of a supported CMS recipe is released, it is comprehensively regression tested and passed to a third party for a security-focused audit, making sure that projects have a secure starting point or a safe and secure upgrade with each recipe release.
## What's the difference between a *recipe* and a *module*?
Silverstripe CMS is powered by a system of components in the form of Composer packages. It consists of two types of package:
- **Modules**, which provide pieces of functionality (such as `silverstripe/cms` and `silverstripe/framework`)
- **Recipes**, which group related Modules together to make them easier to install and release.
When we announce a new version of Silverstripe CMS and publish a changelog for it, we refer to a new set of _Recipe_
versions, which include new versions of some or all of their associated Modules. The easiest way to keep up to date with
new Silverstripe CMS releases is to depend on one of the core Recipes:
By design, modules tend to be small and serve a specific function. You may need to combine many modules to achieve a wider goal.
For example, the `silverstripe/blog` module by itself simply allows you to create blog posts. It does not include all the features you could want in a blog, like a comment system or widgets to display related content.
The `silverstripe/recipe-blog` recipe installs `silverstripe/blog` module, but also:
- `silverstripe/widgets` and `silverstripe/content-widget` to display widgets
- `silverstripe/comments` and `silverstripe/comment-notifications` to allow the management of comments on blog post
- `silverstripe/spamprotection` and `silverstripe/akismet` to provide basic SPAM protection on comments.
## Finding recipes for Silverstripe CMS
The Silverstripe CMS project maintains a number of recipes. Some third parties also maintain recipes.
[Search Packagist for all packages with the `silverstripe-recipe`](https://packagist.org/?query=silverstripe&type=silverstripe-recipe) type to find recipes you can install on your Silverstripe CMS project.
## Releasing supported recipes
When we announce a new release of Silverstripe CMS and publish a changelog for it, we refer to a new set of _Recipe_ versions, which include new versions of some or all of their associated Modules. The easiest way to keep up to date with new Silverstripe CMS releases is to depend on one of the core Recipes:
- [`silverstripe/recipe-core`](https://packagist.org/packages/silverstripe/recipe-core): Contains only the base
framework, without the admin UI or CMS features.