diff --git a/README.md b/README.md index 40d1da49..1f573c37 100644 --- a/README.md +++ b/README.md @@ -11,3 +11,5 @@ - Rune Dyselinck: Secretary ## Bekijk de [wiki](https://github.com/SELab-2/UGent-1/wiki) om alles over de applicatie te weten te komen. + +## Bekijk de [user manual](https://github.com/SELab-2/UGent-1/blob/user-manual/user_manual/manual.pdf) voor de gebruikershandleiding. \ No newline at end of file diff --git a/frontend/app/[locale]/components/NavBar.tsx b/frontend/app/[locale]/components/NavBar.tsx index f0857b4a..a8d7dfdc 100644 --- a/frontend/app/[locale]/components/NavBar.tsx +++ b/frontend/app/[locale]/components/NavBar.tsx @@ -53,7 +53,7 @@ const NavBar = () => { const handleBottomItems = (event: React.MouseEvent, button: string) => { switch (button) { case t('manual'): - //TODO: Route to manual page(in wiki or separate page?) + window.location.href = "https://github.com/SELab-2/UGent-1/blob/user-manual/user_manual/manual.pdf" break; case t('github'): window.location.href = 'https://github.com/SELab-2/UGent-1' diff --git a/user_manual/images/Access_private.png b/user_manual/images/Access_private.png new file mode 100644 index 00000000..6b6685c0 Binary files /dev/null and b/user_manual/images/Access_private.png differ diff --git a/user_manual/images/allcourses.png b/user_manual/images/allcourses.png new file mode 100644 index 00000000..3b86b993 Binary files /dev/null and b/user_manual/images/allcourses.png differ diff --git a/user_manual/images/calendar.png b/user_manual/images/calendar.png new file mode 100644 index 00000000..c5068fdb Binary files /dev/null and b/user_manual/images/calendar.png differ diff --git a/user_manual/images/course_page.png b/user_manual/images/course_page.png new file mode 100644 index 00000000..4892e44b Binary files /dev/null and b/user_manual/images/course_page.png differ diff --git a/user_manual/images/createcourse.png b/user_manual/images/createcourse.png new file mode 100644 index 00000000..a243dc7f Binary files /dev/null and b/user_manual/images/createcourse.png differ diff --git a/user_manual/images/createproject.png b/user_manual/images/createproject.png new file mode 100644 index 00000000..d0e4d4e8 Binary files /dev/null and b/user_manual/images/createproject.png differ diff --git a/user_manual/images/home_page.png b/user_manual/images/home_page.png new file mode 100644 index 00000000..a189c03d Binary files /dev/null and b/user_manual/images/home_page.png differ diff --git a/user_manual/images/image(1).png b/user_manual/images/image(1).png new file mode 100644 index 00000000..a1622283 Binary files /dev/null and b/user_manual/images/image(1).png differ diff --git a/user_manual/images/join_public.png b/user_manual/images/join_public.png new file mode 100644 index 00000000..540e0882 Binary files /dev/null and b/user_manual/images/join_public.png differ diff --git a/user_manual/images/login.png b/user_manual/images/login.png new file mode 100644 index 00000000..ff419f3f Binary files /dev/null and b/user_manual/images/login.png differ diff --git a/user_manual/images/projectpage.png b/user_manual/images/projectpage.png new file mode 100644 index 00000000..0c174e13 Binary files /dev/null and b/user_manual/images/projectpage.png differ diff --git a/user_manual/images/select_language.png b/user_manual/images/select_language.png new file mode 100644 index 00000000..2221fd19 Binary files /dev/null and b/user_manual/images/select_language.png differ diff --git a/user_manual/images/studentpage.png b/user_manual/images/studentpage.png new file mode 100644 index 00000000..17bb52f7 Binary files /dev/null and b/user_manual/images/studentpage.png differ diff --git a/user_manual/images/submit.png b/user_manual/images/submit.png new file mode 100644 index 00000000..9a62b9dc Binary files /dev/null and b/user_manual/images/submit.png differ diff --git a/user_manual/manual.pdf b/user_manual/manual.pdf new file mode 100644 index 00000000..76ca2b69 Binary files /dev/null and b/user_manual/manual.pdf differ diff --git a/user_manual/manual.tex b/user_manual/manual.tex new file mode 100644 index 00000000..8c469950 --- /dev/null +++ b/user_manual/manual.tex @@ -0,0 +1,232 @@ +\documentclass{article} +\usepackage[utf8]{inputenc} +\usepackage{hyperref} +\usepackage{graphicx} +\usepackage{float} +\usepackage{enumitem} + +\title{PigeonHole UGent Submission Platform User Manual} +\author{SEL group 1 2024} +\date{\today} + +\begin{document} + +\maketitle + +\tableofcontents + +\section{Introduction} +Welcome to the PigeonHole UGent Submission Platform User Manual. This manual provides instructions for users, teachers, and administrators on how to effectively use the platform, step by step. The platform is designed to streamline the process of submitting, reviewing, and providing feedback on projects. It seeks to create a middle ground between being easy to use but also providing the necessary features for automatic feedback on big projects. As for now, we only support UGent accounts to use the platform. + +\section{Getting Started} +\subsection{Creating an Account} +Users can only log in with their UGent account. If you do not have an account, please contact the administrator to create one for you. + +\subsection{Logging In} +When accessing the platform, students will be prompted to log in with their UGent account. UGent uses OAuth2 for authentication, so you will be redirected to the UGent login page. After logging in, you will be redirected back to the platform. + +\begin{figure}[H] + \centering + \includegraphics[width=0.75\textwidth]{images/login.png} + \caption{Login Screen} +\end{figure} + +\subsection{Changing language} +We support English and Dutch. You can change in the small dropdown menu in the top right corner of every page's topbar. + +\subsection{Changing your profile picture} +By clicking on your name in the top right corner of the page, you can navigate to your profile page. Here you can change your profile picture by clicking on the image, selecting a new image, and clicking save. + +\section{Student Section} + +\subsection{View your courses} + +You can view all courses you are enrolled in and the projects that are available for submission central on the homepage. By clicking on a course title you can navigate to the course page, by clicking view project you can navigate to the project page. + +\begin{figure}[H] + \centering + \includegraphics[width=0.75\textwidth]{images/studentpage.png} + \caption{Home page} +\end{figure} + +\subsubsection{Archived courses} +Courses of previous years are archived and can be viewed by clicking on the "Archived courses" button. + +\subsubsection{Filter courses} +You can filter the courses by school year by clicking on the dropdown menu on the homepage, this will show a list of all archived courses. + +\subsubsection{View deadlines} +When navigating to the calendar page from the home screen, you can see all deadlines of the projects you are enrolled in. + +\begin{figure}[H] + \centering + \includegraphics[width=0.75\textwidth]{images/calendar.png} + \caption{Calendar page} +\end{figure} + +\subsection{Join a new course} +There are two types of courses: public and private. +In case the course is private, you need to be invited by the teacher to join the course. + + +In case the course is public, you can either also be invited by the teacher or join the course yourself. +To get a list of the public courses, click the "all open courses" button on the homepage. +On the "all open courses" page, you can see all public courses. By clicking on the "Join" button, you can join the course. + +\begin{figure}[H] + \centering + \includegraphics[width=0.75\textwidth]{images/allcourses.png} + \caption{All open courses page} +\end{figure} + +\subsection{Get an overview of the projects of a course} +On the home page, you can click on the course title to navigate to the course page. Here you can see all the projects of the course. You can see the status of the project and the deadline. +On the home page, you can also click on the "View project" button to navigate to a specific project page. +From the course page, you can also navigate to the project page by clicking on the "View project" button. + + +\begin{figure}[H] + \centering + \includegraphics[width=0.75\textwidth]{images/course_page.png} + \caption{Course page} +\end{figure} + + +\begin{figure}[H] + \centering + \includegraphics[width=0.75\textwidth]{images/projectpage.png} + \caption{Project page} +\end{figure} + +\subsection{Joining a group for a project} +If a project requires you to work in a group, you can view all groups by clicking on the "View groups" button on the project page. Here you can see all groups and their members. You can join a group by clicking on the "Join group" button. + +\subsection{Handing in a submission} +If you want to hand in a submission, you can do this by clicking on the "Make a submission" button on the project page. On the submit page, you can upload your files and submit them by dragging them into the dropzone or by clicking on the dropzone and selecting the files. + +\begin{figure}[H] + \centering + \includegraphics[width=0.75\textwidth]{images/submit.png} + \caption{Project page} +\end{figure} + +\subsection{Viewing feedback} +The automatic feedback will be immediately available after submitting and can be viewed on the submit feedback page. Here you will be able to acces the feedback of the file structure tests and advanced tests provided by the teacher. + +\subsection{View your past submissions} +All your past submissions can be viewed on the project page. + +\section{Teacher Section} + +\subsection{Creating a Course} +Teachers can create a new course by clicking the "Create a course" button on the homepage. They can set the course name, description, and privacy settings. After creating the course, they can invite students to join with the link provided. + +\begin{figure}[H] + \centering + \includegraphics[width=0.75\textwidth]{images/createcourse.png} + \caption{Create course page} +\end{figure} + +\subsection{Creating a Project} +Teachers can create a new project by clicking the "Create a project" button on the course page. They can set the project name, description, and deadline. After creating the project, students can submit their work. +Teachers can also set the automatic feedback settings for the project. This ranges from directory structure to advanced test on students code. +Here, the teacher can also set the necessary group size and amount of groups for the project. + +\begin{figure}[H] + \centering + \includegraphics[width=0.75\textwidth]{images/createproject.png} + \caption{Create project page} +\end{figure} + +The teacher can also set simple and advanced tests for the project. The simple tests are run on the file structure of the submission, while the advanced tests are run on the code itself. Even when tests fail, the submission will be saved and the teacher can still view the submission. + +\subsubsection{A quick quide to the simple tests} + +You can add required files in the \textit{required files} field on the add/edit project page. +There are two options for adding files: + +\begin{enumerate}[label=\arabic*.] + \item \textbf{Add a specific file:} \texttt{/extra/report.pdf}\\ + In this case, the file \texttt{report.pdf} is required in the directory \texttt{extra}. + + \item \textbf{Add a file type:} \texttt{src/*.py}\\ + In this case, the only file type al=