Commit db3fcdae authored by Cyril Matthey-Doret's avatar Cyril Matthey-Doret
Browse files

Format md in README.md

parent 90969d6b
Pipeline #326967 passed with stage
in 10 seconds
...@@ -48,15 +48,15 @@ Homework assignment can be provided by the teachers in the form of a repository ...@@ -48,15 +48,15 @@ Homework assignment can be provided by the teachers in the form of a repository
The teacher can then use the Gitlab API to keep track of all student's forks. We provide a script to gather metadata about all student-group forks of a given project, with the option to retrieve the last commit before a deadline. That script will output the metadata as a JSON structure containing the following fields for each fork: The teacher can then use the Gitlab API to keep track of all student's forks. We provide a script to gather metadata about all student-group forks of a given project, with the option to retrieve the last commit before a deadline. That script will output the metadata as a JSON structure containing the following fields for each fork:
* id: The gitlab project ID of the fork * `id`: The gitlab project ID of the fork
* url: The https URL to reach the fork * `url`: The https URL to reach the fork
* group: The student group name * `group`: The student group name
* members: The members of the group. For each member the following fields are provided: * `members`: The members of the group. For each member the following fields are provided:
+ username: The gitlab username + `username`: The gitlab username
+ name: The full name (First_name Last_name) + `name`: The full name (First_name Last_name)
+ email: The email address of the student + `email`: The email address of the student
* commit: The hash of the last commit before the deadline, used for grading the assignment. * `commit`: The hash of the last commit before the deadline, used for grading the assignment.
* autostart_url: A URL to directly start a Renku session at the last commit before the deadline. * `autostart_url`: A URL to directly start a Renku session at the last commit before the deadline.
script: [scripts/collect_forks.py](scripts/collect_forks.py) script: [scripts/collect_forks.py](scripts/collect_forks.py)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment