genofire/hs_monolith
genofire
/
hs_monolith
Archived
1
0
Fork 0

[Task]: Write Documentation

This commit is contained in:
mlabusch 2017-05-03 07:07:54 +02:00
parent 0b47b3f9c5
commit 7d67e04ce3
23 changed files with 46 additions and 42 deletions

View File

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

View File

@ -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}
}

View File

Before

Width:  |  Height:  |  Size: 6.4 KiB

After

Width:  |  Height:  |  Size: 6.4 KiB

View File

@ -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}

View File

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB

View File

@ -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}

View File

@ -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}

View File

@ -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}
}

View File

@ -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}

View File

@ -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}

View File

@ -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}

View File

@ -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{./Kapitel/Steckbrief} \newpage
\input{./chapter/Titelseite}\clearpage \newpage
\input{./chapter/Steckbrief} \newpage
{
\setlength{\parskip}{0pt}
@ -26,19 +25,19 @@
\pagenumbering{arabic}
\input{./Kapitel/DokStruktur} \newpage
\input{./Kapitel/Anforderungen} \newpage
\input{./Kapitel/Struktur} \newpage
\input{./Kapitel/Implementierungsregeln}\newpage
\input{./Kapitel/Testfalle} \newpage
\input{./chapter/DokStruktur} \newpage
\input{./chapter/Anforderungen} \newpage
\input{./chapter/Struktur} \newpage
\input{./chapter/Implementierungsregeln}\newpage
\input{./chapter/Testfalle} \newpage
\clearpage
\appendix
\phantomsection
\addcontentsline{toc}{section}{\appendixname}
\input{./Kapitel/GettingStarted} \newpage
\input{./Kapitel/Handout} \newpage
\input{./Kapitel/Testprotokoll}
\input{./chapter/GettingStarted} \newpage
\input{./chapter/Handout} \newpage
\input{./chapter/Testprotokoll}
\end{document}

View File

Before

Width:  |  Height:  |  Size: 6.4 KiB

After

Width:  |  Height:  |  Size: 6.4 KiB

View File

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB