momo-aux / lab

The Uberlab provides various tutorials - written by you! - on how to run software and tools on Uberspace 7.

Uberspace 7 Lab

Welcome to our laboratory! 🎉

This is where we host the source code of the official version over at https://lab.uberspace.de. The lab contains a collection of guides and tips on how to run specific software on Uberspace 7. Most of the guides are contributed by users like you! So, if you'd like to change or add something here, you're more than welcome to do so. Have a look at our contributing guidelines to learn how. Also, have a look at the list of guides people are looking for!

Development

Pushing for each and every change is fun, but can take some time. To speed up your development process, the lab can be built locally.

Initial Setup

$ virtualenv venv --python=python3.6
$ source venv/bin/activate
$ pip install -r requirements.txt

Building

$ source venv/bin/activate
$ make html

The HTML views are now present in build/html. To build automatically on each change execute use sphinx-autobuild:

$ make serve

This will start a local webserver on http://127.0.0.1:8000, which always serves the most recent version.

To check the spelling you can use the spellcheck function of sphinx.

$ make spelling

License

All text and code in this repository is licensed under CC-BY-NC-SA 4.0. All project logos are property of the respective project.