Skip to content

Commit 8087022

Browse files
committed
update removing all gh-pages artifacts
1 parent 1cb9db0 commit 8087022

2 files changed

Lines changed: 13 additions & 6 deletions

File tree

.github/workflows/docs-local.yml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,6 @@ jobs:
2929
steps:
3030
- name: Checkout repo
3131
uses: actions/checkout@v4
32-
- name: Checkout site
33-
uses: actions/checkout@v4
34-
with:
35-
ref: gh-pages
36-
path: site
3732
- name: Touch .env file
3833
run: touch site/.env
3934
- name: Fill .env file

docs-building.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,20 @@
22
If you'd like to build and install your own instance of this project, you've come to the right page.
33

44
[Back](README.md) to the main page.
5+
6+
## Clone the Repository
7+
- Create a new Repository for your files (private).
8+
- The main branch has to be named `master` since that's what the build action reacts on
9+
- Add the appropriate GitHub Actions secrets like described below.
10+
- Clone it locally
11+
- Add a second remote: https://github.com/UnterrainerInformatik/safeLearn.git
12+
- Pull from that
13+
- Checkout back to your local master-branch
14+
- To merge the 'unrelated' remote into your local master execute the following: `git merge --no-ff public/master --allow-unrelated-histories`. In this case the SafeLearn-remote is called `public`.
15+
- Resolve merge conflicts and push.
16+
- Tag your own remote master branch with `1.0.0` and start the build-script by committing something.
517
## How To Build / Update
6-
The repository derives from https://github.com/htl-leonding-college/asciidoctor-docker-template and adds functionality to publish the output to a web-server of your liking using DockerHub.
18+
The repository adds functionality to publish the output to a web-server of your liking using DockerHub.
719
It hides (server-side) all pages behind a OIDC token redirecting to an authentication server of your liking (in the default-case it's client on a Keycloak instance linked to our school's AD service, so we never have to maintain the users because the school does this for us).
820

921
You will need a web-server of your own and some way of hosting a private docker-image, since your material won't be protected from students in a public one.

0 commit comments

Comments
 (0)