Merge branch '1-write-docs' into 'master'

write project docs (mkdocs)

Closes #1

See merge request !1

docs/unified-ticketing/license-softlink.md

+../../LICENSE.md
\ No newline at end of file

docs/unified-ticketing/usage.md

+# Usage
+
+## Add as dependency in own project
+
+This library can be used as maven dependency in an own project.
+
+!!! attention
+    As it is not published to maven central,
+    but the GitLab integrated package registry,
+    you must configure an additional repository in your pom.
+
+__repository config:__
+```xml
+<repository>
+    <id>unified-ticketing</id>
+    <url>https://transfer.hft-stuttgart.de/gitlab/api/v4/projects/154/packages/maven</url>
+</repository>
+```
+
+__dependency information:__
+```xml
+<dependency>
+    <groupId>de.hftstuttgart</groupId>
+    <artifactId>unified-ticketing</artifactId>
+    <version>0.1.0</version>
+</dependency>
+```
+
+??? tip "example how your pom should look like"
+    ```xml
+    <project>
+        <!-- [...] -->
+        <dependencies>
+            <!-- [...] -->
+            <dependency>
+                <groupId>de.hftstuttgart</groupId>
+                <artifactId>unified-ticketing</artifactId>
+                <version>0.1.0</version>
+            </dependency>
+        </dependencies>
+        <!-- [...] -->
+        <repositories>
+            <!-- [...] -->
+            <repository>
+                <id>gitlab-maven</id>
+                <url>https://transfer.hft-stuttgart.de/gitlab/api/v4/projects/154/packages/maven</url>
+            </repository>
+        </repositories>
+        <!-- [...] -->
+    </project>
+    ```
+
+## Use in code
+
+There are two central classes: `TicketSystem` and `Ticket`.
+The majority of the library is written with the fluent-api design pattern.
+
+To begin, you'll need an instance of `TicketSystem`.
+This can be done, by calling the builder mechanism or pass a URI with all needed information.
+
+Using this `TicketSystem` object you can search for tickets in the connected space,
+change and save them or create new tickets.
+
+To get full details of the available API, please switch to the [API docs](../api/index.md).
+There you can find information and examples regarding the generic parts of the library,
+as-well as system specific information, e.g. how an URI instantiation string has to look like, etc.

mkdocs.yml

-site_name: Unified Ticketing Doku
+site_name: Unified Ticketing Docs
 
-repo_name: 'Unified Ticketing Java Bibliothek'
-repo_url: 'https://transfer.hft-stuttgart.de/gitlab/9Lukas5/unified-ticketing'
-edit_uri: 'blob/master/docs/'
 docs_dir: docs
+edit_uri: 'blob/master/docs/'
+repo_name: 'Code on Transfer Portal'
+repo_url: 'https://transfer.hft-stuttgart.de/gitlab/9Lukas5/unified-ticketing'
 
-copyright: 'Copyright © 2020 Hochschule für Technik Stuttgart'
+copyright: 'Copyright © 2020 University for Applied Sciences Stuttgart'
 
 use_directory_urls: false
 
 nav:
   - Home:
     - Index: 'index.md'
+    - Changelog: 'unified-ticketing/changelog-softlink.md'
+    - Usage: 'unified-ticketing/usage.md'
+    - Contributing: 'unified-ticketing/contributing.md'
+    - License: 'unified-ticketing/license-softlink.md'
+  - API:
+    - Index: 'api/index.md'
+    - Core:
+      - Logging: 'api/core/logging.md'
+      - Ticket: 'api/core/ticket.md'
+      - Ticketsystem: 'api/core/ticket-system.md'
+    - Exceptions: 'api/exceptions.md'
+    - Systems:
+        - GitLab:
+          - Ticket: 'api/systems/gitlab/ticket.md'
+          - Ticketsystem: 'api/systems/gitlab/ticket-system.md'
+  - Developers Guide:
+    - Machine Setup: 'developers-guide/machine-setup.md'
+    - Styleguide: 'developers-guide/styleguide.md'
+    - UML Diagram: 'developers-guide/uml.md'
+    - Workflow: 'developers-guide/workflow.md'
 
 theme:
+  features:
+    - navigation.tabs
+  icon:
+    logo: material/book-open
+  language: 'en'
   name: 'material'
   palette:
-    primary: 'white'
-    accent: 'teal'
-  language: 'en'
-  feature:
-    tabs: true
-  logo:
-    icon: library_books
+    accent: 'blue'
+    primary: 'red'
 
 markdown_extensions:
-- admonition
-- codehilite:
-    linenums: true
-- toc:
-    permalink: True
-- footnotes
-- tables
-- plantuml_markdown:
-    server: http://plantuml.com/plantuml
-    format: svg
-- pymdownx.emoji:
-    emoji_generator: !!python/name:pymdownx.emoji.to_svg
-- pymdownx.tasklist
-- pymdownx.details
-- pymdownx.superfences
+  - admonition
+  - attr_list
+  - footnotes
+  - markdown_del_ins
+  - plantuml_markdown:
+      format: svg
+      server: http://plantuml.com/plantuml
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.highlight:
+      linenums: true
+  - pymdownx.superfences
+  - pymdownx.tabbed
+  - pymdownx.tasklist
+  - toc:
+      permalink: True
+  - tables

requirements.txt

+certifi~=2020.11
+markdown_del_ins~=1.0
 Markdown~=3.1
+mkdocs-material~=6.0
 mkdocs~=1.0
-mkdocs-material~=4.0
-plantuml~=0.2
 plantuml-markdown~=3.1
-pymdown-extensions~=6.2
-certifi~=2019.9
+plantuml~=0.2
+pymdown-extensions~=8.0