Skip to content

Commit 6c59742

Browse files
committed
📝 initial docs
1 parent b423e54 commit 6c59742

File tree

4 files changed

+57
-0
lines changed

4 files changed

+57
-0
lines changed

docs/deployment-p13n.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# dbs-p13n-service
2+
3+
| Property | Description | Default |
4+
|----------|-------------|---------|
5+
6+
# dbs-p13n-webcomponents
7+
8+
There are multiple webcomponents available which should be integrated to separate pages of your frontend.
9+
10+
1. Add import to your page `<script src="<host>/loader-<component-name>-webcomponent.js" type="module"></script>`
11+
2. Add the element to your page with the appropriate configuration.
12+
13+
## `checklist-overview`
14+
15+
| Property | Type | Description | Default |
16+
|------------------------|--------|----------------------------------|---------|
17+
| `checklist-detail-url` | string | URL to the checklist detail page | - |
18+
19+
## `checklist-detail`
20+
21+
| Query-Parameter | Description |
22+
|-----------------|--------------------------------|
23+
| `cl-id` | ID of the checklist to display |
24+
25+
## `my-checklists`
26+
27+
| Property | Type | Description | Default |
28+
|------------------------|--------|----------------------------------|---------|
29+
| `checklist-detail-url` | string | URL to the checklist detail page | - |
30+
| `new-checklist-url` | string | URL to the new checklist page | - |

docs/deployment.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
The DBS consists of multiple modules, each of which can be used independently. The deployment docs provide detailed instructions on how to set up and configure each of the modules.
2+
3+
# dbs-ticketing
4+
5+
WIP
6+
7+
# [dbs-p13n](/deployment-p13n)

docs/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,14 @@ layout: home
55
hero:
66
name: "DBS"
77
text: "Documentation for the Digital Citizen Service of the City of Munich"
8+
9+
features:
10+
- title: "Introduction"
11+
icon: 📖
12+
details: "Read more about what the DBS is and how it works."
13+
link: /introduction
14+
- title: "Deployment"
15+
icon: 🛠️
16+
details: "Documentation on how to deploy the DBS."
17+
link: /deployment
818
---

docs/introduction.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
The DBS (Digitaler Bürgerservice / Digital Citizen Service) is a digital service provided by the government of the city of munich.
2+
3+
It currently consists of these modules:
4+
5+
- DBS-Ticketing
6+
- DBS-P13N
7+
- DBS-Login
8+
- Terminvereinbarung (https://github.com/it-at-m/eappointment)
9+
10+
🚧 TODO

0 commit comments

Comments
 (0)