Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/glossary.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert changes to this file. It has nothing to do with this PR.

Original file line number Diff line number Diff line change
Expand Up @@ -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.

Comment on lines +209 to +218
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
(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.

Expand Down
60 changes: 59 additions & 1 deletion docs/reference-guide/cookieplone-make-commands.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please delete lines 14-23. They're out of sync with the content and don't actually provide anything useful.

Original file line number Diff line number Diff line change
Expand Up @@ -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.
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?**
Comment on lines +167 to +170
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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?**
Cookieplone projects include a `devops` folder when deployment-related questions are answered "Yes" during project generation.
These questions include the following.
- 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When these options are enabled, Cookieplone generates a `devops/Makefile` containing deployment and CI/CD helper commands.
When any of these options are selected, Cookieplone generates a {file}`devops/Makefile` file 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

```
Comment on lines +174 to +184
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move comments into easier to read narrative text. The syntax highlighter makes comments low-contrast.

Separate commands are easier to copy-paste with the copy-paste button.

Finally the syntax should be a generic shell, not a specific flavor.

Suggested change
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
```
You can view the available devops commands in your generated project by running the following help command from the project root.
```shell
make -C devops help
```
Alternatively, change the working directory to {file}`devops` and run its help command.
```shell
cd devops
make help
```

The commands vary depending on your Cookieplone template options, so this is the authoritative way to inspect your environment.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The commands vary depending on your Cookieplone template options, so this is the authoritative way to inspect your environment.
The available commands align with the selected Cookieplone template options.


Below is the current working output of the DevOps make help command
(as fixed in cookieplone-templates#305):
Comment on lines +187 to +188
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Below is the current working output of the DevOps make help command
(as fixed in cookieplone-templates#305):
When all devops options have been selected, the following output is the result of running the devops help command.


```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a syntax. Default is Python.

Suggested change
```
```console

# === 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
Comment on lines +204 to +210
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't overemphasize things. It's distracting.

Suggested change
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
These commands support devops 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sentence case headings.

Suggested change
## Additional Documentation
## Additional documentation


The `devops` folder also includes README files generated by Cookieplone, which contain deployment instructions tailored to your setup:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The `devops` folder also includes README files generated by Cookieplone, which contain deployment instructions tailored to your setup:
The {file}`devops` folder also includes {file}`README*.md` 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)
Comment on lines +216 to +218
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- {file}`devops/README.md`
- {file}`devops/README-GHA.md` (GitHub Actions deployment)
- {file}`devops/README-GITLAB.md` (GitLab deployment)
- {file}`devops/README.md`
- {file}`devops/README-GHA.md` for GitHub Actions deployment
- {file}`devops/README-GITLAB.md` for 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.
Comment on lines +220 to +221
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's combine this into one sentence. Also there are no links.

Suggested change
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.
These documents provide details, such as provisioning steps, CI configuration, and environment requirements, and are the authoritative source of documentation for devops.