Communication: Add FAQs to Artemis

[cremertim]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• Database Migration
• I chose a title conforming to the naming conventions for pull requests.

Server

• Important: I implemented the changes with a very good performance and prevented too many (unnecessary) and too complex database calls.
• I strictly followed the principle of data economy for all database calls.
• I strictly followed the server coding and design guidelines.
• I added multiple integration tests (Spring) related to the features (with a high test coverage).
• I added pre-authorization annotations according to the guidelines and checked the course groups for all new REST Calls (security).
• I documented the Java code using JavaDoc style.

Client

• Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data (e.g. using paging).
• I strictly followed the principle of data economy for all client-server REST calls.
• I strictly followed the client coding and design guidelines.
• Following the theming guidelines, I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
• I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
• I added authorities to all new routes and checked the course groups for displaying navigation elements (links, buttons).
• I documented the TypeScript code using JSDoc style.
• I added multiple screenshots/screencasts of my UI changes.
• I translated all newly inserted strings into English and German.

Motivation and Context

It is tedious to answer the same question over and over again. To tackle this issue, this PR introduces a FAQ feature, which allows the custom creation of frequently asked questions.

Description

Server side:
I added the the basic structure of FAQ's. Also, i updated courses to have multiple FAQ's and a flag, that enables using them.

Client side:
The whole interface for creating, updating and deleting new FAQs in a Management Page (Instructor Side)
The whole interface for students to view and filter for FAQs in the Course Overview of a Course (new tab, if faqs are enabled)

Steps for Testing

Prerequisites:

• 1 Instructor
• 1 Editor
• 1 Students

1. Log in to Artemis as Instructor

2. Navigate to Course Management

3. Create a new Course with FAQs enabled / Enable FAQs for a existing course

4. Go to the FAQ Management

5. Create / Delete / Update FAQ's
   6 Filter for FAQ's in the Management Page

6. Try to go to the FAQ Management as an Editor/Tutor, this should not be possible.

7. Log into Artemis as Student within the same course

8. Go to Course Overview

9. See previously created FAQ's

10. Filter the FAQ's

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

Review Progress

Performance Review

• I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance even for very large courses with more than 2000 students.
• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance even for very large courses with more than 2000 students.

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Exam Mode Test

• Test 1
• Test 2

Performance Tests

• Test 1
• Test 2

Test Coverage

Client

Class/File	Line Coverage	Confirmation (assert/expect)
faq.component.ts	95,8%	✅
faq-update.component.ts	98,57%	✅
faq-service.component.ts	100%	✅
faq-utils.component.ts	90%	✅
course-faq.component.ts	97,72%	✅
course-faq-accordion.component.ts	100%	✅

Server

Class/File	Line Coverage	Confirmation (assert/expect)
FaqRessource.java	100%	✅

Screenshots

Student view (Course Overview FAQ Tab)

Instructor view (FAQ Management Page)

Creation / Update Dialog

Flag to enable FAQ

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Introduced a Frequently Asked Questions (FAQ) management system, allowing users to create, update, retrieve, and delete FAQs associated with courses.
  • Enhanced FAQ management with a dedicated component for improved user interaction.
  • Added a user-friendly interface for editing FAQs, including a Markdown editor and category selector.
  • Implemented role-based access control for FAQ actions.

• Bug Fixes

  • Resolved various issues related to the display and management of FAQs.

• Documentation

  • Updated localization files to include new strings for FAQ features in English and German.

• Style

  • Enhanced UI components for better accessibility and user experience in FAQ management.

• Chores

  • Minor adjustments to coverage thresholds in testing configurations.

[coolchock]

re-approve

[farisd16]

Retested on ts4, worked as expected