Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
A
AngelGuide
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
Himmel
AngelGuide
Commits
5ce1cc9e
Commit
5ce1cc9e
authored
4 years ago
by
MichiK
Browse files
Options
Downloads
Patches
Plain Diff
Add description of automated deployment to readme
parent
59baa0a2
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Pipeline
#28104
passed
4 years ago
Stage: build
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+23
-2
23 additions, 2 deletions
README.md
with
23 additions
and
2 deletions
README.md
+
23
−
2
View file @
5ce1cc9e
...
...
@@ -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)
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment