Skip to content

Commit 30d8709

Browse files
somehowchrissomehowchris
committed
mkdocs setup
0 parents  commit 30d8709

21 files changed

Lines changed: 1007 additions & 0 deletions

File tree

‎.github/workflows/deploy.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Deploy docs
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v4
22+
23+
- uses: actions/setup-python@v5
24+
with:
25+
python-version: '3.12'
26+
27+
- uses: astral-sh/setup-uv@v5
28+
29+
- run: uv pip install --system -r requirements.txt
30+
31+
- run: mkdocs build
32+
33+
- uses: actions/upload-pages-artifact@v3
34+
with:
35+
path: site
36+
37+
deploy:
38+
needs: build
39+
runs-on: ubuntu-latest
40+
environment:
41+
name: github-pages
42+
url: ${{ steps.deployment.outputs.page_url }}
43+
steps:
44+
- name: Deploy to GitHub Pages
45+
id: deployment
46+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
site/
2+
__pycache__/
3+
*.pyc
4+
.venv/
5+
.cache/
6+
.DS_Store
7+
docs/

‎Makefile‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.PHONY: install serve build deploy
2+
3+
install:
4+
uv venv .venv
5+
uv pip install --python .venv/bin/python -r requirements.txt
6+
7+
serve:
8+
.venv/bin/mkdocs serve
9+
10+
build:
11+
.venv/bin/mkdocs build
12+
13+
deploy:
14+
.venv/bin/mkdocs gh-deploy --force

‎README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# docs.admin.digital
2+
3+
Benutzer-Dokumentation fuer admin.digital, erstellt mit [MkDocs](https://www.mkdocs.org/) und dem [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) Theme.
4+
5+
## Lokale Entwicklung
6+
7+
```bash
8+
make install
9+
make serve
10+
```
11+
12+
## Deployment
13+
14+
Automatisch via GitHub Actions bei Push auf `main`.
15+
16+
Manuell: `make deploy`
17+
18+
**URL:** [https://docs.admin.digital](https://docs.admin.digital)

‎content/CNAME‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs.admin.digital

‎content/datenschutz/index.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Datenschutz
3+
description: Informationen zu Datenschutz und Informationssicherheit bei admin.digital
4+
---
5+
6+
# Datenschutz
7+
8+
!!! warning "Entwurf"
9+
Diese Seite befindet sich im Aufbau. Die Datenschutzinformationen werden laufend ergänzt.
10+
11+
Datenschutz und Informationssicherheit haben bei admin.digital höchste Priorität. Als Plattform für die öffentliche Verwaltung der Schweiz sind wir den strengen Anforderungen an den Umgang mit Daten verpflichtet.
12+
13+
## Datenstandort Schweiz
14+
15+
!!! tip "Ihre Daten bleiben in der Schweiz"
16+
admin.digital wird ausschliesslich in **zertifizierten Schweizer Rechenzentren** betrieben. Es findet keine Datenübermittlung ins Ausland statt.
17+
18+
Der Betrieb in der Schweiz gewährleistet, dass sämtliche Daten den Schweizer Datenschutzgesetzen unterliegen und die Anforderungen der öffentlichen Verwaltung erfüllt werden.
19+
20+
## Informationssicherheit
21+
22+
!!! note "Zertifizierter Betrieb"
23+
Die Plattform wird nach anerkannten Standards für Informationssicherheit betrieben.
24+
25+
*[Platzhalter — Weitere Details zu Sicherheitsmassnahmen und Zertifizierungen werden ergänzt.]*
26+
27+
### Technische Massnahmen
28+
29+
- Verschlüsselte Datenübertragung
30+
- Regelmässige Sicherheitsupdates
31+
- Zugangskontrollen und Berechtigungsmanagement
32+
- Kontinuierliches Monitoring
33+
34+
*[wird ergänzt]*
35+
36+
### Organisatorische Massnahmen
37+
38+
- Definierte Sicherheitsprozesse
39+
- Regelmässige Überprüfungen
40+
- Schulung der Mitarbeitenden
41+
42+
*[wird ergänzt]*
43+
44+
## Datenschutzrichtlinien
45+
46+
*[Platzhalter — Die vollständigen Datenschutzrichtlinien werden hier veröffentlicht.]*
47+
48+
Bei Fragen zum Datenschutz wenden Sie sich bitte an unsere [Kontaktstelle](../kontakt.md).

‎content/erste-schritte/anmeldung.md‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
---
2+
title: Anmeldung
3+
description: Anleitung zur Anmeldung bei admin.digital — Login, Passwort und Zwei-Faktor-Authentifizierung
4+
---
5+
6+
# Anmeldung
7+
8+
!!! warning "Entwurf"
9+
Diese Seite befindet sich im Aufbau. Inhalte können sich jederzeit ändern.
10+
11+
Diese Anleitung beschreibt, wie Sie sich bei admin.digital anmelden, Ihr Passwort verwalten und die Zwei-Faktor-Authentifizierung einrichten.
12+
13+
## Zugang zur Plattform
14+
15+
admin.digital ist über den Webbrowser erreichbar. Sie benötigen lediglich eine aktive Internetverbindung und einen unterstützten Browser.
16+
17+
<!-- TODO: Exakte URL der Plattform ergänzen (z.B. https://app.admin.digital) -->
18+
19+
!!! info "Unterstützte Browser"
20+
admin.digital unterstützt die aktuellen Versionen folgender Browser:
21+
22+
- Google Chrome
23+
- Mozilla Firefox
24+
- Microsoft Edge
25+
- Apple Safari
26+
27+
<!-- TODO: Mindestversionen und ggf. Einschränkungen prüfen und ergänzen -->
28+
29+
## Anmeldung Schritt für Schritt
30+
31+
### 1. Plattform aufrufen
32+
33+
Öffnen Sie Ihren Webbrowser und navigieren Sie zur Anmeldeseite von admin.digital.
34+
35+
<!-- TODO: Screenshot der Anmeldeseite einfügen -->
36+
<!-- ![Anmeldeseite](../img/anmeldung-startseite.png) -->
37+
38+
### 2. Zugangsdaten eingeben
39+
40+
Geben Sie Ihre E-Mail-Adresse und Ihr Passwort ein, die Sie von Ihrer Verwaltung erhalten haben.
41+
42+
<!-- TODO: Screenshot der Login-Maske einfügen -->
43+
<!-- ![Login-Maske](../img/anmeldung-login.png) -->
44+
45+
### 3. Anmeldung bestätigen
46+
47+
Klicken Sie auf **Anmelden**, um sich auf der Plattform einzuloggen.
48+
49+
<!-- TODO: Screenshot nach erfolgreichem Login einfügen -->
50+
<!-- ![Startseite nach Login](../img/anmeldung-dashboard.png) -->
51+
52+
!!! tip "Angemeldet bleiben"
53+
Je nach Konfiguration Ihrer Verwaltung können Sie die Option **Angemeldet bleiben** aktivieren. Verwenden Sie diese Option nur auf Geräten, die ausschliesslich von Ihnen genutzt werden.
54+
55+
## Passwortverwaltung
56+
57+
### Passwort ändern
58+
59+
Sie können Ihr Passwort jederzeit in den Kontoeinstellungen ändern.
60+
61+
<!-- TODO: Genauen Pfad zu den Kontoeinstellungen beschreiben -->
62+
63+
1. Melden Sie sich bei admin.digital an.
64+
2. Öffnen Sie die **Kontoeinstellungen**.
65+
3. Wählen Sie **Passwort ändern**.
66+
4. Geben Sie Ihr aktuelles Passwort und anschliessend Ihr neues Passwort ein.
67+
5. Bestätigen Sie die Änderung.
68+
69+
!!! warning "Sicheres Passwort wählen"
70+
Verwenden Sie ein starkes Passwort mit mindestens 12 Zeichen, das Gross- und Kleinbuchstaben, Zahlen und Sonderzeichen enthält. Verwenden Sie Ihr Passwort nicht für andere Dienste.
71+
72+
### Passwort vergessen
73+
74+
Falls Sie Ihr Passwort vergessen haben, können Sie es über die Anmeldeseite zurücksetzen.
75+
76+
<!-- TODO: Genauen Ablauf der Passwort-Zurücksetzung beschreiben und Screenshots einfügen -->
77+
78+
1. Klicken Sie auf der Anmeldeseite auf **Passwort vergessen**.
79+
2. Geben Sie Ihre registrierte E-Mail-Adresse ein.
80+
3. Sie erhalten eine E-Mail mit einem Link zur Passwort-Zurücksetzung.
81+
4. Folgen Sie dem Link und vergeben Sie ein neues Passwort.
82+
83+
!!! note "Keine E-Mail erhalten?"
84+
Prüfen Sie Ihren Spam-Ordner. Falls die E-Mail nicht ankommt, wenden Sie sich an Ihre zuständige IT-Stelle oder an den [Support](../kontakt.md).
85+
86+
## Zwei-Faktor-Authentifizierung (2FA)
87+
88+
<!-- TODO: Detaillierte Anleitung zur 2FA-Einrichtung ergänzen, sobald die genauen Abläufe feststehen -->
89+
90+
Die Zwei-Faktor-Authentifizierung bietet zusätzlichen Schutz für Ihr Konto. Nach der Eingabe Ihres Passworts wird ein zweiter Faktor abgefragt.
91+
92+
!!! info "Unterstützte Verfahren"
93+
admin.digital unterstützt folgende 2FA-Verfahren:
94+
95+
- **TOTP-App** — z.B. Google Authenticator, Microsoft Authenticator oder Authy
96+
- **YubiKey** — Hardware-Sicherheitsschlüssel
97+
98+
<!-- TODO: Genaue Liste der unterstützten Verfahren und Geräte prüfen -->
99+
100+
### TOTP-App einrichten
101+
102+
<!-- TODO: Schritt-für-Schritt-Anleitung mit Screenshots ergänzen -->
103+
104+
1. Öffnen Sie die **Kontoeinstellungen** und wählen Sie **Zwei-Faktor-Authentifizierung**.
105+
2. Wählen Sie **TOTP-App** als Verfahren.
106+
3. Scannen Sie den angezeigten QR-Code mit Ihrer Authenticator-App.
107+
4. Geben Sie den generierten Code ein, um die Einrichtung abzuschliessen.
108+
109+
### YubiKey einrichten
110+
111+
<!-- TODO: Schritt-für-Schritt-Anleitung mit Screenshots ergänzen -->
112+
113+
1. Öffnen Sie die **Kontoeinstellungen** und wählen Sie **Zwei-Faktor-Authentifizierung**.
114+
2. Wählen Sie **Sicherheitsschlüssel (YubiKey)** als Verfahren.
115+
3. Stecken Sie Ihren YubiKey ein und folgen Sie den Anweisungen auf dem Bildschirm.
116+
117+
!!! tip "Backup-Codes"
118+
Speichern Sie die bereitgestellten Backup-Codes an einem sicheren Ort. Diese können verwendet werden, falls Sie keinen Zugriff auf Ihren zweiten Faktor haben.
119+
120+
## Probleme bei der Anmeldung
121+
122+
| Problem | Lösung |
123+
|---|---|
124+
| Passwort vergessen | [Passwort zurücksetzen](#passwort-vergessen) |
125+
| 2FA-Gerät verloren | Verwenden Sie einen Backup-Code oder wenden Sie sich an den [Support](../kontakt.md) |
126+
| Konto gesperrt | Wenden Sie sich an Ihre zuständige IT-Stelle oder an den [Support](../kontakt.md) |
127+
| Fehlermeldung beim Login | Prüfen Sie Ihre Internetverbindung und versuchen Sie es erneut. Bei anhaltenden Problemen wenden Sie sich an den [Support](../kontakt.md) |
128+
129+
<!-- TODO: Häufige Fehlermeldungen und deren Lösungen ergänzen -->

‎content/erste-schritte/index.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: Erste Schritte
3+
description: Einstieg in admin.digital — Anmeldung, Navigation und erste Orientierung
4+
---
5+
6+
# Erste Schritte
7+
8+
!!! warning "Entwurf"
9+
Diese Seite befindet sich im Aufbau. Inhalte können sich jederzeit ändern.
10+
11+
Willkommen bei admin.digital! Diese Seite hilft Ihnen beim Einstieg in die Plattform. In wenigen Schritten sind Sie startklar.
12+
13+
## So starten Sie
14+
15+
<div class="grid cards" markdown>
16+
17+
- :material-numeric-1-circle-outline:{ .lg .middle } **Zugang erhalten**
18+
19+
---
20+
21+
Ihr Kanton oder Ihre Gemeinde stellt Ihnen die Zugangsdaten zur Verfügung. Falls Sie noch keine Zugangsdaten erhalten haben, wenden Sie sich an Ihre zuständige Stelle.
22+
23+
<!-- TODO: Link zu einer Seite mit Informationen zur Beantragung von Zugangsdaten -->
24+
25+
- :material-numeric-2-circle-outline:{ .lg .middle } **Anmelden**
26+
27+
---
28+
29+
Melden Sie sich mit Ihren Zugangsdaten auf der Plattform an. Eine detaillierte Anleitung finden Sie auf der Seite [Anmeldung](anmeldung.md).
30+
31+
- :material-numeric-3-circle-outline:{ .lg .middle } **Plattform kennenlernen**
32+
33+
---
34+
35+
Nach der Anmeldung gelangen Sie zur Übersicht. Von dort aus können Sie auf die für Ihre Verwaltung freigeschalteten Module zugreifen.
36+
37+
<!-- TODO: Link zu einer Seite mit Übersicht der Benutzeroberfläche -->
38+
39+
- :material-numeric-4-circle-outline:{ .lg .middle } **Loslegen**
40+
41+
---
42+
43+
Nutzen Sie die verfügbaren [Module](../module/index.md), um Ihre Verwaltungsaufgaben digital zu erledigen. Bei Fragen hilft Ihnen das [FAQ](../faq/index.md) oder der [Support](../kontakt.md).
44+
45+
</div>
46+
47+
## Anleitungen
48+
49+
| Thema | Beschreibung |
50+
|---|---|
51+
| :material-login: [Anmeldung](anmeldung.md) | Anmeldung auf der Plattform, Passwort und Zwei-Faktor-Authentifizierung |
52+
53+
<!-- TODO: Weitere Anleitungen ergänzen, z.B. Navigation, Profilverwaltung, Benachrichtigungen -->
54+
55+
!!! tip "Brauchen Sie Hilfe?"
56+
Falls Sie bei der Einrichtung Unterstützung benötigen, finden Sie Ansprechpartner auf der [Kontaktseite](../kontakt.md).

0 commit comments

Comments
 (0)