Merge pull request 'Added Dockerfile & docker build instructions' (#54) from dockerize into master

Reviewed-on: kompetenzinventar/ki-doku#54

.gitea/issue_template/bug.md

@@ -0,0 +1,37 @@
+---
+
+name: "Bug"
+about: "Fehler melden"
+labels:
+- bug
+
+---
+
+## Zusammenfassung
+
+*hier kurze Beschreibung des Problems einfügen*
+
+## Schritte zum Nachstellen des Problems
+
+*hier Schritte so auffschreiben, dass der Fehler nachgestellt werden kann, z.B.*
+
+- Ich öffne die URL X
+- Ich gebe `blubb` in das Name Feld ein
+- Ich klicke auf den bunten Knopf
+
+**Erwartetes Verhalten**
+
+*hier hinschreiben, was passieren sollte, z.B.*
+
+Ein Einhorn reitet von links nach rechts über den Bildschirm
+
+**Aktuelles Verhalten**
+
+*hier hinschreiben, was im Moment passiert; ggf. mit Video oder Screenshot ergänzen*
+
+Ein Troll läuft von rechts nach links über den Bildschirm
+
+## Sonstiges
+
+- Betriebssystem (inkl. Version): **z.B. Ubuntu 20.04.3 LTS**
+- Browser (inkl. Version): **z.B. Firefox 95.0.1 (64-bit)**

.gitea/issue_template/enhancement.md

@@ -0,0 +1,24 @@
+---
+
+name: "Feature"
+about: "Ein neues Feature bestellen"
+labels:
+- enhancement
+
+---
+
+## Zusammenfassung
+
+*hier kurze Beschreibung des gewünschten Features einfügen*
+
+## Anwendungsfall
+
+*hier den Anwendungsfall beschreiben*
+
+*Warum möchte ich das haben?*
+
+*Wie soll das neue Feature funktionieren?*
+
+## Anhänge
+
+*gerne Skizzen einfügen*

Dockerfile

@@ -0,0 +1,8 @@
+FROM sphinxdoc/sphinx-latexpdf
+
+RUN pip3 install sphinxcontrib-plantuml
+RUN apt-get update && apt-get install plantuml locales-all -y
+ENV LC_ALL="de_DE.UTF8"
+WORKDIR /doc
+CMD ["make", "latexpdf", "singlehtml"]
+

README.md

@@ -13,28 +13,31 @@ Es existiert jweils ein Repo für den Frontend- und den Backend-Code:
 - https://git.wtf-eg.de/kompetenzinventar/ki-frontend.git
 - https://git.wtf-eg.de/kompetenzinventar/ki-backend.git
 
-## Features ##
-
-TBD
-
-## Contents
-- [Features](#features)
-- [Building](#building)
-- [Contributing](#contributing)
-
 ## Building
 
-building the ki-doku depends on python, sphinx,
+Building the ki-doku depends on the following Python packages:
-sphinx-contrib-plantuml und plantuml.
+* `sphinx`
+* `sphinxcontrib-plantuml`
 
-building/ using the ki-backend depends on python and flask.
+as well as the system dependency `plantuml`, which you can get e.g. with `apt install plantuml`
+
+### Building with Docker
+
+You can also build the docs using docker:
+
+    docker build -t ki-doku-builder .
+    docker run -v $(pwd)/doc:/doc ki-doku-builder
+
+    # results:
+    #   ./doc/build/latex/kompetenzinventar.pdf
+    #   ./doc/build/singlehtml/
+
+Warning: the builder uses the `sphinx-latexpdf` base image, which contains an entire texlive environment, making it very large (~2.9G).
 
-<!-- ROADMAP -->
 ## Roadmap
 
 See the [open issues](https://github.com/github_username/repo_name/issues) for a list of proposed features (and known issues).
 
-<!-- CONTRIBUTING -->
 ## Contributing
 
 Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
@@ -45,23 +48,14 @@ Contributions are what make the open source community such an amazing place to b
 4. Push to the Branch (`git push origin feature/AmazingFeature`)
 5. Open a Pull Request
 
+(Pull requests currently require an account on our private gitea, but we faithfully await deliverance from our federated [lord and saviour](forgefed.org).)
 
-<!-- LICENSE -->
 ## License
 
 Distributed under the ??? License. See `LICENSE` for more information.
 
-<!-- CONTACT -->
 ## Contact
-<!--
+
-Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email
- -->
 Project Link: [https://git.wtf-eg.de/kompetenzinventar](https://git.wtf-eg.de/kompetenzinventar)
 
 
-<!-- ACKNOWLEDGEMENTS -->
-## Acknowledgements
-
-* []()
-* []()
-* []()

doc/source/architecture/erdmodel.plantuml.txt

@@ -9,28 +9,52 @@ skinparam linetype ortho
 entity "user" as user {
   *id : number <<generated>>
   --
-  *nickname : text(25)
+  *auth_id : text(50)
-  *created: datetime
+'  *created: datetime
-  *updated: datetime
+'  *updated: datetime
 }
 
-entity user_profile {
+entity tag {
   *id : number <<generated>>
-  *userid
+  *tag_type_id
+--
+  *name: text
+}
+
+entity tag_type {
+  *id : number <<generated>>
+--
+  *name: text
+}
+
+tag_type ||--o{ tag
+
+entity profile {
+  *id : number <<generated>>
+  *user_id
   --
+  *nick_name : text(25)
   pronouns : text(25)
   fullname: text(100)
   volunteerwork: text(4000) 
   freetext: text(4000)
-  *profile_visible: bool
+  visible: bool
   *created: datetime
   *updated: datetime
 }
-user ||-o{ user_profile : user_has_profile
+user ||-o{ profile : user_has_profile
 
-entity user_address {
+entity token  {
   *id : number <<generated>>
-  *userid
+  *user_id
+  --
+  *token : text(36)
+}
+user ||-o{ token : user_has_token
+
+entity profile_address {
+  *id : number <<generated>>
+  *profile_id
   --
   street: text(25)
   house_number: text(10)
@@ -39,52 +63,40 @@ entity user_address {
   city: text(25)
   country: text(25)
 }
-user ||-o{ user_address : user_has_address
+profile ||-o{ profile_address : profile_has_address
 
-entity user_skill {
+entity profile_skill {
-*user_id: id
+*profile_id: id
 *skill_id: id
 --
-level: number
+*level: number
 }
 
-entity user_language {
+entity profile_language {
-*user_id: id
+*profile_id: id
 *language_id: id
 --
 level: number
 }
 
-entity skill {
+entity profile_experience {
   *id : number <<generated>>
---
+  *profile_id
-  *name: text(25) 
-}
-
-entity user_experience {
-  *id : number <<generated>>
-  *user_id
 --
   description
   start: date
   end: date
 }
 
-entity user_experience_experience {
+entity profile_experience_experience {
-  *user_experience_id
+  *profile_experience_id
   *experience_id
 }
 
-user ||--o{ user_experience : user_has_experience
+profile ||--o{ profile_experience : user_has_experience
-user_experience ||--o{ user_experience_experience : user_experience_is_tagged_with
+profile_experience ||--o{ profile_experience_experience : user_experience_is_tagged_with
-
-entity experience {
-  *id : number <<generated>>
-  --
-  *name: text(25) 
-}
-user_experience_experience }o--|| experience 
 
+profile_experience_experience }o--|| tag 
 
 entity user_search_topic {
   *user_id
@@ -92,20 +104,14 @@ entity user_search_topic {
 --
 }
 
-entity user_contact {
+entity profile_contact {
   *id : number <<generated>>
-  *user_id
+  *profile_id
   *contact_type_id
 --
   *content: text(200)
 }
 
-entity topic {
-  *id : number <<generated>>
---
-  *name: text
-}
-
 entity language {
   *id : number <<generated>>
   --
@@ -118,16 +124,16 @@ entity contact_type {
   *name: text(25) 
 }
 
-user ||--o{ user_skill : user_has_skills
+profile ||--o{ profile_skill : user_has_skills
-user_skill ||--o{ skill
+profile_skill ||--o{ tag
 
-user ||--o{ user_language : user_speaks_language
+profile ||--o{ profile_language : user_speaks_language
-user_language||--{ language
+profile_language||--{ language
 
 user ||--o{ user_search_topic
-user_search_topic ||--o{ topic
+user_search_topic ||--o{ tag
 
-user ||-o{ user_contact
+profile ||-o{ profile_contact
-user_contact ||-o{ contact_type
+profile_contact ||-o{ contact_type
 
 @enduml