Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • wonka/angelguide
  • kaste/angelguide
  • Xu/angelguide
3 results
Show changes
Commits on Source (95)
Showing
with 98 additions and 0 deletions
*.html
*.pdf *.pdf
stages:
- build
- publish
.template:build_guide:
stage: build
image: alpine
before_script:
- apk update
- apk add --no-cache ruby asciidoctor git
- gem install asciidoctor-pdf --pre
artifacts:
paths:
- "angelguide_en.pdf"
- "angelguide_de.pdf"
expire_in: 12 months
build_guide_by_tag:
extends: .template:build_guide
script:
- ./build.sh $CI_COMMIT_TAG
rules:
- if: $CI_COMMIT_TAG != null
when: always
build_guide:
extends: .template:build_guide
script:
- ./build.sh $CI_COMMIT_SHORT_SHA
rules:
- if: $CI_COMMIT_TAG == null
when: always
publish_guide:
stage: publish
image: kroniak/ssh-client
before_script:
- apk update
- apk add --no-cache rsync
- mkdir -p ~/.ssh
- chmod 700 ~/.ssh
- eval $(ssh-agent -s)
- echo -n "$SSH_PRIVATE_KEY" | ssh-add -
- ssh-keyscan -H "$PUBLISH_HOST" >> ~/.ssh/known_hosts
- chmod 644 ~/.ssh/known_hosts
script:
- 'rsync -av angelguide_*.pdf $PUBLISH_USER@$PUBLISH_HOST:$PUBLISH_PATH'
rules:
- if: $CI_COMMIT_TAG != null
when: manual
\ No newline at end of file
# Angel Guide for Chaos Events
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/)
## 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](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)
File added
File added
File added
File added
File added
File added
File added
File added
File added
File added
File added
File added
File added
File added
File added
File added
File added