use_labdocs

The wiki

Website

The website is available under the URL http://162.38.184.118/wiki/, and can only be accessed from the university network or if logged in via a VPN. It is automatically generated using gollum from a directory containing loose text files and a table of contents (in the file SIDEBAR.md) put under version control using git.

Contribute with the web interface (simple)

You can edit any file in the wiki and add new ones using the menu on top. Please follow these guidelines:

• All documents should be written in valid Markdown syntax. While this syntax is human readable, it is also easy to transfer into html (like for the wiki), LaTex or other formats.
• The files should be placed in the existing folder structure within the wiki and referenced in the SIDEBAR.md file.
• When uploading or creating new files, give them meaningful filenames!

Contribute with your own tools (advanced)

The web interface is limited in some regards, because you can't:

• read or edit the wiki while offline or without a VPN access to the university,
• use a real text editor (gedit, emacs, vim, kate, notepad++...),
• commit under your own name,
• move files into another directory,
• edit files that are broken.

To be able to do this, you have to have your public key appended to gollum's .ssh/authorized_keys (which can be done by anyone who already is authorized) and clone the wiki on your computer.

The following command clone the entire team wiki into a folder named wiki placed inside your working directory:

    git clone [email protected]:/home/gollum/labdocs.wiki.git wiki

After you edited the content (e.g. using a Text/Markdown editor or adding files), and committed your modifications, you can push the edits back to the Mirror using:

    git push origin master

Once you have cloned the wiki on your computer, you can also run a local instance of the HTML rendering engine to access your copy of the wiki with localhost:4567 in your browser. Provided the rendering engine is installed on your computer, the command is:

    gollum --mathjax --allow-uploads page