doytsujin / gitwiki-thesis

The goal of the thesis is to develop an access-controlled wiki system based on Git, with the support of lightweight markup languages. In analysis, the system is defined through the conventional methods. With regard to its requirements, existing open-source wiki systems are reviewed. Solution to their weaknesses are discussed along with the system’s design, according to which it is imple- mented. Finally the automatic testing and the results of the usability testing is commented on.

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 ✨ 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 ❤️

• 🐙: I reviewed
• 🐏: @smoliji suggestions incorporated
• : 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 🐙
• Abstract (cs) 🐙
• Keywords (cs) 🐙
• Abstract 🐙
• Keywords 🐙

Tru sections

Introduction 🐙

Goal 🐙 🐏

Analysis

• Business process 🐙 🐏
• Persona 🐙 🐏
• User access 🐙 🐏
• Requirements 🐙 🐏
• Use case 🐙 🐏

State-of-the-art 🐙 🐏

• Ikiwiki 🐙 🐏
• Gitit 🐙 🐏
• Gollum 🐙 🐏
• Wiki.js 🐙 🐏
• Summary 🐙 🐏

Design 🐙 🐏

• Foundations 🐙 🐏
• Repository Providers 🐙 🐏
• Authentication 🐙 🐏
• Tools 🐙 🐏
• Architecture 🐙 🐏
• Rest API 🐙 🐏
• UI 🐙 🐏
• Front end 🐙 🐏
• Emily 🐙 🐏
• Summary 🐙 🐏

UI wireframe testing 🐙 🐏

Implementation 🐙 🐏

• Tools 🐙 🐏
• Gitolite Permissions 🐙 🐏
• Routes 🐙 🐏
• Nodegit 🐙 🐏
• Emily — synchronized scrolling 🐙 🐏

Testing

• Automatic testing 🐙
• Usability testing 🐙

Conclusion 🐙

Appendix sections

• MI-NUR project highlights 🐙
• Emily user manual 🐙
• Gitwiki user manual 🐙
• Emily logo 🐙
• Gitwiki logo 🐙