Skip to content
Merged
Changes from 1 commit
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
46 changes: 18 additions & 28 deletions docs/reference-guide/cookieplone-make-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,7 @@ myst:

This reference guide describes the function and purpose of all the `make` commands found in a {term}`Cookieplone` project.
It's organized according to its components.
- Frontend
- Backend
- Documentation
- Environment
- Quality assurance (QA)
- Internationalization (i18n)
- Testing
- Container images
- Local stack
- Acceptance


## Frontend

Expand Down Expand Up @@ -165,12 +156,12 @@ You can run the following make targets by using the command structure of `make <

## 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?**
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.
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:

Expand Down Expand Up @@ -202,21 +193,20 @@ format Format DevOps files (YAML, JSON, etc.)
clean Clean temporary deployment artifacts
help Show this help
```
These commands support tasks such as:
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

- provisioning via **Ansible**
- deploying through **GitHub Actions** or **GitLab CI**
- editing and viewing **encrypted secrets**
- linting DevOps configuration
- rolling back deployments

## Additional Documentation
## Additional documentation

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