initial README and docs taken over and adapted from membersteward-repo

doc/source/architecture/erdmodel.plantuml.txt

@@ -0,0 +1,98 @@
+@startuml
+
+' hide the spot
+hide circle
+
+' avoid problems with angled crows feet
+skinparam linetype ortho
+
+entity "user" as user {
+  *user_id : number <<generated>>
+  --
+  *nickname : text
+  *pronouns : text
+  *address_1_name: text
+  *address_2_additional: text
+  *address_4_street: text
+  *adress_house_number: text
+  *adress_city_code: text
+  *adress_country: text
+  *Ehrenaemter: text
+  *gravatar_email : text
+  *Freitext: text
+}
+
+entity user_skill {
+user_id: id
+skill_id: id
+--
+level: number
+}
+
+entity user_language {
+user_id: id
+language_id: id
+--
+level: number
+}
+
+entity skill {
+  skill_id
+--
+  *name: text
+}
+
+entity user_experience {
+  user_id
+--
+  description
+  start: date
+  end: date
+}
+
+entity user_search_topic {
+user_id
+topic_id
+}
+
+entity user_contact {
+user_id
+contact_type_id
+--
+content_: text
+}
+
+entity topic {
+  topic_id
+--
+  *name: text
+}
+
+entity language {
+    id
+  --
+    name: text
+}
+
+entity experience {
+    id
+  --
+    name: text
+}
+
+entity contact_types {
+  id
+--
+  name
+}
+
+user ||--o{ user_skill : user_has_skills
+user_skill ||-o{ skill
+user ||--o{ user_experience : user_has_experience
+user_experience ||-o{ experience : user_experience_is_tagged_with
+user ||-o{ user_language : user_speaks_language
+user_language||-{ language
+user ||-o{ user_search_topic
+user_search_topic ||-o{ topic
+
+@enduml

doc/source/architecture/overview.rst

@@ -0,0 +1,52 @@
+Architecture
+############
+
+Systembeschreibung
+==================
+
+Die Kompentenzinventar-Software dient zur:
+
+- Eintragung und Speicherung von Nutzerprofilen
+- Suche nach Nutzerprofilen mit geeigneten Erfahrungen
+
+Kompetenzinventar - Anforderungen
+*********************************
+
+- Kompetenz Verwaltung aller WTF Member (aktuell ca. 150) Tendenz stark wachsen
+- Einfache Verwaltung eigener Kompetenzen, Business Wünsche
+- Einfache Suche von Fähigkeiten
+- Netzwerk
+- Nur für Interne Verwendung
+- xing aber intern
+- Auf der Seite müssen SKills, Erfahrungen und Projektwünsche skizziert werden können
+- Z.b. Scammo, Flensburg, Kann: Javascript, Vue, Projekte, PHP, Events Sucht: Projekte als Freelancer 8-40H; Spricht Deutsch und English; 
+- Muss einfach für die Member erreichbar sein; Primär die Pflege der Daten
+- Sollte auch Member abholen, die nicht so viel Zeit bei der WTF
+  verbringen
+
+Technisch
+---------
+
+- Muss WTF gehostet sein
+- Bus Faktor aka Es darf nicht alles von einen Menschen abhängig machen
+- Möglichst Resourcen Schonend in Entwicklung und Betrieb
+
+Systemkontext
+=============
+
+.. uml:: systemcontext.plantuml.txt
+
+Use cases
+=========
+
+Nutzerprofilverwaltung
+**********************
+
+Suche nach Mitgliedern
+**********************
+
+Datenmodell
+===========
+
+.. uml:: erdmodel.plantuml.txt
+

doc/source/architecture/systemcontext.plantuml.txt

@@ -0,0 +1,12 @@
+@startuml
+   () "REST Api" as api
+
+   node ki
+   node openldap
+   node smtp
+
+   api -- [ki]
+
+   ki --> openldap: openldap provides user authentification
+   ki --> smtp: send mails to users
+@enduml