From 4de0ce2ff115d709a0a1aa41d5c1031b324114c3 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 28 Feb 2024 05:53:57 -0800 Subject: [PATCH] Delete develop a project docs (#5759) --- docs/source/getting-started/roadmap.md | 13 +++++++++ docs/source/recipes/developing-a-project.md | 32 --------------------- docs/source/recipes/index.md | 1 - packages/volto/news/5675.documentation | 1 + 4 files changed, 14 insertions(+), 33 deletions(-) delete mode 100644 docs/source/recipes/developing-a-project.md create mode 100644 packages/volto/news/5675.documentation diff --git a/docs/source/getting-started/roadmap.md b/docs/source/getting-started/roadmap.md index cba274e63b..244b11159c 100644 --- a/docs/source/getting-started/roadmap.md +++ b/docs/source/getting-started/roadmap.md @@ -89,3 +89,16 @@ Not really advanced but perhaps less common, here's some stuff you can do: - Customize Volto's Webpack configuration or project loader using Razzle - Write a Redux middleware - Start hacking on Volto. + +## Add-on first approach + +Developing for Plone's frontend means to add code to a Volto project. +The frontend files of the project are created in the `frontend` folder. +The generator also creates a default add-on in the `frontend/src/addons` folder. +The project is already configured to use this add-on. +Add your code and customizations to this add-on, and Volto will load them on start up or a restart. +This add-on is configured as a theme add-on, so you are able to customize the look and feel of your site as well. + +```{seealso} +For more information about how to develop a Volto project as an add-on, see {doc}`training:voltoaddons/index`. +``` diff --git a/docs/source/recipes/developing-a-project.md b/docs/source/recipes/developing-a-project.md deleted file mode 100644 index c015c9b3f8..0000000000 --- a/docs/source/recipes/developing-a-project.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -myst: - html_meta: - "description": "Developing a Volto project" - "property=og:description": "Developing a Volto project" - "property=og:title": "AppExtras component" - "keywords": "Volto, Plone, frontend, React, app extra component" ---- - -(frontend-developing-a-project-label)= - -# Developing a project - -When you start developing a Plone project, it is recommended that you use Plone's cookiecutter boilerplate project generator. -See {doc}`plone:install/create-project` for more information. - -The generator will output the project folder structure. -It is organized in three folders named `frontend`, `backend`, and `devops`, each of which corresponds to its primary use. -It also contains the convenience `Makefile` commands to perform all the usual actions while developing. - -## Add-on first approach - -Developing for Plone's frontend means to add code to a Volto project. -The frontend files of the project are created in the `frontend` folder. -The generator also creates a default add-on in the `frontend/src/addons` folder. -The project is already configured to use this add-on. -Add your code and customizations to this add-on, and Volto will load them on start up or a restart. -This add-on is configured as a theme add-on, so you are able to customize the look and feel of your site as well. - -```{seealso} -For more information about how to develop a Volto project as an add-on, see {doc}`training:voltoaddons/index`. -``` diff --git a/docs/source/recipes/index.md b/docs/source/recipes/index.md index d75154ba39..97133ec6dd 100644 --- a/docs/source/recipes/index.md +++ b/docs/source/recipes/index.md @@ -13,7 +13,6 @@ myst: :maxdepth: 1 creating-project -developing-a-project folder-structure environment-variables customizing-components diff --git a/packages/volto/news/5675.documentation b/packages/volto/news/5675.documentation new file mode 100644 index 0000000000..e10b056567 --- /dev/null +++ b/packages/volto/news/5675.documentation @@ -0,0 +1 @@ +Delete redundant `developing-a-project.md`. @stevepiercy