From 5ce1cc9edf8b7245dd5f15c01d5e0db64f0a4986 Mon Sep 17 00:00:00 2001
From: MichiK <michik@michik.net>
Date: Sun, 20 Dec 2020 04:11:36 +0100
Subject: [PATCH] Add description of automated deployment to readme

---
 README.md | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 54a1d23..3c54624 100644
--- a/README.md
+++ b/README.md
@@ -3,13 +3,14 @@
 This guide is written in Asciidoc.
 
 ## Requirements
+
 * asciidoctor
 * asciidoctor-pdf
 
 ## Asciidoctor resources
 
-[Quick Reference](https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/)
-[User Manual](https://asciidoctor.org/docs/user-manual/)
+* [Quick Reference](https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/)
+* [User Manual](https://asciidoctor.org/docs/user-manual/)
 
 ## How to build the PDF
 
@@ -21,6 +22,26 @@ the requirements.
 ```
 
 Build the guide in other languages:
+
 ```
   $ asciidoctor-pdf -a lang=de guide.adoc
 ```
+
+## Deployment via CI
+
+The guide can be built and deployed to our web server using Gitlab CI. The
+target server, user and path as well as the SSH key used for deployment are
+configured in the settings of this project and the server can be prepared
+using the `angelguide-deployment` role from our
+[infrastructure repo](https://chaos.expert/himmel/infrastruktur).
+
+`PUBLISH_PATH` is always `/`. `PUBLISH_HOST`, `PUBLISH_USER` and
+`SSH_PRIVATE_KEY` must match the values configured via Ansible.
+
+While the build process of the PDFs is happening automatically for every commit
+and merge request, the deployment job is a manual action. After the deployment,
+the guide will be reachable at:
+
+* <https://c3heaven.de/guide/angelguide_de.pdf> (german)
+* <https://c3heaven.de/guide/angelguide_en.pdf> (english)
+* <https://c3heaven.de/angelguide.pdf> (language determined by browser)
-- 
GitLab