Adaptive learning: Change gif in instructor help in competencies view to video

[ardakaraman0]

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.
• I chose a title conforming to the naming conventions for pull requests.

Client

• I added multiple screenshots/screencasts of my UI changes.

Motivation and Context

The gif in instructor intro view for competencies is hard to understand/follow
Closes #9676

Description

I have replaced the gif in the intro view to a video.

Steps for Testing

Prerequisites:

• 1 Instructor

1. Log in to Artemis
2. Navigate to Course Administration
3. Go to competencies.
4. Click on the help button if the help panel was not opened.
5. Check if the guiding videos are working.

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

Screenshots

Summary by CodeRabbit

• New Features
  • Replaced GIF images with interactive video elements in the course competency explanation modal for enhanced user experience.
  • Added video controls for user interaction.

[coderabbitai]

Walkthrough

The pull request involves updating the course-competency-explanation-modal.component.html file by replacing static GIF images with interactive video elements. Two specific sections within the modal are modified, where <img> tags are substituted with <video> tags that include <source> elements pointing to MP4 files. The video elements are configured with the controls attribute, enabling user playback interaction. The structural layout and content of the modal remain consistent, with only the media format being updated.

Changes

File	Change Summary
src/main/webapp/app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component.html	Replaced GIF images with video elements for course competency creation and relations sections; added video controls

Suggested labels

small

Suggested reviewers

• HawKhiem
• pzdr7
• sachmii
• krusche

Possibly related PRs

• Adaptive learning: Explain course competency view #9511: The changes in this PR involve the introduction of a modal for course competency explanations, which is directly related to the modifications made in the course-competency-explanation-modal.component.html file of the main PR, where media elements are updated to enhance the modal's content presentation.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9318939 and 517201a.

⛔ Files ignored due to path filters (2)

• src/main/resources/public/videos/course-competencies/create-competencies-poster.png is excluded by !**/*.png, !**/*.png
• src/main/resources/public/videos/course-competencies/create-course-competency-relations-poster.png is excluded by !**/*.png, !**/*.png

📒 Files selected for processing (1)

• src/main/webapp/app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component.html (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/main/webapp/app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component.html

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

src/main/webapp/app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component.html (1)

Line range hint 27-44: Consider performance optimization for video assets

While videos provide better user control and potentially clearer instructions than GIFs, consider these performance optimizations:

1. Compress videos appropriately to balance quality and file size
2. Consider using the preload="metadata" attribute (as suggested above) to defer loading
3. Consider generating WebM versions as a modern alternative format

Would you like assistance in setting up a video optimization pipeline for these assets?

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5449cc4 and 9318939.

⛔ Files ignored due to path filters (4)

• src/main/resources/public/videos/course-competencies/create-competencies.gif is excluded by !**/*.gif, !**/*.gif
• src/main/resources/public/videos/course-competencies/create-competencies.mp4 is excluded by !**/*.mp4, !**/*.mp4
• src/main/resources/public/videos/course-competencies/create-course-competency-relations.gif is excluded by !**/*.gif, !**/*.gif
• src/main/resources/public/videos/course-competencies/create-course-competency-relations.mp4 is excluded by !**/*.mp4, !**/*.mp4

📒 Files selected for processing (1)

• src/main/webapp/app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component.html (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/main/webapp/app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component.html (1)

Pattern src/main/webapp/**/*.html: @if and @for are new and valid Angular syntax replacing *ngIf and *ngFor. They should always be used over the old style.

[github-actions]

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

[ufukygmr]

lgtm 🚀