diff --git a/docs/glossary.md b/docs/glossary.md index a6c762350..15e283da2 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -206,6 +206,16 @@ 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. 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.