From 3dcbae490b9ba19ff47f9f7a445081dce72e2a12 Mon Sep 17 00:00:00 2001 From: vibhu gupta Date: Tue, 11 Nov 2025 22:40:35 +0530 Subject: [PATCH 1/3] Add missing glossary terms: contentIcons and excludeLinksAndReferencesMenuItem --- docs/glossary.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/glossary.md b/docs/glossary.md index a6c762350..93aa4a0f5 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -206,6 +206,17 @@ Volto configuration loader An add-on must provide a default configuration loader that is always loaded when Volto runs. An add-on can have multiple configuration loaders, and they can be loaded optionally from the Volto configuration. +(contentIcons)= +contentIcons +A Volto configuration option (typically a boolean) that controls whether small content-type icons are shown next to items in lists, teasers, and navigation components. +When enabled, an icon representing the item's content type (for example: document, image, file) is displayed alongside the item's title. + +(excludeLinksAndReferencesMenuItem)= +excludeLinksAndReferencesMenuItem +A Volto configuration key or menu setting that, when enabled, removes or hides the "Links and References" menu item from link pickers or site menus. +Use this option to prevent the Links and References entry from appearing in UI menus where it is not desired. + + Configuration registry In Plone and in general, the configuration registry is where resources are registered for an application. From 65a35089f069b6081a1201826a6ddfcf7c4c68cd Mon Sep 17 00:00:00 2001 From: vibhu gupta Date: Wed, 12 Nov 2025 17:31:00 +0530 Subject: [PATCH 2/3] Fix glossary formatting for contentIcons and excludeLinksAndReferencesMenuItem --- docs/glossary.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/glossary.md b/docs/glossary.md index 93aa4a0f5..15e283da2 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -208,14 +208,13 @@ Volto configuration loader (contentIcons)= contentIcons -A Volto configuration option (typically a boolean) that controls whether small content-type icons are shown next to items in lists, teasers, and navigation components. -When enabled, an icon representing the item's content type (for example: document, image, file) is displayed alongside the item's title. + A Volto configuration option (typically a boolean) that controls whether small content-type icons are shown next to items in lists, teasers, and navigation components. + When enabled, an icon representing the item's content type (for example: document, image, file) is displayed alongside the item's title. (excludeLinksAndReferencesMenuItem)= excludeLinksAndReferencesMenuItem -A Volto configuration key or menu setting that, when enabled, removes or hides the "Links and References" menu item from link pickers or site menus. -Use this option to prevent the Links and References entry from appearing in UI menus where it is not desired. - + A Volto configuration key or menu setting that, when enabled, removes or hides the "Links and References" menu item from link pickers or site menus. + Use this option to prevent the Links and References entry from appearing in UI menus where it is not desired. Configuration registry In Plone and in general, the configuration registry is where resources are registered for an application. From ae14c08f7cf6f6a5c33386d14688e56b1e3f4835 Mon Sep 17 00:00:00 2001 From: vibhu gupta Date: Tue, 18 Nov 2025 02:41:14 +0530 Subject: [PATCH 3/3] Improve DevOps documentation section and formatting --- .../cookieplone-make-commands.md | 60 ++++++++++++++++++- 1 file changed, 59 insertions(+), 1 deletion(-) diff --git a/docs/reference-guide/cookieplone-make-commands.md b/docs/reference-guide/cookieplone-make-commands.md index 22b3c1e18..75dd30a50 100644 --- a/docs/reference-guide/cookieplone-make-commands.md +++ b/docs/reference-guide/cookieplone-make-commands.md @@ -160,4 +160,62 @@ You can run the following make targets by using the command structure of `make < `build-images` : Invokes the target `build-image` in both `backend/Makefile` and `frontend/Makefile`. - This builds Docker images for both backend and frontend. \ No newline at end of file + This builds Docker images for both backend and frontend. + +## Devops + +Cookieplone projects can optionally include a `devops` folder when deployment-related options are selected during project generation, such as: + +- **Add Ansible playbooks?** +- **Add GitHub Action to Deploy this project?** + +When these options are enabled, Cookieplone generates a `devops/Makefile` containing deployment and CI/CD helper commands. + +You can view the available DevOps commands in your generated project by running: + +```bash +# from the project root +make -C devops help + +# or +cd devops +make help + +``` +The commands vary depending on your Cookieplone template options, so this is the authoritative way to inspect your environment. + +Below is the current working output of the DevOps make help command +(as fixed in cookieplone-templates#305): + +``` +# === DevOps Makefile Commands === +deploy Deploy the project using the configured provider +deploy-check Validate deployment configuration +deploy-ansible Run Ansible playbooks for provisioning +deploy-rollback Roll back the last deployment +deploy-status Show deployment status or active revision +secrets-edit Edit encrypted secrets +secrets-view View decrypted secrets +lint Lint Ansible and DevOps configuration files +format Format DevOps files (YAML, JSON, etc.) +clean Clean temporary deployment artifacts +help Show this help +``` +These commands support tasks such as: + +- provisioning via **Ansible** +- deploying through **GitHub Actions** or **GitLab CI** +- editing and viewing **encrypted secrets** +- linting DevOps configuration +- rolling back deployments + +## Additional Documentation + +The `devops` folder also includes README files generated by Cookieplone, which contain deployment instructions tailored to your setup: + +- {file}`devops/README.md` +- {file}`devops/README-GHA.md` (GitHub Actions deployment) +- {file}`devops/README-GITLAB.md` (GitLab deployment) + +These documents provide hands-on details such as provisioning steps, CI configuration, and environment requirements. +This reference section avoids duplicating that information and instead links to those files.