Lab wiki for the Erasmus SYNC lab

🎉 Welcome! 🎉

In this repository, you can find the source code and contents of the lab wiki of the Erasmus SYNC lab. The wiki contains both information on the ways we work, as well as information and instructions on how to be a successful member of the SYNC lab. Not content with the information displayed here? Feel free to open an issue or make a pull request to suggest changes!

Link to the published lab wiki: https://eur-synclab.github.io/

This manual is always in progress, so feel free to contribute by adding features, such as:

images
changing or adding text
changes to the chapter structure
or anything else!

How to contribute?

For a more extensive explanation on how to contribute, please see How to contribute

fork this repository to your own Github account by clicking the button on the upper right of this screen
Create a new branch in your forked repository which you will use to make changes in (your master branch will remain "clean" this way)
clone your forked repository to your local PC. If you do not how to do this, check out the Github section of the wiki!
Follow the installation steps for mkdocs here
On your local PC, navigate to your newly made branch and make changes in the relevant files
Write a commit message for every change you made
In your prompt, navigate to your repository directory with cd C:/users/username/your/repo/directory and run mkdocs build (if you want to preview the website locally, run mkdocs serve and in your browser, go to the http that is displayed, http://127.0.0.1:8000/)
If everything goes correctly, you can also open the new .html files in the eur-synclab.github.io/site folder to see what your changes will look like online
Push the changes to your remote (i.e., the repository on your Github account)
Make a pull request to merge your branch with the eur-synclab/eur-synclab.github.io master branch
Those who can directly edit this repository will then review your pull request and merge it with the master branch
Those who can directly edit this repository then have to locally navigate to eur-synclab.github.io master and then run mkdocs gh-deploy. This pushes the html pages to the gh-pages branch of this repository
Your changes are now visible on the website!