Programming exercises: Improve tooltips and exercise summary on the instructor details page

[florian-glombik]

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.
• I translated all newly inserted strings into English and German.

Motivation and Context

Improve usability of the programming exercise creation process by adjusting translations and displayed information.

Description

• Hiding build plan ids in exercise summary if the setup is using localVC
• Adding description tooltip for auxiliary repositories
• Fixing translations within auxiliary repository table
• Removing tooltip beside created auxiliary repositories

Steps for Testing

Prerequisites:

• 1 Instructor
• 1 Programming exercise on localVC setup

1. Check that the build plan ids are not displayed in the programming exercise details view, if the setup is using localVC.
2. In the programming exercise creation / edit page, check that the "Add auxiliary repository" button has a useful tooltip.
3. In the programming exercise creation / edit page, check that the auxiliary repository table has correct translations.
4. In the programming exercise creation / edit page, check that the tooltip beside the created auxiliary repositories are not displayed anymore

Testserver States

Note

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

Review Progress

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Screenshots

Change	Before	Now
Hide build plan ids
Add Aux Repo tooltip
Fix Aux Repo table translations
Removed Aux Repo tooltips	Tooltips not displayed on hover

[coderabbitai]

Walkthrough

The changes in this update encompass refining user interface elements and localization aspects for programming exercises in a web application. These enhancements involve conditional rendering updates, tooltip refinements, and the incorporation of translated texts to improve user accessibility and comprehension.

Changes

Files	Change Summary
.../programming-exercise-detail.component.ts .../programming-exercise-plans-and-repositories-preview.component.html .../programming-exercise-information.component.html .../help-icon-without-translation.component.ts	Enhanced UI components to facilitate conditional rendering, refined tooltips, and integrated localization for improved clarity and user experience.
i18n/de/programmingExercise.json i18n/en/programmingExercise.json	Introduced new localization fields for auxiliary repositories to support multiple languages efficiently.

Possibly related issues

• Issue Programming exercises: Add Athena Feedback Suggestions #7094: The changes made to programming-exercise-detail.component.ts align with the objective of providing feedback suggestions for programming exercises, enhancing the user experience with conditional rendering based on localVCEnabled.
• Issue Missing Build plans of imported exercise #7439: While not directly related, the enhancements in the UI components could indirectly contribute to addressing inconsistencies in imported exercises by improving the display and management of build plans based on conditions like localVCEnabled.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e549460 and 66bf1ca.

Files selected for processing (1)

• src/main/webapp/i18n/en/programmingExercise.json (1 hunks)

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

• src/main/webapp/i18n/en/programmingExercise.json

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[pzdr7]

Tested on TS2. Looks good 👍

• No build plan IDs ✅
• Aux repo tooltip ✅
• Aux repo table ✅
• No tooltip for aux repo in preview ✅

[pzdr7]

👍