Merge pull request #17 from it-at-m/docs/initial-p13n-docs

📝 initial docs

Author: FabianWilms

docs/deployment-p13n.md

@@ -0,0 +1,32 @@
+# Deployment dbs-p13n
+
+## dbs-p13n-service
+
+| Property | Description | Default |
+| -------- | ----------- | ------- |
+
+## dbs-p13n-webcomponents
+
+There are multiple webcomponents available which should be integrated to separate pages of your frontend.
+
+1. Add import to your page `<script src="<host>/loader-<component-name>-webcomponent.js" type="module"></script>`
+2. Add the element to your page with the appropriate configuration.
+
+### `checklist-overview`
+
+| Property               | Type   | Description                      | Default |
+| ---------------------- | ------ | -------------------------------- | ------- |
+| `checklist-detail-url` | string | URL to the checklist detail page | -       |
+
+### `checklist-detail`
+
+| Query-Parameter | Description                    |
+| --------------- | ------------------------------ |
+| `cl-id`         | ID of the checklist to display |
+
+### `my-checklists`
+
+| Property               | Type   | Description                      | Default |
+| ---------------------- | ------ | -------------------------------- | ------- |
+| `checklist-detail-url` | string | URL to the checklist detail page | -       |
+| `new-checklist-url`    | string | URL to the new checklist page    | -       |

docs/deployment.md

@@ -0,0 +1,9 @@
+# Deployment
+
+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.
+
+## dbs-ticketing
+
+WIP
+
+## [dbs-p13n](/deployment-p13n)

docs/index.md

@@ -5,4 +5,14 @@ layout: home
 hero:
   name: "DBS"
   text: "Documentation for the Digital Citizen Service of the City of Munich"
+
+features:
+  - title: "Introduction"
+    icon: 📖
+    details: "Read more about what the DBS is and how it works."
+    link: /introduction
+  - title: "Deployment"
+    icon: 🛠️
+    details: "Documentation on how to deploy the DBS."
+    link: /deployment
 ---

docs/introduction.md

@@ -0,0 +1,12 @@
+# Introduction
+
+The DBS (Digitaler Bürgerservice / Digital Citizen Service) is a digital service provided by the government of the city of munich.
+
+It currently consists of these modules:
+
+- DBS-Ticketing
+- DBS-P13N
+- DBS-Login
+- Terminvereinbarung (<https://github.com/it-at-m/eappointment>)
+
+🚧 TODO