Skip to content

Commit f250f0a

Browse files
authored
Add Domain Controller Configuration tutorial (#24)
IB-8219 Signed-off-by: Raul Metsma <raul@metsma.ee>
1 parent 8d80f33 commit f250f0a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+671
-6144
lines changed

.github/workflows/pages.yml

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,49 @@ name: Github Pages
22
on:
33
push:
44
branches: [ master ]
5+
workflow_dispatch:
6+
permissions:
7+
contents: read
8+
pages: write
9+
id-token: write
10+
concurrency:
11+
group: "pages"
12+
cancel-in-progress: false
513
jobs:
614
build:
715
runs-on: ubuntu-latest
816
steps:
917
- name: Check out code
10-
uses: actions/checkout@v4
18+
uses: actions/checkout@v6
19+
- name: Setup Pages
20+
id: pages
21+
uses: actions/configure-pages@v5
1122
- name: Setup Python
1223
uses: actions/setup-python@v5
1324
with:
1425
python-version: '3.12'
1526
- name: Install dependencies
1627
run: python3 -m pip install mkdocs-bootswatch
17-
- name: Build docs
28+
- name: Build main page docs
1829
run: |
19-
GLOBIGNORE=ID_software_architecture_files:README.md:.git:.github
20-
rm -rf *
2130
cd ID_software_architecture_files
2231
mkdocs build
23-
mv site/* ..
24-
rmdir site
25-
- name: Deploy
26-
run: |
27-
git config --local user.name 'github-actions[bot]'
28-
git config --local user.email 'github-actions[bot]@users.noreply.github.com'
29-
git add .
30-
git commit -am "Update site"
31-
git push origin master
32+
mv site ../_site
33+
- name: Build domain page docs
34+
uses: actions/jekyll-build-pages@v1
35+
with:
36+
source: ./domain
37+
destination: ./_site/domain
38+
- name: Upload artifact
39+
uses: actions/upload-pages-artifact@v4
40+
41+
deploy:
42+
environment:
43+
name: github-pages
44+
url: ${{ steps.deployment.outputs.page_url }}
45+
runs-on: ubuntu-latest
46+
needs: build
47+
steps:
48+
- name: Deploy to GitHub Pages
49+
id: deployment
50+
uses: actions/deploy-pages@v4

404.html

Lines changed: 0 additions & 131 deletions
This file was deleted.

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,37 @@
11
# Architecture of ID-software
22

33
* [Architecture of ID-software](http://open-eid.github.io)
4+
* [Domain Controller Configuration](http://open-eid.github.io/domain)
45

5-
## Editing and building
6+
## Editing and building "Architecture of ID-software"
67

78
Uses http://www.mkdocs.org/ and https://github.com/mkdocs/mkdocs-bootswatch styles for generating documentation.
89

9-
1. Update source files docs/index.md and docs/index_files/
10+
1. Update source files in ID_software_architecture_files/docs/
1011

11-
2. Build documentation
12+
2. Build documentation localy
1213

1314
cd ID_software_architecture_files
1415
mkdocs build
1516

16-
3. Copy the contents of `site` folder to the root folder of the repository.
17+
## Editing and building "Domain Controller Configuration"
18+
19+
Uses https://jekyllrb.com and https://just-the-docs.com styles for generating documentation.
20+
21+
1. Update source files in domain/
22+
23+
2. Build pdf document
24+
25+
```bash
26+
# Export English version
27+
pandoc index.md -L kramdown-toc.lua -o eID_Auth_Guide_EN.pdf
28+
29+
# Export Estonian version
30+
pandoc index.et.md -L kramdown-toc.lua -o eID_Auth_Guide_ET.pdf
31+
```
32+
33+
34+
## Support
35+
Official builds are provided through official distribution point [id.ee](https://www.id.ee/en/article/install-id-software/). If you want support, you need to be using official builds. Contact our support via www.id.ee for assistance.
36+
37+
Source code is provided on "as is" terms with no warranty (see license for more information). Do not file Github issues with generic support requests.

0 commit comments

Comments
 (0)