Merge pull request #892 from plone/deployment-troubleshooting

Deployment troubleshooting

docs/plone-deployment/deploy.md

@@ -20,6 +20,10 @@ This guide outlines the steps to deploy the project using a Docker stack compris
 
 You can find this stack at {file}`devops/stacks/ploneconf2024-<your-github-username>.tangrama.com.br.yml`. It's modular, allowing easy integration of additional services like {term}`Varnish`, `Solr`, or `ElasticSearch`.
 
+```{seealso}
+[Traefik Proxy with HTTPS](https://dockerswarm.rocks/traefik/)
+```
+
 ## Building Docker Images
 
 Ensure you build the Docker images for the Frontend and Backend servers before deployment. GitHub Actions, configured in {file}`.github/workflows/backend.yml` and {file}`.github/workflows/frontend.yml`, facilitate this process.

docs/plone-deployment/index.md

@@ -39,4 +39,5 @@ project-edit
 server-setup
 deploy
 virtual-host
+troubleshoot
 ```

docs/plone-deployment/project-new.md

@@ -168,7 +168,7 @@ git remote add origin [email protected]:<your-github-username>/ploneconf2024.git
 git branch -M main
 ```
 
-### 4. Push to GitHub
+### 5. Push to GitHub
 
 Push your commits to the remote repository hosted on GitHub. This command will trigger the GitHub Actions that test the codebase and
 generate Docker images for the Backend and for the Frontend.

docs/plone-deployment/troubleshoot.md

@@ -0,0 +1,36 @@
+---
+myst:
+  html_meta:
+    "description": "Troubleshoot Plone Deployment issues"
+    "property=og:description": "Troubleshoot Plone Deployment issues"
+    "property=og:title": "Troubleshoot Plone Deployment issues"
+    "keywords": "Plone, Deployment, Stack, Configuration, Guide, Troubleshoot"
+---
+
+# Troubleshoot deployment issues
+
+This page offers some tips to troubleshoot the Plone Deployment Training.
+
+## Docker `Could not create directory.`
+
+Docker requires sufficient virtual disk space to install and build images.
+A typical error message may be `Could not create directory.` or anything else that mentions writing to the image.
+To resolve this, use an appropriate `docker system prune` option, such as `docker system prune -a`.
+
+```{seealso}
+[`docker system prune`](https://docs.docker.com/engine/reference/commandline/system_prune/)
+```
+
+You can also configure settings for Docker Desktop.
+Under {menuselection}`Prefences --> Resources --> Advanced`, you can configure appropriate settings for virtual disk limit and memory.
+
+```{seealso}
+-   [Change Docker Desktop settings](https://docs.docker.com/desktop/settings-and-maintenance/settings/)
+```
+
+
+## Docker memory usage
+
+Docker requires sufficient memory to install and build images.
+2GB of RAM is usually sufficient.
+See the previous section for settings details.