[Task]: Write Documentation

KSS-Dokumentation/Doku_Microservice_Warenwirtschaft/Kapitel/GettingStarted.tex

@@ -1,2 +0,0 @@
-\section{Getting Started}
-\label{sec: Getting Started}

documentation/handout_adminfrontend/Header.tex

@@ -28,7 +28,7 @@
 \usepackage{enumerate}						% Nummerierung
 \usepackage{enumitem}						% Nummerierung
 \usepackage{tabularx}						% Tabellen
-
+\usepackage{censor}							% SChwärzen von Informationen
 
 % ---- Farben -----------------------------------------------------------------------------------------------
 \definecolor{listings}{RGB}{226,226,226}
@@ -110,7 +110,7 @@ xrightmargin=0pt,
 % ---- Definitionen -----------------------------------------------------------------------------------------
 %------------------------------------------------------------------------------------------------------------
 \title{KSS - Nachhaltige Softwarearchitektur komplexer Websites}
-\author{Merle Labusch, Martin Müller}
+\author{Studenten der Hochschule Bremen}
 
 
 
@@ -122,7 +122,7 @@ xrightmargin=0pt,
 \chead{}
 \ohead{\includegraphics[width=3cm]{./hs-logo.png}}
 
-\ifoot{\normalfont M.Labusch, M.Müller}
+\ifoot{\normalfont \censor{M.Labusch}, \censor{M.Müller}}
 \cfoot{}
 \ofoot{\normalfont 1/1}
 
@@ -132,6 +132,6 @@ xrightmargin=0pt,
 \hypersetup{
 	pdftitle = {Dokumentation - Microservice Warenwirtschaft},
 	pdfsubject = {Nachhaltige Softwarearchitektur komplexer Websites},
-	pdfauthor = {Merle Labusch, Martin Müller},
+	pdfauthor = {Studenten der Hochschule Bremen},
 	pdfkeywords = {Hochschule Bremen, Masterstudiengang Komplexe Softwaresysteme, Softwarearchitektur, Nachhaltigkeit, Docker, Go}
 }

documentation/handout_adminfrontend/handout_frontend.tex

@@ -1,8 +1,7 @@
 %------------------------------------------------------------------------------------------------------------
-%------------------------------------------------------------------------------------------------------------
+%------------------------------------------------------------------------------------------------------------         
-% ----    Merle Labusch             
 % ----    Komplexe Softwaresysteme (M.Sc.) 
-% ----    Hochschule Bremen         
+% ----    Hochschule Bremen - City University of Applied Sciences    
 %------------------------------------------------------------------------------------------------------------
 %------------------------------------------------------------------------------------------------------------
 
@@ -15,12 +14,6 @@
 
 \section*{Handout Admin-Frontend Warenwirtschaft}
 
-
-\begin{itemize}
-	\item \textcolor{red}{ToDo: kurze Beschreibung}
-\end{itemize}
-
-
 \begin{figure}[H]
 	\begin{center}
 	\includegraphics[width=0.65 \textwidth]{./dummy.png}
@@ -29,5 +22,13 @@
 \end{figure}
 
 
+\begin{itemize}
+	\item \textit{Hinzufügen:} Neue Waren in den Bestand aufnehmen
+	\item \textit{Entfernen:} Waren manuell aus dem Bestand entfernen
+	\item \textit{...:} ...
+	
+\end{itemize}
+
+
 
 \end{document}

documentation/microservice_stock/chapter/GettingStarted.tex

@@ -0,0 +1,7 @@
+\section{Getting Started}
+\label{sec: Getting Started}
+Um den Microservice zu starten, muss die folgende Befehlszeile in dem Hauptverzeichnis des Microservice aufgerufen werden.
+
+\begin{lstlisting}[caption=Getting Started]
+go run main.go
+\end{lstlisting}

documentation/microservice_stock/chapter/Handout.tex

@@ -4,7 +4,7 @@
 
 \begin{figure}[H]
 	\begin{center}
-	\includegraphics[width=0.65 \textwidth]{./Bilder/dummy.png}
+	\includegraphics[width=0.65 \textwidth]{./pics/dummy.png}
 	\end{center}
 	\caption{Handout zum Admin-Frontend}
 	\label{pic: Handout zum Admin-Frontend}

documentation/microservice_stock/chapter/Header.tex

@@ -1,4 +1,3 @@
-
 \documentclass[11pt, a4paper]{article}
 
 \usepackage[ngerman]{babel}					% Deutsches Wörterbuch und Zeilenumbrüche
@@ -28,7 +27,7 @@
 \usepackage{enumerate}						% Nummerierung
 \usepackage{enumitem}						% Nummerierung
 \usepackage{tabularx}						% Tabellen
-
+\usepackage{censor}							% Schärzen von Informationen
 
 % ---- Farben -----------------------------------------------------------------------------------------------
 \definecolor{listings}{RGB}{226,226,226}
@@ -84,7 +83,7 @@
 % ---- Listings ----------------------------------------------------------------------------------------------
 \lstset{
 basicstyle=\ttfamily\color{black}\small,
-backgroundcolor=\color{veryverylightgray},
+backgroundcolor=\color{listings},
 keywordstyle=\color{black}, 
 identifierstyle=\color{black}, 
 commentstyle=\color{black}, 
@@ -113,7 +112,7 @@ xrightmargin=0pt,
 % ---- Definitionen -----------------------------------------------------------------------------------------
 %------------------------------------------------------------------------------------------------------------
 \title{KSS - Nachhaltige Softwarearchitektur komplexer Websites}
-\author{Merle Labusch, Martin Müller}
+\author{Studenten der Hochschule Bremen}
 
 
 
@@ -123,9 +122,9 @@ xrightmargin=0pt,
 %i - innen, c - mitte, o - außen
 \ihead{ \normalfont \headmark}
 \chead{}
-\ohead{\includegraphics[width=3cm]{./Bilder/hs-logo.png}}
+\ohead{\includegraphics[width=3cm]{./pics/hs-logo.png}}
 
-\ifoot{\normalfont M.Labusch, M.Müller}
+\ifoot{\normalfont \censor{M.Labusch}, \censor{M.Müller}}
 \cfoot{}
 \ofoot{\normalfont \pagemark}
 
@@ -135,6 +134,6 @@ xrightmargin=0pt,
 \hypersetup{
 	pdftitle = {Dokumentation - Microservice Warenwirtschaft},
 	pdfsubject = {Nachhaltige Softwarearchitektur komplexer Websites},
-	pdfauthor = {Merle Labusch, Martin Müller},
+	pdfauthor = {Studenten der Hochschule Bremen},
 	pdfkeywords = {Hochschule Bremen, Masterstudiengang Komplexe Softwaresysteme, Softwarearchitektur, Nachhaltigkeit, Docker, Go}
 }

documentation/microservice_stock/chapter/Steckbrief.tex

@@ -3,7 +3,7 @@
 
 \begin{figure}[H]
 	\begin{center}
-	\includegraphics[width=0.65 \textwidth]{./Bilder/struktur.png}
+	\includegraphics[width=0.65 \textwidth]{./pics/struktur.png}
 	\end{center}
 	\caption{Microservice Warenwirtschaft}
 	\label{pic: Microservice Warenwirtschaft}

documentation/microservice_stock/chapter/Struktur.tex

@@ -5,7 +5,7 @@ Der Microservice nutzt anstelle einer klassischen Datenbank eine In-Memory-Daten
 
 \begin{figure}[H]
 	\begin{center}
-	\includegraphics[width=0.65 \textwidth]{./Bilder/struktur.png}
+	\includegraphics[width=0.65 \textwidth]{./pics/struktur.png}
 	\end{center}
 	\caption{Struktur des Microservice}
 	\label{pic:Struktur des Microservice}

documentation/microservice_stock/chapter/Titelseite.tex

@@ -9,7 +9,7 @@
 
 \vspace{5cm}
 
- 	\includegraphics[width=0.50\textwidth]{./Bilder/hs-logo.png}
+ 	\includegraphics[width=0.50\textwidth]{./pics/hs-logo.png}
 
 \vspace{3cm}
 
@@ -45,12 +45,12 @@ Studiengang Komplexe Softwaresysteme (M.Sc.)
 
 
 Eingereicht von\\
-\textsc{Merle Labusch} und \textsc{Martin Müller}\\
+\censor{\textsc{Merle Labusch}} und \censor{\textsc{Martin Müller}}\\
 
 \vspace{1cm}
 
 Dozenten\\
-\textsc{Matthias Stock, Renzo Kottmann}\\
+\censor{\textsc{Matthias Stock, Renzo Kottmann}}\\
 
 \vspace{3cm}
 

documentation/microservice_stock/documentation.tex

@@ -1,21 +1,20 @@
 %------------------------------------------------------------------------------------------------------------
-%------------------------------------------------------------------------------------------------------------
+%------------------------------------------------------------------------------------------------------------           
-% ----    Merle Labusch             
 % ----    Komplexe Softwaresysteme (M.Sc.) 
-% ----    Hochschule Bremen         
+% ----    Hochschule Bremen - City University of Applied Sciences      
 %------------------------------------------------------------------------------------------------------------
 %------------------------------------------------------------------------------------------------------------
 
 
-\input{./Kapitel/Header}
+\input{./chapter/Header}
 
 
 \begin{document}
 \pagenumbering{gobble}
 \pagenumbering{Roman}
 
-\input{./Kapitel/Titelseite}\clearpage \newpage
+\input{./chapter/Titelseite}\clearpage \newpage
-\input{./Kapitel/Steckbrief} \newpage
+\input{./chapter/Steckbrief} \newpage
 
 {
 \setlength{\parskip}{0pt}
@@ -26,19 +25,19 @@
 
 \pagenumbering{arabic}
 
-\input{./Kapitel/DokStruktur} \newpage
+\input{./chapter/DokStruktur} \newpage
-\input{./Kapitel/Anforderungen} \newpage
+\input{./chapter/Anforderungen} \newpage
-\input{./Kapitel/Struktur} \newpage
+\input{./chapter/Struktur} \newpage
-\input{./Kapitel/Implementierungsregeln}\newpage
+\input{./chapter/Implementierungsregeln}\newpage
-\input{./Kapitel/Testfalle} \newpage
+\input{./chapter/Testfalle} \newpage
 
 
 \clearpage
 \appendix
 \phantomsection
 \addcontentsline{toc}{section}{\appendixname}
-\input{./Kapitel/GettingStarted} \newpage 
+\input{./chapter/GettingStarted} \newpage 
-\input{./Kapitel/Handout} \newpage
+\input{./chapter/Handout} \newpage
-\input{./Kapitel/Testprotokoll} 
+\input{./chapter/Testprotokoll} 
 
 \end{document}