Development: Improve wording in competency help window

[ufukygmr]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• This is a small issue that I tested locally and was confirmed by another developer 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

• 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

We want to reduce the technical dept of the terminology used in Competency UI. For the issue, it is required to go over all Competency ui and check the terminology so that it will be understandable by non-tech people.

Description

This PR replaces the word Modal with Window to reduce technical dept. I go over whole competency UI and find only word "Modal" as technical word and replaced it with "Window"

Steps for Testing

Prerequisites:

• 1 Instructor

1. Log in to Artemis (with instructor account)
2. Go to a Test course
3. Go to competencies tab
4. In the first modal that describes the competency logic, there should not be any technical words and all should be replaced with non-tech words.
5. In the rest of the Competency UI, there should not be any technical words like Modal.

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.

Code Review

• Code Review 1
• Code Review 2

Screenshots

Summary by CodeRabbit

• New Features

  • Updated terminology in the user interface for clarity, changing "modal" to "window" in the competency management section.

• Bug Fixes

  • Enhanced descriptions and labels for competency relationships for better user understanding and consistency.

[coderabbitai]

Walkthrough

The changes in this pull request involve updates to the localization files competency.json for both German and English in the Artemis application. The primary modification is the replacement of the term "Modal" with "Fenster" in German and "window" in English, reflecting a shift towards more user-friendly terminology in the competency management interface. Additionally, minor adjustments were made to descriptions and labels for clarity, but no structural changes to the JSON files were made.

Changes

File	Change Summary
src/main/webapp/i18n/de/competency.json	Updated terminology from "Modal" to "Fenster" and refined descriptions for clarity.
src/main/webapp/i18n/en/competency.json	Changed "Edit Relations' modal" to "Edit Relations' window" in the competency management section.

Possibly related issues

• Reduce technical depth of terminology used in the competency ui #9679: The changes address the issue of reducing technical terminology in the competency UI, specifically replacing "Modal" with more descriptive terms.

Possibly related PRs

• Adaptive learning: Explain course competency view #9511: This PR updates competency.json files for better clarity and usability, aligning with the localization focus of the main PR.

Suggested labels

small

Suggested reviewers

• HawKhiem
• pzdr7
• sachmii
• krusche

---

📜 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 d5d8004 and 98391a4.

📒 Files selected for processing (1)

• src/main/webapp/i18n/de/competency.json (1 hunks)

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

• src/main/webapp/i18n/de/competency.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>, 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: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 36adbf6 and d5d8004.

📒 Files selected for processing (2)

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

✅ Files skipped from review due to trivial changes (1)

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

🧰 Additional context used

📓 Path-based instructions (1)

src/main/webapp/i18n/de/competency.json (1)

Pattern src/main/webapp/i18n/de/**/*.json: German language translations should be informal (dutzen) and should never be formal (sietzen). So the user should always be addressed with "du/dein" and never with "sie/ihr".

[HawKhiem]

Tested on TS2. LGTM changes

[zagemello]

Tested on TS2, works as expected :)

[sachmii]

Tested on TS2, everything works fine.

[SimonEntholzer]

Translation string update makes sense

[HawKhiem]

Tested on TS3. Reapprove

[MaximilianAnzinger]

Maintainer approved