Git-based Wiki System

Text of my master's thesis. I actually used it formally for the development of the text. After the submission it is just a keepsake. A cool :sparkles: one though.

Result PDFs

You can find them at releases (where I always used to publish new PDFs for each version... ah, memories), or render them yourself!

Thesis

make arara For full blown render (re-render diagrams, transform all markdown sources, bibtex and multiple xelatex passes)

make pdf for only minor changes (only latex + markdown, one pass)

Defense

1. make diagrams (if not created from thesis)
2. make defense

Requirements

Not sure it’s complete. More like notes for myself anyway.

• xelatex (typesetting)
• texlive-full (probably too greedy, lazy to nitpick the subpackages)
• pandoc (for markdown to latex)
• plantuml (for UML diagrams; must be available under this name in PATH)
• inkscape (for SVG to PDF)

Current state of the sections

This is irrelevant now, that it's finished. Left here from nostalgia :heart:

• :octopus:: I reviewed
• :ram:: @smoliji suggestions incorporated
• :feelsgood:: The fascist version of myself on crack reviewed. Replacing informal words, depersonalizing, removing time references and generally making the text more boring to read.

Meta sections

• Acknowledgements :octopus:
• Abstract (cs) :octopus: :feelsgood:
• Keywords (cs) :octopus:
• Abstract :octopus: :feelsgood:
• Keywords :octopus:

Tru sections

Introduction :octopus: :feelsgood:

Goal :octopus: :ram: :feelsgood:

Analysis

• Business process :octopus: :ram: :feelsgood:
• Persona :octopus: :ram: :feelsgood:
• User access :octopus: :ram: :feelsgood:
• Requirements :octopus: :ram: :feelsgood:
• Use case :octopus: :ram: :feelsgood:

State-of-the-art :octopus: :ram: :feelsgood:

• Ikiwiki :octopus: :ram: :feelsgood:
• Gitit :octopus: :ram: :feelsgood:
• Gollum :octopus: :ram: :feelsgood:
• Wiki.js :octopus: :ram: :feelsgood:
• Summary :octopus: :ram: :feelsgood:

Design :octopus: :ram: :feelsgood:

• Foundations :octopus: :ram: :feelsgood:
• Repository Providers :octopus: :ram: :feelsgood:
• Authentication :octopus: :ram: :feelsgood:
• Tools :octopus: :ram: :feelsgood:
• Architecture :octopus: :ram: :feelsgood:
• Rest API :octopus: :ram: :feelsgood:
• UI :octopus: :ram: :feelsgood:
• Front end :octopus: :ram: :feelsgood:
• Emily :octopus: :ram: :feelsgood:
• Summary :octopus: :ram: :feelsgood:

UI wireframe testing :octopus: :ram: :feelsgood:

Implementation :octopus: :ram: :feelsgood:

• Tools :octopus: :ram: :feelsgood:
• Gitolite Permissions :octopus: :ram: :feelsgood:
• Routes :octopus: :ram: :feelsgood:
• Nodegit :octopus: :ram: :feelsgood:
• Emily — synchronized scrolling :octopus: :ram: :feelsgood:

Testing

• Automatic testing :octopus: :feelsgood:
• Usability testing :octopus: :feelsgood:

Conclusion :octopus: :feelsgood:

Appendix sections

• MI-NUR project highlights :octopus:
• Emily user manual :octopus:
• Gitwiki user manual :octopus:
• Emily logo :octopus:
• Gitwiki logo :octopus: