From 4b026f948fe06f44ef443803d12d5122d17a6b32 Mon Sep 17 00:00:00 2001 From: Julien WITTOUCK Date: Thu, 06 Mar 2025 08:19:46 +0000 Subject: [PATCH] 🚚 : move docs to its own repository --- mkdocs.yml | 25 ------------------------- src/main/docs/01-quick-start.md | 50 -------------------------------------------------- src/main/docs/configuration/01-configure-database.md | 17 ----------------- src/main/docs/configuration/02-configure-gitlab-connectivity.md | 33 --------------------------------- src/main/docs/configuration/02-gitlab-create-application-secret.png | 0 src/main/docs/configuration/02-gitlab-create-new-application.png | 0 src/main/docs/configuration/index.md | 7 ------- src/main/docs/decisions/0001-use-spring-boot.md | 30 ------------------------------ src/main/docs/decisions/0002-use-gitlab4j.md | 22 ---------------------- src/main/docs/decisions/adr-template.md | 79 ------------------------------------------------------------------------------- src/main/docs/glossary.md | 22 ---------------------- src/main/docs/index.md | 19 ------------------- src/main/docs/logo-96.png | 0 src/main/docs/logo-with-text-400.png | 0 src/main/docs/logo-with-text.png | 0 src/main/docs/logo.png | 0 src/main/docs/user-documentation/01-gitlab-login-page.png | 0 src/main/docs/user-documentation/01-login-page.png | 0 src/main/docs/user-documentation/01-login.md | 58 ---------------------------------------------------------- src/main/docs/user-documentation/01-logout.png | 0 src/main/docs/user-documentation/01-oauth2-authorization.png | 0 src/main/docs/user-documentation/index.md | 8 -------- src/main/docs/user-documentation/student/01-student-dashboard-assignments.png | 0 src/main/docs/user-documentation/student/01-student-dashboard-empty.png | 0 src/main/docs/user-documentation/student/01-student-dashboard-exercise-score.png | 0 src/main/docs/user-documentation/student/01-student-dashboard.md | 32 -------------------------------- src/main/docs/user-documentation/student/02-joining-classroom-confirmation.png | 0 src/main/docs/user-documentation/student/02-joining-classroom.md | 28 ---------------------------- src/main/docs/user-documentation/student/02-joining-classroom.png | 0 src/main/docs/user-documentation/student/02-student-dashboard-classroom.png | 0 src/main/docs/user-documentation/student/03-accepting-assignment.md | 60 ------------------------------------------------------------ src/main/docs/user-documentation/student/03-accepting-exercise-assignment-confirmation.png | 0 src/main/docs/user-documentation/student/03-accepting-exercise-assignment.png | 0 src/main/docs/user-documentation/student/03-accepting-quiz-assignment-confirmation.png | 0 src/main/docs/user-documentation/student/03-accepting-quiz-assignment.png | 0 src/main/docs/user-documentation/student/03-exercise-assignment-gitlab-project.png | 0 src/main/docs/user-documentation/student/03-exercise-assignment-template-gitlab-project.png | 0 src/main/docs/user-documentation/student/04-full-text-question.png | 0 src/main/docs/user-documentation/student/04-multiple-choice-question.png | 0 src/main/docs/user-documentation/student/04-partial-answer-error.png | 0 src/main/docs/user-documentation/student/04-quiz-already-taken.png | 0 src/main/docs/user-documentation/student/04-quiz-results.png | 0 src/main/docs/user-documentation/student/04-single-choice-question.png | 0 src/main/docs/user-documentation/student/04-taking-quiz.md | 59 ----------------------------------------------------------- src/main/docs/user-documentation/teacher/01-teacher-dashboard-classroom.png | 0 src/main/docs/user-documentation/teacher/01-teacher-dashboard-empty.png | 0 src/main/docs/user-documentation/teacher/01-teacher-dashboard.md | 31 ------------------------------- src/main/docs/user-documentation/teacher/02-classroom-gitlab-group.png | 0 src/main/docs/user-documentation/teacher/02-creating-classroom.md | 38 -------------------------------------- src/main/docs/user-documentation/teacher/02-new-classroom.png | 0 src/main/docs/user-documentation/teacher/03-assignment-list.png | 0 src/main/docs/user-documentation/teacher/03-classroom-page.md | 60 ------------------------------------------------------------ src/main/docs/user-documentation/teacher/03-classroom-view-assignments.png | 0 src/main/docs/user-documentation/teacher/03-classroom-view-empty.png | 0 src/main/docs/user-documentation/teacher/03-student-list.png | 0 src/main/docs/user-documentation/teacher/04-creating-assignment.md | 41 ----------------------------------------- src/main/docs/user-documentation/teacher/04-creating-assignment.png | 0 src/main/docs/user-documentation/teacher/04-creating-quiz-assignment.png | 0 src/main/docs/user-documentation/teacher/04-teacher-dashboard-first-assignment.png | 0 src/main/docs/user-documentation/teacher/05-view-assignment-results.md | 36 ------------------------------------ src/main/docs/user-documentation/teacher/05-view-exercise-assignment.png | 0 src/main/docs/user-documentation/teacher/05-view-quiz-assignment.png | 0 src/main/docs/user-documentation/teacher/06-creating-quiz.md | 144 ------------------------------------------------------------------------------------------------------------------------------------------------ src/main/docs/user-documentation/teacher/06-full-text-question.png | 0 src/main/docs/user-documentation/teacher/06-multiple-choice-question.png | 0 src/main/docs/user-documentation/teacher/06-quiz-edition-empty.png | 0 src/main/docs/user-documentation/teacher/06-quiz-list-view.png | 0 src/main/docs/user-documentation/teacher/06-quiz-preview.png | 0 src/main/docs/user-documentation/teacher/06-single-choice-question.png | 0 69 file(s) changed, 0 insertion(s)(+), 899 deletion(s)(-) diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 --- a/mkdocs.yml +++ /dev/null @@ -1,25 +0,0 @@ -site_name: GitLab Classrooms Docs - -docs_dir: src/main/docs -exclude_docs: | - decisions/ - -repo_url: https://gitlab.univ-lille.fr/gitlab-classrooms/gitlab-classrooms - -theme: - name: material - logo: logo.png - favicon: logo.png - icon: - repo: fontawesome/brands/gitlab - features: - - navigation.instant - - navigation.indexes - -markdown_extensions: - - attr_list - - md_in_html - - def_list - - admonition - - pymdownx.details - - pymdownx.superfences diff --git a/src/main/docs/01-quick-start.md b/src/main/docs/01-quick-start.md deleted file mode 100644 --- a/src/main/docs/01-quick-start.md +++ /dev/null @@ -1,50 +0,0 @@ -# Quick Start - -This guide will help start a GitLab Classrooms instance quickly. - -## With Docker - -!!! info - - Pre-requisites : - - * Docker installed on your system - * a running PostgreSQL database - * access to a GitLab instance - -Run the following command : - -```shell -docker run -d \ - --name gitlab-classrooms-app \ - -p 8080:8080 \ - -e POSTGRESQL_ADDON_HOST= \ - -e POSTGRESQL_ADDON_PORT= \ - -e POSTGRESQL_ADDON_DB= \ - -e POSTGRESQL_ADDON_USER= \ - -e POSTGRESQL_ADDON_PASSWORD= \ - -e GITLAB_URL= \ - -e GITLAB_CLIENT_ID= \ - -e GITLAB_CLIENT_SECRET= \ - gitlabclassrooms/app:latest -``` - -Replace the following placeholders with your actual PostgreSQL database details: - -* ``: The hostname or IP address of your PostgreSQL server -* ``: The port number on which PostgreSQL is running (usually 5432) -* ``: The name of the database for GitLab Classrooms -* ``: The username for accessing the database -* ``: The password for the database user - -See [Database configuration](./configuration/01-configure-database.md) for database configuration details. - -Replace the following placeholders with your GitLab instance details: - -* ``: The URL of your GitLab instance (e.g., https://gitlab.com) -* ``: The Application ID from your GitLab OAuth application -* ``: The Secret from your GitLab OAuth application - -See [GitLab configuration](./configuration/02-configure-gitlab-connectivity.md) for GitLab connectivity configuration details. - -GitLab Classrooms should be available at [http://localhost:8080](http://localhost:8080). \ No newline at end of file diff --git a/src/main/docs/configuration/01-configure-database.md b/src/main/docs/configuration/01-configure-database.md deleted file mode 100644 --- a/src/main/docs/configuration/01-configure-database.md +++ /dev/null @@ -1,17 +0,0 @@ -# Database configuration - -The following properties are used to configure database access. - -_GitLab Classroom_ initializes the database schema when it starts, so there's no need to create anything upfront. - -_GitLab Classroom_ only supports PostgreSQL 14. - -## Configure database connectivity using env vars - -| env var | usage | default value | -|-----------------------------|---------------------|---------------| -| `POSTGRESQL_ADDON_HOST` | PostgreSQL Hostname | | -| `POSTGRESQL_ADDON_PORT` | PostgreSQL Port | | -| `POSTGRESQL_ADDON_DB` | PostgreSQL Database | | -| `POSTGRESQL_ADDON_USER` | PostgreSQL User | | -| `POSTGRESQL_ADDON_PASSWORD` | PostgreSQL Password | | diff --git a/src/main/docs/configuration/02-configure-gitlab-connectivity.md b/src/main/docs/configuration/02-configure-gitlab-connectivity.md deleted file mode 100644 --- a/src/main/docs/configuration/02-configure-gitlab-connectivity.md +++ /dev/null @@ -1,33 +0,0 @@ -# GitLab configuration - -## Create an Application in your GitLab instance - -Here is the procedure to register _GitLab Classroom_ as a _GitLab Application_ on any GitLab instance. - -Login to your GitLab instance, and open the `/-/profile/applications` page. - -
- ![GitLab Create Application page](02-gitlab-create-new-application.png){ style="border: solid 1px black" } -
GitLab Create Application page
-
- -Input a name, the `URI` at which _Gitlab CLassroom_ is deployed, and select the `api` scope. - -Then click on _Save Application_ to create the application. - -Gitlab will then return with an _Application Id_, and a _Secret_. - -Save these for later. - -
- ![GitLab Created Application page with Application ID and Secret](02-gitlab-create-application-secret.png){ style="border: solid 1px black" } -
GitLab Created Application page with Application ID and Secret
-
- -## Configure GitLab connectivity using env vars - -| env var | usage | default value | -|------------------------|---------------------------------------------------------------------|---------------| -| `GITLAB_URL` | URL of the Gitlab instance | | -| `GITLAB_CLIENT_ID` | Application ID generated when registering the application on Gitlab | | -| `GITLAB_CLIENT_SECRET` | Secret generated when registering the application on Gitlab | | diff --git a/src/main/docs/configuration/02-gitlab-create-application-secret.png b/src/main/docs/configuration/02-gitlab-create-application-secret.png deleted file mode 100644 --- a/src/main/docs/configuration/02-gitlab-create-application-secret.png +++ /dev/null diff --git a/src/main/docs/configuration/02-gitlab-create-new-application.png b/src/main/docs/configuration/02-gitlab-create-new-application.png deleted file mode 100644 --- a/src/main/docs/configuration/02-gitlab-create-new-application.png +++ /dev/null diff --git a/src/main/docs/configuration/index.md b/src/main/docs/configuration/index.md deleted file mode 100644 --- a/src/main/docs/configuration/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# Technical documentation - -This section is intended for _GitLab Classrooms_ administrators. - -It contains documentation about how to install, configure, and operate the application. - -For usage documentation for _Teachers_ and _Students_, see [_User documentation_ section](../user-documentation). diff --git a/src/main/docs/decisions/0001-use-spring-boot.md b/src/main/docs/decisions/0001-use-spring-boot.md deleted file mode 100644 --- a/src/main/docs/decisions/0001-use-spring-boot.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -status: accepted -date: 2023-04-15 -deciders: @juwit -consulted: -informed: ---- -# Use Spring Boot for development - -## Context and Problem Statement - -For the development of Gitlab Classrooms, a web framework, with the followiong features is required : - -* REST API serving -* Static pages or template pages service -* Simple database access -* Security -* OAuth2 authentication using external provider (Gitlab) - -Spring Boot provides all these features. - -## Considered Options - -* Spring Boot -* Quarkus -* Micronaut - -## Decision Outcome - -Chosen option: "Spring Boot", because there's no learning curve necessary to be able to develop quickly. diff --git a/src/main/docs/decisions/0002-use-gitlab4j.md b/src/main/docs/decisions/0002-use-gitlab4j.md deleted file mode 100644 --- a/src/main/docs/decisions/0002-use-gitlab4j.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -status: accepted -date: 2023-04-15 -deciders: @juwit -consulted: -informed: ---- -# Use Gitlab4J for Gitlab API access - -## Context and Problem Statement - -Gitlab Classroom needs to access Gitlab API to be able to list, create repositories and so on. - -## Considered Options - -* Custom development with low-level Spring's `WebClient` -* Use some higher-level client, such as `Retrofit` -* Use an SDK, such as Gitlab4J - -## Decision Outcome - -Chosen option: "Use an SDK, such as Gitlab4J", because using an SDK will reduce the amount of code to write, to be as efficient as possible in development. diff --git a/src/main/docs/decisions/adr-template.md b/src/main/docs/decisions/adr-template.md deleted file mode 100644 --- a/src/main/docs/decisions/adr-template.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -# These are optional elements. Feel free to remove any of them. -status: {proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)} -date: {YYYY-MM-DD when the decision was last updated} -deciders: {list everyone involved in the decision} -consulted: {list everyone whose opinions are sought (typically subject-matter experts); and with whom there is a two-way communication} -informed: {list everyone who is kept up-to-date on progress; and with whom there is a one-way communication} ---- -# {short title of solved problem and solution} - -## Context and Problem Statement - -{Describe the context and problem statement, e.g., in free form using two to three sentences or in the form of an illustrative story. - You may want to articulate the problem in form of a question and add links to collaboration boards or issue management systems.} - - -## Decision Drivers - -* {decision driver 1, e.g., a force, facing concern, …} -* {decision driver 2, e.g., a force, facing concern, …} -* … - -## Considered Options - -* {title of option 1} -* {title of option 2} -* {title of option 3} -* … - -## Decision Outcome - -Chosen option: "{title of option 1}", because -{justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}. - - -### Consequences - -* Good, because {positive consequence, e.g., improvement of one or more desired qualities, …} -* Bad, because {negative consequence, e.g., compromising one or more desired qualities, …} -* … - - -## Validation - -{describe how the implementation of/compliance with the ADR is validated. E.g., by a review or an ArchUnit test} - - -## Pros and Cons of the Options - -### {title of option 1} - - -{example | description | pointer to more information | …} - -* Good, because {argument a} -* Good, because {argument b} - -* Neutral, because {argument c} -* Bad, because {argument d} -* … - -### {title of other option} - -{example | description | pointer to more information | …} - -* Good, because {argument a} -* Good, because {argument b} -* Neutral, because {argument c} -* Bad, because {argument d} -* … - - -## More Information - -{You might want to provide additional evidence/confidence for the decision outcome here and/or - document the team agreement on the decision and/or - define when this decision when and how the decision should be realized and if/when it should be re-visited and/or - how the decision is validated. - Links to other decisions and resources might here appear as well.} diff --git a/src/main/docs/glossary.md b/src/main/docs/glossary.md deleted file mode 100644 --- a/src/main/docs/glossary.md +++ /dev/null @@ -1,22 +0,0 @@ -# Glossary - -This page references all the _terms_ that this documentation uses. - -`Classroom` - -: Represents a teaching class. _Students_ can join a _Classroom_ to receive _Assignments_. _Teachers_ configures _Assignments_ in the _Classroom_, and gather _Students_ scores. - -`Assignment` - -: Represents some work the _Teacher_ wants the _Students_ to do. Can be of two types: - - * a practical exercise, taking the form of a source-code submission to a GitLab repository. - * a quiz exercise, taking the form of a multiple-choice questions quiz. - -`Student` - -: Represents a _Student_ of a teaching class. Can join a _Classroom_, accept _Assignments_, and submit work. - -`Teacher` - -: The _Teacher_ of the teaching class. Can create _Classrooms_, _Assignments_, and gathers _Students_ work. diff --git a/src/main/docs/index.md b/src/main/docs/index.md deleted file mode 100644 --- a/src/main/docs/index.md +++ /dev/null @@ -1,19 +0,0 @@ -![Gitlab Classrooms](logo-with-text.png) - -**Gitlab Classroom** is a modest clone of [Github Classroom](https://classroom.github.com/), aimed at Gitlab. - -**Gitlab Classrooms** helps _Teachers_ to: - -* create Gitlab groups for a class -* give assignment for the _Students_ -* automate _Students_ repositories creation in the Group -* use project templates, to have a code skeleton to start with -* grade work automatically by importing test results - -_Students_ can: - -* access their assignments -* create their repositories automatically by simply joining a class with a magic link -* see their grade on each assignment - -**Gitlab Classroom** uses Gitlab OAuth2 provider to authenticate _Teachers_ and _Students_. diff --git a/src/main/docs/logo-96.png b/src/main/docs/logo-96.png deleted file mode 100644 --- a/src/main/docs/logo-96.png +++ /dev/null diff --git a/src/main/docs/logo-with-text-400.png b/src/main/docs/logo-with-text-400.png deleted file mode 100644 --- a/src/main/docs/logo-with-text-400.png +++ /dev/null diff --git a/src/main/docs/logo-with-text.png b/src/main/docs/logo-with-text.png deleted file mode 100644 --- a/src/main/docs/logo-with-text.png +++ /dev/null diff --git a/src/main/docs/logo.png b/src/main/docs/logo.png deleted file mode 100644 --- a/src/main/docs/logo.png +++ /dev/null diff --git a/src/main/docs/user-documentation/01-gitlab-login-page.png b/src/main/docs/user-documentation/01-gitlab-login-page.png deleted file mode 100644 --- a/src/main/docs/user-documentation/01-gitlab-login-page.png +++ /dev/null diff --git a/src/main/docs/user-documentation/01-login-page.png b/src/main/docs/user-documentation/01-login-page.png deleted file mode 100644 --- a/src/main/docs/user-documentation/01-login-page.png +++ /dev/null diff --git a/src/main/docs/user-documentation/01-login.md b/src/main/docs/user-documentation/01-login.md deleted file mode 100644 --- a/src/main/docs/user-documentation/01-login.md +++ /dev/null @@ -1,58 +0,0 @@ -# Login to GitLab Classrooms - -## Login to GitLab Classrooms - -When accessing GitLab Classroom, a login page will show. - -
- ![GitLab Classroom login page](01-login-page.png){ style="border: solid 1px black" } -
GitLab Classroom login page
-
- - -When clicking the _Login with Gitlab_ button, you will be redirected to the connected GitLab instance login page. - -
- ![GitLab Classroom login page](01-gitlab-login-page.png){ style="border: solid 1px black" } -
GitLab login page
-
- -Depending on the GitLab instance configuration, you can be redirected to a corporate login page instead of the GitLab page itself. - -If you're already connected to your GitLab instance, the login page may not be showed. - -## Authorizing GitLab Classroom to access your GitLab account - -When you first login to GitLab Classrooms, GitLab will ask you to authorize your GitLab account. - -
- ![GitLab authorization page](01-oauth2-authorization.png){ style="border: solid 1px black" } -
GitLab authorization page
-
- -Click _Authorize_ to allow GitLab Classrooms to access your account. -Otherwise, GitLab Classrooms will not be able to manage your classrooms or assignments for you. - -After that, you will be redirected to GitLab Classrooms, on the _Student Dashboard_ page. - -
- ![Student Dashboard page](student/01-student-dashboard-empty.png){ style="border: solid 1px black" } -
Student Dashboard page
-
- -By default, a _Student_ role is given to all users. - -See [Student documentation](./student/01-student-dashboard.md) or [Teacher documentation](./teacher/01-teacher-dashboard.md) depending on your role. - -## Logout - -On every page, at the top-right corner, your GitLab avater is displayed. -Clicking your avatar will show a popup menu, with a _Sign Out_ button. - -
- ![Logout Menu](01-logout.png){ style="border: solid 1px black" } -
Logout Menu
-
- -Clicking the button will log you out of _GitLab Classroom_, and redirect you to the Login page. -You will not be logged-out from GitLab though. diff --git a/src/main/docs/user-documentation/01-logout.png b/src/main/docs/user-documentation/01-logout.png deleted file mode 100644 --- a/src/main/docs/user-documentation/01-logout.png +++ /dev/null diff --git a/src/main/docs/user-documentation/01-oauth2-authorization.png b/src/main/docs/user-documentation/01-oauth2-authorization.png deleted file mode 100644 --- a/src/main/docs/user-documentation/01-oauth2-authorization.png +++ /dev/null diff --git a/src/main/docs/user-documentation/index.md b/src/main/docs/user-documentation/index.md deleted file mode 100644 --- a/src/main/docs/user-documentation/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# User documentation - -This section is intended for end-users. - -See the [_Students_ documentation](./student/01-student-dashboard.md). - -See the [_Teachers_ documentation](./teacher/01-teacher-dashboard.md). - diff --git a/src/main/docs/user-documentation/student/01-student-dashboard-assignments.png b/src/main/docs/user-documentation/student/01-student-dashboard-assignments.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/01-student-dashboard-assignments.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/01-student-dashboard-empty.png b/src/main/docs/user-documentation/student/01-student-dashboard-empty.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/01-student-dashboard-empty.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/01-student-dashboard-exercise-score.png b/src/main/docs/user-documentation/student/01-student-dashboard-exercise-score.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/01-student-dashboard-exercise-score.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/01-student-dashboard.md b/src/main/docs/user-documentation/student/01-student-dashboard.md deleted file mode 100644 --- a/src/main/docs/user-documentation/student/01-student-dashboard.md +++ /dev/null @@ -1,32 +0,0 @@ -# Using the _Student Dashboard_ - -## Empty state - -When empty, the _Student Dashboard_ does not display anything. - -
- ![Empty Student Dashboard](01-student-dashboard-empty.png){ style="border: solid 1px black" } -
Empty Student Dashboard
-
- -## Typical _Student Dashboard_ - -A Typical _Student Dashboard_ contains one or more _Classroom_, each with some _Assignments_. - -
- ![Student Dashboard with Assignments](01-student-dashboard-assignments.png){ style="border: solid 1px black" } -
Student Dashboard with Assignments
-
- -Each _Assignment_ card displays its type with an icon (Exercise or Quiz). - -_Exercise Assignments_ show a link to open the associated GitLab project. - -_Quiz Assignments_ show a link to take the associated Quiz. - -When a Quiz, or Exercise has been submitted, the submission date and score is also displayed on the card. - -
- ![Student Dashboard with a Quiz Assignment and Exercise Assignment Scored](01-student-dashboard-exercise-score.png){ style="border: solid 1px black" } -
Student Dashboard with a Quiz Assignment and Exercise Assignment Scored
-
diff --git a/src/main/docs/user-documentation/student/02-joining-classroom-confirmation.png b/src/main/docs/user-documentation/student/02-joining-classroom-confirmation.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/02-joining-classroom-confirmation.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/02-joining-classroom.md b/src/main/docs/user-documentation/student/02-joining-classroom.md deleted file mode 100644 --- a/src/main/docs/user-documentation/student/02-joining-classroom.md +++ /dev/null @@ -1,28 +0,0 @@ -# Joining a _Classroom_ - -A _Teacher_ may give you a _Join Link_. - -These links have the following form : `http://gitlab-classrooms.com/classrooms/04baf115-b2ca-4120-99e3-4cb385595a49/join`. - -When clicking this link, you **MAY** be redirected to the _GitLab Classroom_ login page first, then you will see the _Join Classroom_ page. - -
- ![Join Classroom page](02-joining-classroom.png){ style="border: solid 1px black" } -
Join Classroom page
-
- -When clicking _Join_, your _Student_ account will be connected to the _Classroom_. - -You will see a confirmation page. - -
- ![Join Classroom confirmation page](02-joining-classroom-confirmation.png){ style="border: solid 1px black" } -
Join Classroom confirmation page
-
- -You will be able to _Accept Assignments_, and view your accepted assignments and scores on your _Student Dashboard_. - -
- ![Your Student Dashboard after joining your first Classroom](02-student-dashboard-classroom.png){ style="border: solid 1px black" } -
Your Student Dashboard after joining your first Classroom
-
diff --git a/src/main/docs/user-documentation/student/02-joining-classroom.png b/src/main/docs/user-documentation/student/02-joining-classroom.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/02-joining-classroom.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/02-student-dashboard-classroom.png b/src/main/docs/user-documentation/student/02-student-dashboard-classroom.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/02-student-dashboard-classroom.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/03-accepting-assignment.md b/src/main/docs/user-documentation/student/03-accepting-assignment.md deleted file mode 100644 --- a/src/main/docs/user-documentation/student/03-accepting-assignment.md +++ /dev/null @@ -1,60 +0,0 @@ -# Accepting an _Assignment_ - -A _Teacher_ may give you a _Accept Link_ for an _Assignment_. - -These links have the following form : `http://gitlab-classrooms.com/assignments/b0f85e34-2377-4855-8de3-a238aaf17842/accept`. - -When clicking this link, you **MAY** be redirected to the _GitLab Classroom_ login page first, then you will see the _Accept Assignment_ page. - -
- ![Accept Assignment page](03-accepting-exercise-assignment.png){ style="border: solid 1px black" } -
Accept Assignment page
-
- -When clicking _Accept_, your _Student_ account will be connected to the _Assignment_. - -You will then see a confirmation page. - -After accepting an _Assignment_, it will also be displayed on your _Dashboard_. - -## Exercise Assignments - -In the case of _Exercise Assignments_, a **private** GitLab project will be created for you, in the GitLab group of the _Assignment_. -You will also be granted **MAINTAINER** access level to this project. -Only you and your _Teacher_ will be able to view your project in GitLab. - -
- ![Accept Exercise Assignment confirmation page](03-accepting-exercise-assignment-confirmation.png){ style="border: solid 1px black" } -
Accept Exercise Assignment confirmation page
-
- -The _Accept Exercise Assignment_ confirmation page also gives you a direct link to open the newly created GitLab project. - -
- ![Exercise Assignment GitLab project](03-exercise-assignment-gitlab-project.png){ style="border: solid 1px black" } -
Exercise Assignment GitLab project
-
- -Depending on the _Assignment_, your project will be empty, or will come with a code template. - -
- ![Exercise Assignment GitLab project, loaded with a code template](03-exercise-assignment-template-gitlab-project.png){ style="border: solid 1px black" } -
Exercise Assignment GitLab project, loaded with a code template
-
- -## Quiz Assignments - -In the case of _Quiz Assignments_, no GitLab project will be created -You have to accept the _Assignment_, and take the multi-choice question quiz. - -
- ![Accept Quiz Assignment page](03-accepting-quiz-assignment.png){ style="border: solid 1px black" } -
Accept Quiz Assignment page
-
- -The confirmation page gives you the link to take the Quiz. - -
- ![Accept Quiz Assignment confirmation page](03-accepting-quiz-assignment-confirmation.png){ style="border: solid 1px black" } -
Accept Quiz Assignment confirmation page
-
diff --git a/src/main/docs/user-documentation/student/03-accepting-exercise-assignment-confirmation.png b/src/main/docs/user-documentation/student/03-accepting-exercise-assignment-confirmation.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/03-accepting-exercise-assignment-confirmation.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/03-accepting-exercise-assignment.png b/src/main/docs/user-documentation/student/03-accepting-exercise-assignment.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/03-accepting-exercise-assignment.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/03-accepting-quiz-assignment-confirmation.png b/src/main/docs/user-documentation/student/03-accepting-quiz-assignment-confirmation.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/03-accepting-quiz-assignment-confirmation.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/03-accepting-quiz-assignment.png b/src/main/docs/user-documentation/student/03-accepting-quiz-assignment.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/03-accepting-quiz-assignment.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/03-exercise-assignment-gitlab-project.png b/src/main/docs/user-documentation/student/03-exercise-assignment-gitlab-project.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/03-exercise-assignment-gitlab-project.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/03-exercise-assignment-template-gitlab-project.png b/src/main/docs/user-documentation/student/03-exercise-assignment-template-gitlab-project.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/03-exercise-assignment-template-gitlab-project.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/04-full-text-question.png b/src/main/docs/user-documentation/student/04-full-text-question.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/04-full-text-question.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/04-multiple-choice-question.png b/src/main/docs/user-documentation/student/04-multiple-choice-question.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/04-multiple-choice-question.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/04-partial-answer-error.png b/src/main/docs/user-documentation/student/04-partial-answer-error.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/04-partial-answer-error.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/04-quiz-already-taken.png b/src/main/docs/user-documentation/student/04-quiz-already-taken.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/04-quiz-already-taken.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/04-quiz-results.png b/src/main/docs/user-documentation/student/04-quiz-results.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/04-quiz-results.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/04-single-choice-question.png b/src/main/docs/user-documentation/student/04-single-choice-question.png deleted file mode 100644 --- a/src/main/docs/user-documentation/student/04-single-choice-question.png +++ /dev/null diff --git a/src/main/docs/user-documentation/student/04-taking-quiz.md b/src/main/docs/user-documentation/student/04-taking-quiz.md deleted file mode 100644 --- a/src/main/docs/user-documentation/student/04-taking-quiz.md +++ /dev/null @@ -1,59 +0,0 @@ -# Taking a Quiz - -By cliking on the _Answer Quiz_ link from your [_Student Dashboard_](./01-student-dashboard.md), or after accepting a _Assignment_, you open the Quiz Page. - -## Question types - -There are 3 types of questions: - -* multiple-choice questions, using checkboxes. There can be one or more correct response can (even all responses can be correct). -
- ![Multiple-Choice question](04-multiple-choice-question.png){ style="border: solid 1px black" } -
Multiple-Choice question
-
- -* single-choice questions, using radio buttons. There can be only one correct response. -
- ![Single-Choice question](04-single-choice-question.png){ style="border: solid 1px black" } -
Single-Choice question
-
- -* full-text response, using an input text. You have to enter the response in the given field. -
- ![Full-Text question](04-full-text-question.png){ style="border: solid 1px black" } -
Full-Text question
-
- -## Submitting the Quiz - -After you answered all the questions, you can submit the quiz with the _Submit_ button at the bottom of the page. - -If you submit a Quiz without answering all the questions, an error is displayed. - -
- ![Error for partial quiz submission](04-partial-answer-error.png){ style="border: solid 1px black" } -
Error for partial quiz submission
-
- -If all questions are answered, you are redirected to the quiz result page. - -The page shows you your score. The questions you correctly answered are highlighted in green, the incorrect answers are highlight in red. Only the question title is highlighted, the correct answer is not given (because you can retake a quiz if the _Teacher_ let you do so). - -
- ![Quiz Result page](04-quiz-results.png){ style="border: solid 1px black" } -
Quiz Result page
-
- - -## Re-Taking a Quiz - -If the _Teacher_ allows it, you can re-take a Quiz you have already taken. - -In that case, _Gitlab Classroom_ show you a warning with your previous score and submission date. - -Be advised that your new answers will override the previous submission. - -
- ![Quiz Already taken](04-quiz-already-taken.png){ style="border: solid 1px black" } -
Quiz Already taken warning
-
diff --git a/src/main/docs/user-documentation/teacher/01-teacher-dashboard-classroom.png b/src/main/docs/user-documentation/teacher/01-teacher-dashboard-classroom.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/01-teacher-dashboard-classroom.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/01-teacher-dashboard-empty.png b/src/main/docs/user-documentation/teacher/01-teacher-dashboard-empty.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/01-teacher-dashboard-empty.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/01-teacher-dashboard.md b/src/main/docs/user-documentation/teacher/01-teacher-dashboard.md deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/01-teacher-dashboard.md +++ /dev/null @@ -1,31 +0,0 @@ -# Using the _Teacher Dashboard_ - -From this dashboard, a _Teacher_ can: - -* view all the _Classrooms_ -* [create a new _Classroom_](./02-creating-classroom.md) -* access details of an [existing _Classroom_](./03-classroom-page.md) by clicking its card. - -## Empty dashboard - -When empty, the _Teacher_ dashboard displays a link to the [_Create Classroom_](./02-creating-classroom.md) page. - -
- ![Empty Teacher dashboard](01-teacher-dashboard-empty.png){ style="border: solid 1px black" } -
Empty Teacher dashboard
-
- -## Typical dashboard - -When at least one _Classroom_ exists, the list of the _Classrooms_ is show on the _Teacher_ dashboard. - -Each _Classroom_ is represented by a card. - -
- ![Teacher dashboard](01-teacher-dashboard-classroom.png){ style="border: solid 1px black" } -
Teacher dashboard with a Classroom
-
- -### Accessing a _Classroom_ - -Clicking on a _Classroom_ card name in the _Teacher_ dashboard opens the [_Classroom_ page](./03-classroom-page.md). diff --git a/src/main/docs/user-documentation/teacher/02-classroom-gitlab-group.png b/src/main/docs/user-documentation/teacher/02-classroom-gitlab-group.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/02-classroom-gitlab-group.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/02-creating-classroom.md b/src/main/docs/user-documentation/teacher/02-creating-classroom.md deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/02-creating-classroom.md +++ /dev/null @@ -1,38 +0,0 @@ -# Creating a _Classroom_ - -To create a _Classroom_, the _Teacher_ **MUST** input a name. -The _Classroom_ name will be used as a GitLab group name, so it **MUST** be unique for a GitLab instance. - -!!! tip - - To ensure that the name is unique, you can include the current year when naming your Classroom. - e.g : `SRA1-2023`, or `ALOM-2023` - - -
- ![Create Classroom Page](02-new-classroom.png){ style="border: solid 1px black" } -
Create Classroom Page
-
- -If you want the GitLab group of your _Classroom_ to be created in an existing GitLab group (as a nested group), you can select a group in the provided list, under _Parent GitLab Group_. -This list only contains the GitLab groups the connected user has access to. - -If you do not select a _Parent GitLab Group_, the GitLab group of your _Classroom_ will be created as a top-level group in your GitLab instance. - -After the _Classroom_ creation, you are redirected to the [_Dashboard_](./01-teacher-dashboard.md). - -The _Dashboard_ now lists the existing _Classroom_. - -
- ![Teacher Dashboard showing the created Classroom](01-teacher-dashboard-classroom.png){ style="border: solid 1px black" } -
Teacher Dashboard showing the created Classroom
-
- - -The _Classroom_ creation creates a GitLab group. -You should be able to see it when connecting to your GitLab instance. - -
- ![GitLab Group for the created Classroom](02-classroom-gitlab-group.png){ style="border: solid 1px black" } -
GitLab Group for the created Classroom
-
diff --git a/src/main/docs/user-documentation/teacher/02-new-classroom.png b/src/main/docs/user-documentation/teacher/02-new-classroom.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/02-new-classroom.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/03-assignment-list.png b/src/main/docs/user-documentation/teacher/03-assignment-list.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/03-assignment-list.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/03-classroom-page.md b/src/main/docs/user-documentation/teacher/03-classroom-page.md deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/03-classroom-page.md +++ /dev/null @@ -1,60 +0,0 @@ -# The _Classroom_ page - -The _Classroom_ page is accessed when clicking a _Classroom_ card in the [_Teacher Dashboard_](./01-teacher-dashboard.md). - -The _Classroom_ page lists: - -* The _Students_ who joined the _Classroom_. -* The _Assignments_ of the _Classroom_. - -It also provides a link to access the GitLab Group of the _Classroom_ on your GitLab instance and a [_Join Link_](../student/02-joining-classroom.md) -and a button to [create an _Assignment_](./04-creating-assignment.md). - -When the _Classroom_ is just created, it displays an empty view. - -
- ![Empty Classroom](03-classroom-view-empty.png){ style="border: solid 1px black" } -
Empty Classroom
-
- -When the _Classroom_ has _Students_ and _Assignments_, it will show them as cards. - -
- ![Classroom with 2 Students and 2 Assignments](03-classroom-view-assignments.png){ style="border: solid 1px black" } -
Classroom with 2 Students and 2 Assignments
-
- -## The _Join Link_ - -The _Join Link_ is a magic link you can give to your _Students_ to [join your _Classroom_](../student/02-joining-classroom.md). - -After joining the _Classroom_, the _Students_ will be listed in the _Student_ list, and will be able to accept _Assignments_. - -Clicking on the _Copy Join Link_ button copies the link to your clipboard, so you can paste it using Ctrl + V, or Shift + Insert. - -## The _Student_ list - -This section lists all the _Students_ that joined the _Classroom_ by using the _Join Link_. - -Each card show the _Student_ GitLab avatar, the _Student_ GitLab user name, and the _Student_ email. - -
- ![The Student list for a Classroom](03-student-list.png){ style="border: solid 1px black" } -
The Student list for a Classroom
-
- -## The _Assignments_ list - -This section lists all the _Assignments_ of the _Classroom_. - -Each card show the _Assignment_ type (Exercise or Quiz) with an icon, the _Assignment_ name, the number of _Students_ who already accepted the _Assignment_, and the _Accept Link_ button. - -
- ![The Assignment list for a Classroom](03-assignment-list.png){ style="border: solid 1px black" } -
The Assignment list for a Classroom
-
- -Clicking on the Assignment name will open the [_Assignment submissions_](./05-view-assignment-results.md) page. - -Clicking on the _Copy Accept Link_ button copies the link to your clipboard, so you can paste it using Ctrl + V, or Shift + Insert. -The _Accept Link_ is a magic link you can give to your _Students_ to [accept your _Assignments_](../student/03-accepting-assignment.md). diff --git a/src/main/docs/user-documentation/teacher/03-classroom-view-assignments.png b/src/main/docs/user-documentation/teacher/03-classroom-view-assignments.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/03-classroom-view-assignments.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/03-classroom-view-empty.png b/src/main/docs/user-documentation/teacher/03-classroom-view-empty.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/03-classroom-view-empty.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/03-student-list.png b/src/main/docs/user-documentation/teacher/03-student-list.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/03-student-list.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/04-creating-assignment.md b/src/main/docs/user-documentation/teacher/04-creating-assignment.md deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/04-creating-assignment.md +++ /dev/null @@ -1,41 +0,0 @@ -# Creating an _Assignment_ - -There are 2 types of _Assignments_: - -* Quiz: this type of assignment is a multiple-choice questions quiz, that the _Teacher_ can create to validate the _Students_ knowledge. -* Exercise: this type of assignment is a practical exercise, taking the form of a source-code submission to a GitLab repository. - -## Creating an _Exercise Assignment_ - -To create an _Exercise Assignment_, the _Teacher_ **MUST** input a name. -_GitLab Classroom_ will create a nested GitLab group for the _Assignment_, using the name of the _Assignment_, in the group of the _Classroom_. - -The _Teacher_ **MAY** select a _GitLab Repository Template_. -If no template is selected, _GitLab Classroom_ will create an empty repository when each _Student_ accepts the _Assignment_. -If a template is selected, _GitLab Classroom_ will **fork** the selected repository when each _Student_ accepts the _Assignment_, then delete the fork relationship between the template repository and the _Student_ repository. -This contains the GitLab projects the connected user has access to. - -
- ![Create Assigment Page](04-creating-assignment.png){ style="border: solid 1px black" } -
Create Assigment Page
-
- -After creation, the _Exercise Assignment_ will appear as a card in the [_Teacher Dashboard_](./01-teacher-dashboard.md) page. -Clicking on the _Exercise Assignment_ card will open the _Assignment Details_ page. - -
- ![The created Assignment on the Teacher Dashboard](04-teacher-dashboard-first-assignment.png){ style="border: solid 1px black" } -
The created Assignment on the Teacher Dashboard
-
- -## Creating a _Quiz Assignment_ - -To create an _Exercise Assignment_, the _Teacher_ **MUST** input a name, and select an existing _Quiz_ in the list. - -
- ![Create Quiz Assignment Page](04-creating-quiz-assignment.png){ style="border: solid 1px black" } -
Create Quiz Assignment Page
-
- -After creation, the _Quiz Assignment_ will appear as a card in the [_Teacher Dashboard_](./01-teacher-dashboard.md) page. -Clicking on the _Quiz Assignment_ card will open the _Assignment Details_ page. diff --git a/src/main/docs/user-documentation/teacher/04-creating-assignment.png b/src/main/docs/user-documentation/teacher/04-creating-assignment.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/04-creating-assignment.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/04-creating-quiz-assignment.png b/src/main/docs/user-documentation/teacher/04-creating-quiz-assignment.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/04-creating-quiz-assignment.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/04-teacher-dashboard-first-assignment.png b/src/main/docs/user-documentation/teacher/04-teacher-dashboard-first-assignment.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/04-teacher-dashboard-first-assignment.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/05-view-assignment-results.md b/src/main/docs/user-documentation/teacher/05-view-assignment-results.md deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/05-view-assignment-results.md +++ /dev/null @@ -1,36 +0,0 @@ -# Viewing _Assignment_ submissions - -When clicking an _Assignment_ on the _Teacher Dashboard_, the _Teacher_ is redirected to the _Assignment Submissions_ view. - -The views are similar for the 2 types of _Assignments_, _Exercise_ or _Quiz_. - -## _Exercise Assignment_ submissions - -
- ![A Exercise Assignment submissions view](05-view-exercise-assignment.png){ style="border: solid 1px black" } -
An Exercise Assignment submissions view
-
- -The view shows: - -* the total count of _Students_ that accepted the _Assignment_ -* the total count of submissions by the _Students_ -* the average grade of the _Assignment_ -* for each _Student_: - * the grade of the _Student_ for the assignment - * the submission date of the assignment - * the link to the GitLab project - -## _Quiz Assignment_ submissions - -
- ![A Quiz Assignment submissions view](05-view-quiz-assignment.png){ style="border: solid 1px black" } -
A Quiz Assignment submissions view
-
- -The view shows: - -* the total count of submissions by the _Students_ -* for each _Student_: - * the score obtained at the Quiz - * the date of last submission diff --git a/src/main/docs/user-documentation/teacher/05-view-exercise-assignment.png b/src/main/docs/user-documentation/teacher/05-view-exercise-assignment.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/05-view-exercise-assignment.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/05-view-quiz-assignment.png b/src/main/docs/user-documentation/teacher/05-view-quiz-assignment.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/05-view-quiz-assignment.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/06-creating-quiz.md b/src/main/docs/user-documentation/teacher/06-creating-quiz.md deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/06-creating-quiz.md +++ /dev/null @@ -1,144 +0,0 @@ -# Creating a Quiz - -By clicking the _Quiz_ button in the top navigation, the _Teacher_ is redirected to the _Quiz_ list page. - -## Quiz list - -
- ![Quiz list view](06-quiz-list-view.png){ style="border: solid 1px black" } -
Quiz list view
-
- -The list show a card for each existing _Quiz_ and a button to create a new _Quiz_. - -Clicking on the _Quiz_ name will open the _Quiz edition_ page. - -Clicking on _Preview Quiz_ will open a page so that the _Teacher_ can preview a _Quiz_ before submitting it to _Students_ as an [_Assignment_](./04-creating-assignment.md). - -## Quiz Edition - -
- ![Quiz edition view](06-quiz-edition-empty.png){ style="border: solid 1px black" } -
Quiz edition view
-
- -The _Quiz Edition_ view shows 2 fields: - -* the name of the _Quiz_ (which is mandatory) -* the content of the _Quiz_ - -Clicking on the _Save_ button at the bottom of the screen will save the _Quiz_ and redirect to the _Quiz List_ view. - -## Writing a _Quiz_ - -The content of the _Quiz_ is written in Markdown format. - -Questions are separated by a blank line. - -The question title is a level-1 Markdown title, written using a `# ` at the start of the line. -e.g. `# Who is Luke Skywalker's Jedi master ?` - -### Single-choice Questions - -Single-choice questions are written using parenthesis `( )`. The correct answer should contain a `x` in the parenthesis `(x)`. Incorrect answers contain a space character in the parenthesis `( )`. A space character MUST separate the parenthesis and the answer label. - -Single-choice questions can contain any number of answers. Only one answer can be correct. - -```markdown title="A single-choice question" -# Who is Luke Skywalker's Jedi master ? -( ) Luke Skywalker -( ) Darth Vader -(x) Yoda -( ) Obi Wan Kenobi -``` - -Single-choice questions are rendered using radio buttons. - -
- ![A single-choice question](06-single-choice-question.png){ style="border: solid 1px black" } -
A single-choice question
-
- -### Multiple-choice Questions - -Multiple-choice questions are written using brackets `[ ]`. The correct answers should contain a `x` in the brackets `[x]`. Incorrect answers contain a space character in the brackets `[ ]`. A space character MUST separate the brackets and the answer label. - -Single-choice questions can contain any number of answers (correct or incorrect). - -```markdown title="A multiple-choice question" -# Which of those ships are used by the Rebel Alliance ? -[x] X-Wing fighter -[ ] TIE Fighter -[x] Y-Wing -[x] Tantive IV -``` - -Multiple-choice questions are rendered using checkboxes. - -
- ![A multiple-choice question](06-multiple-choice-question.png){ style="border: solid 1px black" } -
A multiple-choice question
-
- -### Full-text Questions - -Full-text questions are written using a equal sign `>`. The correct answer follows the sign. A space character MUST separate the equal sign and the answer label. - -Full-text questions can only have one answer. - -```markdown title="A full-text question" -# How many good Star Wars movies are there ? -= 3 -``` - -Full-text questions are rendered using a simple text input. - -
- ![A full-text question](06-full-text-question.png){ style="border: solid 1px black" } -
A full-text question
-
- -### Question explanations - -After each question, an explanation can be added using a Markdown blockquote syntax `> `. -This explanation text is rendered to the _Student_ after the Quiz submission, and can be an explanation of the correct answer, or a link to a course material for example. - -```markdown title="A full-text question with an explanation" -# How many good Star Wars movies are there ? -= 3 -> 'A New Hope', 'The Empire Strickes Back', 'Return of the Jedi'. -``` - -Explanations can be multi-line, and must be declared directly after the question answers (no blank line separation). - -Explanations can also contain HTML, such as links. - -```markdown title="A single-choice question with an HTML link explanation" -# Who is Luke Skywalker's Jedi master ? -( ) Luke Skywalker -( ) Darth Vader -(x) Yoda -( ) Obi Wan Kenobi -> Find the answer on Wikipedia -``` - -### Complete Quiz example - -Below is a complete Quiz example, with 3 questions, each of one type, and explanations on each question. - -```markdown title="A complete Quiz" -# Who is Luke Skywalker's Jedi master ? -( ) Luke Skywalker -( ) Darth Vader -(x) Yoda -( ) Obi Wan Kenobi - -# Which of those ships are used by the Rebel Alliance ? -[x] X-Wing fighter -[ ] TIE Fighter -[x] Y-Wing -[x] Tantive IV - -# How many good Star Wars movies are there ? -= 3 -``` diff --git a/src/main/docs/user-documentation/teacher/06-full-text-question.png b/src/main/docs/user-documentation/teacher/06-full-text-question.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/06-full-text-question.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/06-multiple-choice-question.png b/src/main/docs/user-documentation/teacher/06-multiple-choice-question.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/06-multiple-choice-question.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/06-quiz-edition-empty.png b/src/main/docs/user-documentation/teacher/06-quiz-edition-empty.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/06-quiz-edition-empty.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/06-quiz-list-view.png b/src/main/docs/user-documentation/teacher/06-quiz-list-view.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/06-quiz-list-view.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/06-quiz-preview.png b/src/main/docs/user-documentation/teacher/06-quiz-preview.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/06-quiz-preview.png +++ /dev/null diff --git a/src/main/docs/user-documentation/teacher/06-single-choice-question.png b/src/main/docs/user-documentation/teacher/06-single-choice-question.png deleted file mode 100644 --- a/src/main/docs/user-documentation/teacher/06-single-choice-question.png +++ /dev/null -- tangled.sh