PW-29 Update documents

hqq

@@ -0,0 +1,86 @@
+commit 7afa84e812d1c3b192392260cd9a5565a2cb3215 (HEAD -> PW-29_update-documents)
+Author: Karin Maliniaková <[email protected]>
+Date:   Thu Nov 19 17:43:04 2020 +0100
+
+    PW-29 add zapisnice
+
+commit 648a3d006b4f617dce01ab8cc718c133e69c8c2a (origin/master, origin/HEAD, master)
+Merge: a44c7b4 a1ec341
+Author: František Gič <[email protected]>
+Date:   Fri Nov 6 11:09:55 2020 +0100
+
+    Merge pull request #1 from P3K-TEAM/FRON-17-define-git-methodology
+
+    FRON-17 Define git methodology
+
+commit a1ec341220c22feb74390e6469ad2d91f17a116d (origin/FRON-17-define-git-methodology)
+Author: František Gič <[email protected]>
+Date:   Fri Nov 6 11:02:33 2020 +0100
+
+    FRON-17 Define more detailed guidelines for creating pull request
+
+commit 279fdea23f6f888d190d2d2b9b7643156f22cb45
+Author: František Gič <[email protected]>
+Date:   Fri Nov 6 10:44:43 2020 +0100
+
+    FRON-17 Format title page meta information into table
+
+commit 1d0246eb9058c2a1bd01157a74e6d6339ded112b
+Author: František Gič <[email protected]>
+Date:   Thu Nov 5 02:19:30 2020 +0100
+
+    FRON-17 Define git methodology
+
+commit a44c7b46aeebf7019f00817111e2fb25a6f03902
+Author: František Gič <[email protected]>
+Date:   Thu Nov 5 00:42:06 2020 +0100
+
+    FRON-17 Rewrite Confluence docs into LaTeX
+
+commit 4bc56c6a956671fdc6553850b75ee846cf59cde0
+Author: František Gič <[email protected]>
+Date:   Thu Nov 5 00:25:12 2020 +0100
+
+    Update README.md
+
+commit 5119a90b4cdfa257372b24d4d579ca20190da27b
+Author: František Gič <[email protected]>
+Date:   Wed Nov 4 23:03:37 2020 +0100
+
+    FRON-17 Add title page template
+
+commit ad2577bbe194cdc4b7adf3163b27cb384b854021
+Author: František Gič <[email protected]>
+Date:   Thu Nov 5 00:20:59 2020 +0100
+
+    Add examples of algorithms and hyperlinks LaTex packages
+
+commit d29764123fcfe39136b54f876913340a1ec6d3e0
+Author: František Gič <[email protected]>
+Date:   Wed Nov 4 21:37:33 2020 +0100
+
+    Add examples
+
+commit 6fae05071f11990bd26d341b4d836d78be4f3a94
+Author: František Gič <[email protected]>
+Date:   Wed Nov 4 19:57:45 2020 +0100
+
+    Add support for importing assets from relative paths such as images
+
+commit a0b79f4ea6fc63377f36f18a20894049ec4b5315
+Author: František Gič <[email protected]>
+Date:   Wed Nov 4 17:31:22 2020 +0100
+
+    Add usage docs
+
+commit 27c7073a0e1c977760bd7bac338c9fda05a65a44
+Author: František Gič <[email protected]>
+Date:   Wed Nov 4 17:28:39 2020 +0100
+
+     Implement function for compiling LaTex files
+
+commit 32e5ec72c8a758386cae9a75d4ea245d0594b8fb
+Author: František Gič <[email protected]>
+Date:   Wed Nov 4 17:25:20 2020 +0100
+
+    Initial commit

src/metodiky/metodika-code-review.tex

@@ -16,14 +16,26 @@
 
     \include{title-page}
 
+    \begin{table}[h]
+        \begin{tabular}{ll}
+            \textbf{Autor:} & Bc. František Gič \\
+            \textbf{Dátum vytvorenia:} & 19.11.2020 \\
+            \\
+            \textbf{Autor poslednej zmeny:} &  \\
+            \textbf{Dátum poslednje zmeny:} &  \\
+            \hline
+        \end{tabular}
+        \label{tab:grades}
+    \end{table}
+
     \section*{Pull Request}
 
     Pull Request (GitHub), alebo Merge Request (GitLab), ďalej už len PR / MR, je žiadosť o vzájomnú kontrolu
     kódu osobami inými ako je autor danej časti zdrojového kódu.
 
     \subsection*{Kedy vytvoriť PR?}
 
-    Pull request je možné vytvoriť v akomkoľvek stave vypracovania úlohy. V prípade že úloha nie je dokončená, sa na začiatok
+    Pull request je možné vytvoriť v akomkoľvek stave vypracovania úlohy. V prípade, že úloha nie je dokončená, sa na začiatok
     názvu PR prilepí skratka \textbf{WIP:} a pokračuje názvom PR.
     Skratka WIP (Work in progress) ostatným developerom značí, že daná časť kódu ešte nie je vhodná na code review.
 

src/metodiky/metodika-definition-of-done.tex

@@ -16,6 +16,18 @@
 
     \include{title-page}
 
+    \begin{table}[h]
+        \begin{tabular}{ll}
+            \textbf{Autor:} & Bc. Karin Maliniaková \\
+            \textbf{Dátum vytvorenia:} & 21.10.2020 \\
+            \\
+            \textbf{Autor poslednej zmeny:} &  \\
+            \textbf{Dátum poslednje zmeny:} &  \\
+            \hline
+        \end{tabular}
+        \label{tab:grades}
+    \end{table}
+
     \noindent \textnormal{Z hľadiska efektívneho vývoja je potrebné definovať kritéria, ktoré musia byť splnené, aby sme danú user story mohli považovať za splnenú.}
 
     \section*{User story}

src/metodiky/metodika-definition-of-ready.tex

@@ -16,6 +16,18 @@
 
     \include{title-page}
 
+    \begin{table}[h]
+        \begin{tabular}{ll}
+            \textbf{Autor:} & Bc. Karin Maliniaková \\
+            \textbf{Dátum vytvorenia:} & 21.10.2020 \\
+            \\
+            \textbf{Autor poslednej zmeny:} &  \\
+            \textbf{Dátum poslednje zmeny:} &  \\
+            \hline
+        \end{tabular}
+        \label{tab:grades}
+    \end{table}
+
     \section*{User story}
 
     \textnormal{User story môže byť označený ako “ready” iba v prípade, že spĺňa všetky nasledujúce kritéria:}

src/metodiky/metodika-git.tex

@@ -18,6 +18,18 @@
 
     \include{title-page}
 
+    \begin{table}[h]
+        \begin{tabular}{ll}
+            \textbf{Autor:} & Bc. František Gič \\
+            \textbf{Dátum vytvorenia:} & 5.11.2020 \\
+            \\
+            \textbf{Autor poslednej zmeny:} &  \\
+            \textbf{Dátum poslednje zmeny:} &  \\
+            \hline
+        \end{tabular}
+        \label{tab:grades}
+    \end{table}
+
     \section*{Úvod}
         \textnormal{%
         Verziovanie zdrojového kódu je jedna z najdôležitejších vecí pre prácu vývojárov v tíme. \\

src/metodiky/metodika-komunikacie-v-time.tex

@@ -16,6 +16,18 @@
 
     \include{title-page}
 
+    \begin{table}[h]
+        \begin{tabular}{ll}
+            \textbf{Autor:} & Bc. Karin Maliniaková \\
+            \textbf{Dátum vytvorenia:} & 21.10.2020 \\
+            \\
+            \textbf{Autor poslednej zmeny:} &  \\
+            \textbf{Dátum poslednje zmeny:} &  \\
+            \hline
+        \end{tabular}
+        \label{tab:grades}
+    \end{table}
+
     \section*{Komunikačné nástroje}
 
         \textnormal{Vzhľadom na situáciu, v ktorej sme sa ocitli v súvislosti s COVID-19 je na našej fakulte dištančná výučba čo spôsobilo, že komunikácia tímu prebieha online. Keďže je viacero rôznych dôvodov na komunikáciu v tíme, preto sme si zvolili aj viacero komunikačných kanálov, kde spolu komunikujeme.}

src/metodiky/metodika-pisania-metodik.tex

@@ -16,11 +16,23 @@
 
     \include{title-page}
 
+    \begin{table}[h]
+        \begin{tabular}{ll}
+            \textbf{Autor:} & Bc. Karin Maliniaková \\
+            \textbf{Dátum vytvorenia:} & 21.10.2020 \\
+            \\
+            \textbf{Autor poslednej zmeny:} & Bc. Karin Maliniaková \\
+            \textbf{Dátum poslednje zmeny:} & 19.11.2020 \\
+            \hline
+        \end{tabular}
+        \label{tab:grades}
+    \end{table}
+
     \section*{Písanie metodiky}
 
         \textnormal{%
         Tému metodiky volíme vždy, tak aby daná metodika bola užitočná a aby zefektívnila nejaký postup alebo zadefinovala určité pojmy. Pri písaní metodiky nie je dôležitý rozsah. Ak je niečo komplikovanejšie a vyžaduje si to podrobnejšie spracovanie, metodika môže mať aj niekoľko strán. Avšak aj sa jedná len o niečo malé stačí aj pár viet. \\\\
-        Metodiku môže vytvoriť ktokoľvek z tímu v nástroji Confluence, podľa základnej šablóny. Dokument s metodikou bude napísaný v slovenskom jazyku a zverejnený v nástroji Confluence a následne po konzultácii s tímom aj na tímovej stránke.
+        Metodiku môže vytvoriť ktokoľvek z tímu v Latexu, podľa základnej šablóny. Dokument s metodikou bude napísaný v slovenskom jazyku, prekonvertovaný do pdf a po konzultácii s tímom aj na tímovom prezentačnom webu. 
         }
 
         \subsection*{Šablóna metodiky}
@@ -32,11 +44,11 @@
             \textnormal{Pri písaní dokumentu by mali byť zachované nasledujúce pravidlá formátovania textu:}
 
             \begin{itemize}
-                \item úrovne nadpisov začínajú od Heading 1 až po Heading 5
-                \item Heading 1 musí mať nastavené formátovanie Bold
-                \item Heading 6 je využívaný na text v úvode (autor, dátum vytvorenia, autor a dátum poslednej zmeny)
+                \item Nadpis - section*
+                \item Normálny text - textnormal
+                \item Odrážky - item
                 \item formátovanie nadpisov musí po sebe logicky nadväzovať (Vzostupne)
-                \item vo vhodných situáciách na sprehľadnenie textu využívame Zoznam s odrážkami alebo Číslovaný zoznam
+                \item •	vo vhodných situáciách na sprehľadnenie textu využívame \emph{Zoznam s odrážkami} (itemize) alebo \emph{Číslovaný zoznam} (enumerate)
                 \item linky na web musia byť uvedené pomocou hypertextových odkazov
             \end{itemize}
 

src/zapisnice/zapisnica7.tex

@@ -51,6 +51,7 @@
             \item Setup Unit testov v Mocha je hotový
             \item Implement modals and alert - skoro hotové
             \item Dorobené úpravy v dizajne frontendu 
+            \item Dorobené úpravy v dizajne frontendu 
             \item Dokumentácia riadenia - skoro hotová
             \item Dokumentácia inžinierskeho diela - začatá
             \item Implement 404 page - hotové

src/zapisnice/zapisnica8.tex

@@ -0,0 +1,85 @@
+\documentclass{article}
+
+\usepackage[margin=2cm]{geometry}
+\usepackage[utf8]{inputenc}
+\usepackage{hyperref}
+
+% Title
+\newcommand{\documenttitle}
+{Zápisnica č. 8}
+
+% Subtitle
+\newcommand{\documentsubtitle}
+{Stretnutie s vedúcim}
+
+\begin{document}
+
+    \include{title-page}
+
+    \begin{table}[h]
+        \begin{tabular}{lllll}
+            \multicolumn{3}{l}{\textbf{Dátum stretnutia:}} & & 20.11.2020 \\
+            \multicolumn{3}{l}{\textbf{Čas stretnutia:}} & & 16:00 - 19:00 hod. \\
+            \multicolumn{3}{l}{\textbf{Prítomní:}} \\
+            & & vedúci: & & Ing. Juraj Petrík \\
+            & & členovia tímu: & & Bc. František Gič  \\
+            & & & & Bc. Oliver Kanát \\
+            & & & & Bc. Karin Maliniaková \\
+            & & & & Bc. Denisa Mensatorisová \\
+            & & & & Bc. Anton Rusňák \\
+            & & & & Bc. Vladimír Svitok \\
+            & & & & Bc. Kristián Toldy \\
+            \multicolumn{3}{l}{\textbf{Neprítomní:}} & & -\\
+            \multicolumn{3}{l}{\textbf{Zapisovateľ:}} & & Bc. Oliver Kanát \\
+        \end{tabular}
+        \label{tab:grades}
+    \end{table}
+
+    \section*{Program:}
+
+    \begin{enumerate}
+        \item Sprint review 
+        \item Retrospektíva
+    \end{enumerate}
+
+    \section*{Sprint Review}
+
+        \textnormal {Pri viacerćy úlohách sa ukázalo, že nie všetky požiadavky boli správne pochopené a preto riešsenie je síce funkčné ale nie je na 100\% podľa predstáv. }
+
+    \section*{Plánovanie šprintu}
+
+    \textnormal {Cieľom šprintu je uploadnuť súbory alebo text, následne na serveri sa vygeneruje IDE do submission a ten sa vrati ako response. Následne sa vytvorí redirekt na result page podľa IDE, kde sa to bude načítavať a keď bude známy výsledok tak sa to zobrazí.}
+
+    \begin{itemize}
+    \item \textbf {PW - Prezentačný web} 
+        \begin{itemize}
+            \item PW32 - Export úloh z Jiry \textbf {@karin}
+            \item PW33 - Napísať moduly systému do dokumentácie inžinierskeho diela \textbf {@karin}
+        \end{itemize}
+    \item \textbf {FRON - Frontend} 
+        \begin{itemize}
+            \item FRON22 - Unit testy \textbf {@fero}
+        \end{itemize}  
+    \item \textbf {BE - Backend} 
+        \begin{itemize}
+            \item BE41 - Implement text upload endpoint (BE40 - Compare documents) \textbf {@vlado}
+            \item BE42 - Create background task for text and file comparison (BE40 - Compare documents) \textbf {@kiko}
+            \item BE46 - Implement universal document model (BE40 - Compare documents) \textbf {@oliver}
+            \item BE47 - Update existing files upload to use new document model (BE40 - Compare documents) \textbf {@vlado}
+            \item BE44 - Implement text extraction method for different types of text files (BE43 - Text extraction from files) \textbf {@dena}
+            \item BE45 - Implement text extraction method from image files (OCR) (BE43 - Text extraction from files) \textbf {@karin}
+            \item BE49 - Find out what the heck Juro's done (BE48 - Juro's crawlers) \textbf {@tono}
+            \item BE50 - Push data from crawler to Elasticsearch (BE48 - Juro's crawlers) \textbf {@tono}
+            \item BE52 - Import wiki to Elasticsearch (BE51 - Playing with corpus) \textbf {@fero}
+            \item BE53 - Import referaty.sk to Elasticsearch (BE51 - Playing with corpus) \textbf {@fero}
+            \item BE54 - Integrate Elasticsearch with django (BE51 - Playing with corpus) \textbf {@oliver}
+            \item BE55 - Search for similar documents in Elastic (BE51 - Playing with corpus) \textbf {@oliver}
+        \end{itemize}        
+    \end{itemize}
+
+    \section*{Poznámky zo stretnutia:}
+
+    \begin{itemize}
+        \item Vytvoriť meeting, kde sa navhrnú endpointy a štruktúra databázy.  
+    \end{itemize}    
+\end{document}

src/zapisnice/zapisnica8_8.tex

@@ -0,0 +1,57 @@
+\documentclass{article}
+
+\usepackage[margin=2cm]{geometry}
+\usepackage[utf8]{inputenc}
+\usepackage{hyperref}
+
+% Title
+\newcommand{\documenttitle}
+{Zápisnica č. 8}
+
+% Subtitle
+\newcommand{\documentsubtitle}
+{Stretnutie v tíme}
+
+\begin{document}
+
+    \include{title-page}
+
+    \begin{table}[h]
+        \begin{tabular}{lllll}
+            \multicolumn{3}{l}{\textbf{Dátum stretnutia:}} & & 25.11.2020 \\
+            \multicolumn{3}{l}{\textbf{Čas stretnutia:}} & & 12:00 - 13:00 hod. \\
+            \multicolumn{3}{l}{\textbf{Prítomní:}} \\
+            & & & & Bc. František Gič  \\
+            & & & & Bc. Oliver Kanát \\
+            & & & & Bc. Karin Maliniaková \\
+            & & & & Bc. Denisa Mensatorisová \\
+            & & & & Bc. Anton Rusňák \\
+            & & & & Bc. Vladimír Svitok \\
+            & & & & Bc. Kristián Toldy \\
+            \multicolumn{3}{l}{\textbf{Neprítomní:}} & & -\\
+            \multicolumn{3}{l}{\textbf{Zapisovateľ:}} & & Bc. Karin Maliniaková \\
+        \end{tabular}
+        \label{tab:grades}
+    \end{table}
+
+    \section*{Program:}
+
+    \begin{enumerate}
+        \item Standup
+        \item Vyriešeniť problém s taskom, ktorý je mimo kapacity tímu na daný šprint 
+    \end{enumerate}
+
+    \section*{Standup}
+
+    \textnormal {Vzhľadom na množstvo práce z iných predmetov členovia tímu ešte nezačali prácu na svojich taskoch. Jediné čo sa zrealizovalo je stretnutie o návrhu jednotlivých endpointov a návhru databázy.}   
+
+    \section*{Poznámky zo stretnutia:}
+
+    \begin{itemize}
+        \item {Na stretnutí Oliver poukázal na chybu, ktorá sa vyskytla pri plánovaní šprintu. Jedna úloha, konkrétne \emph{BE55 - Search for similar documents in Elastic} bola pridelená Oliverovi aj napriek tomu, že už nemal kapacitu na daný šprint.
+        Následne sme zisťovali, či iný člen tímu nemá kapacitu, ktorú by mohol venovať tasku. Po diskusii, sme sa zhodli, že daný task si nemá kto zobrať a v zhľadom na to, že od daného tasku nezávisí žiadna iná úloha v šprinte, dohodli sme sa že navrhneme product ownerovi odobratie tasku zo šprintu. 
+        Pri diskusii sme tiež brali ohľad na to, že v daný šprint máme všetci veľa práce z iných predmetov.}  
+        \item odprezentovanie čo sa dohodlo na utorkovom stretnutí ostatným členom tímu
+    \end{itemize}
+
+\end{document}