Skip to content

Commit

Permalink
Update refs to old cookiecutter in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
davisagli committed Sep 29, 2024
1 parent 430c995 commit 517cf5b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
20 changes: 12 additions & 8 deletions docs/source/contributing/developing-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,13 +330,6 @@ By default, the use of TypeScript is required in Plone frontend libraries, Volto

The monorepository consists of several core libraries.

### Volto project generator

`@plone/generator-volto` is a Yeoman generator that helps you set up Volto via command line.
It generates all the boilerplate needed to start developing a Plone Volto project.
It is used by [CookieCutter Plone Starter](https://github.com/collective/cookiecutter-plone-starter), the recommended way to set up Plone projects.
The generator features an `addon` template for scaffolding Volto add-ons in your projects.

### Registry

`@plone/registry` provides support for building an add-on registry and infrastructure for JavaScript and TypeScript-based apps.
Expand All @@ -354,6 +347,17 @@ Used by Volto, you can also use it in other JavaScript frameworks and environmen

`@plone/volto-slate` is the glue package that provides support for the Slate library in Volto.

### Volto project generator

`@plone/generator-volto` is a Yeoman generator that helps you set up Volto via command line.
It generates all the boilerplate needed to start developing a Plone Volto project.
It is used by [CookieCutter Plone Starter](https://github.com/collective/cookiecutter-plone-starter), the recommended way to set up Plone projects.
The generator features an `addon` template for scaffolding Volto add-ons in your projects.

```{deprecated} 18.0.0-alpha.43
For Volto 18, `@plone/generator-volto` is replaced by [Cookieplone](https://github.com/plone/cookieplone).
```


## Supported frontends

Expand All @@ -362,7 +366,7 @@ Volto is the default frontend, and is React-based.
Classic UI is the Python-based, server-side rendered frontend.

In Volto's `apps` folder, you'll find a Volto project scaffolding that uses Volto as a library.
This is the same as that which you'll have when you run the Volto generator or `cookiecutter-plone-starter`.
This is the same as that which you'll have when you follow the instructions in {doc}`plone:install/create-project`).


## Experimental frontends
Expand Down
1 change: 1 addition & 0 deletions news/6289.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update references to cookiecutter-plone-starter in docs. @davisagli

0 comments on commit 517cf5b

Please sign in to comment.