Skip to content
Snippets Groups Projects
Commit 5ce1cc9e authored by MichiK's avatar MichiK
Browse files

Add description of automated deployment to readme

parent 59baa0a2
No related branches found
No related tags found
No related merge requests found
Pipeline #28104 passed
......@@ -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)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment