From 13232d52c030998960f587d3ff53c03e44494972 Mon Sep 17 00:00:00 2001 From: Tim Schubert Date: Wed, 18 Jul 2018 11:12:48 +0200 Subject: [PATCH] Spelling errors --- README.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 9ca5b78..7c3f821 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,17 @@ ## Setup +0. Configure gitlab with your LDAP configuration. + 1. Generate a deploy key and an API token. 2. Set up container images and runners. - - [checkstyle](https://ips1.ibr.cs.tu-bs.de/abgabesystem/abgabesystem) - - [abgabesystem](https://ips1.ibr.cs.tu-bs.de/abgabesystem/docker-abgabesystem) + - [checkstyle](https://ips1.ibr.cs.tu-bs.de/abgabesystem/checkstyle) + - [abgabesystem](https://ips1.ibr.cs.tu-bs.de/abgabesystem/abgabesystem) -3. Create a group for you course and add all administrative users to it. +3. Create a group for your course and add all administrative users to it. -4. Clone [abgabesystem](https://ips1.ibr.cs.tu-bs.de/abgabesystem/docker-abgabesystem) as a private project of that group and add -SSH_PRIVATE_KEY and PRIVATE_API_TOKEN to the private variables. +4. Clone [abgabesystem](https://ips1.ibr.cs.tu-bs.de/abgabesystem/docker-abgabesystem) as a private project of that group and add SSH_PRIVATE_KEY and PRIVATE_API_TOKEN to the private variables. 5. Edit [config.yml](blob/master/config.yml) to include the name of the student list, your public deploy key and the name of the course. @@ -20,7 +21,7 @@ deploy key and the name of the course. 7. wait for ci jobs to finish.... -Recommended settings for gitlab.rb +## Recommended settings for gitlab.rb ``` gitlab_rails['gitlab_default_can_create_group'] = false @@ -36,15 +37,12 @@ Recommended settings for gitlab.rb Also, you should - set the default project limit for each user to 0 and -- set default settings for projects to partially protected so that developers -can not force push tag and commits to protected branches (master) +- set default settings for projects to partially protected so that developers (e.g. students) can not force push tag and commits to protected branches (master) ## Workflow -To trigger the deadline of an exercise (e.g. Sunday at 15:00), push a tag -(e.g. ex1) to the cloned Abgabesystem project. The Abgabesystem's CI jobs -creates a tag of this name inside each student's project and then proceeds -by creating a checkout of each project's repository and running [JPlag](https://github.com/jplag/jplag) to -check for plagiates. The results can be found inside the job artefacts for the -CI job that is run for the tag. The results are saved for each tag and can be -downloaded as an archive. +To trigger the deadline of an exercise (e.g. Sunday at 15:00), push a tag (e.g. +ex1) to the cloned abgabesystem project. +The abgabesystem's CI job creates a tag of this name inside each student's project and then creates a checkout of each project's repository and runs [JPlag](https://github.com/jplag/jplag) to check for plagiates. +The results can be found inside the job artifacts. +The results are saved for each tag and can be downloaded as an archive.