Skip to content
Snippets Groups Projects
Select Git revision
  • master default protected
  • develop
  • restricted_angeltypes
  • rC3-v1.0.0
  • rC3-v0.1.3
  • rC3-v0.1.2
  • rC3-v0.1.1
  • rC3-v0.1.0
  • 36c3-v1.0.0
  • t0.9.0
10 results
Compare
Chessmaster's avatar
Merge remote-tracking branch 'origin/restricted_angeltypes'
Chessmaster authored 
# Conflicts:
#	guide/de/what-is-an-angel.adoc
#	guide/en_US/what-is-an-angel.adoc
1f64a341
History
Chessmaster's avatar 1f64a341
History
Name Last commit Last update
asset
guide
.gitignore
.gitlab-ci.yml
README.md
build.sh
guide.adoc
README.md

Angel Guide for Chaos Events

This guide is written in Asciidoc.

Requirements

  • asciidoctor
  • asciidoctor-pdf

Asciidoctor resources

How to build the PDF

Run the following command in the git repositories root folder, after installing the requirements.

  $ asciidoctor-pdf guide.adoc

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.

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: