Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adaptive learning: Improve user interface for competency generation #8285

Conversation

rstief
Copy link
Contributor

@rstief rstief commented Apr 1, 2024

Checklist

General

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.
  • 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 screenshots/screencasts of my UI changes.

Description

Improves the following things in the UI:

  • Adds a page heading ("Generate Competency Recommendations")
  • Changed "Enter Description" text to label -> better for screenreaders
  • Changed the chevrons for recommendations to be oriented correctly
  • Some other small fixes

image

Steps for Testing

Prerequisites:

  • 1 Instructor
  • Only test on ts9!
  1. Go to course management -> competencies -> generate
  2. See that the UI looks as expected.

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

Test Coverage

unchanged

Screenshots

see description

Summary by CodeRabbit

  • New Features
    • Added translation support for titles in the competencies generation section.
  • Style
    • Updated icons and styling across various components within the competencies feature.
    • Enhanced visual feedback for collapsed states and empty descriptions.
    • Improved form alert styling in course description components.
  • Refactor
    • Updated icon usage to faPencilAlt for a more intuitive editing experience.

@rstief rstief requested a review from a team as a code owner April 1, 2024 20:40
Copy link

coderabbitai bot commented Apr 1, 2024

Walkthrough

This update focuses on enhancing the user interface and functionality related to generating and managing competency recommendations within a course. Changes include visual adjustments such as icon updates, improved handling of empty descriptions, and the introduction of more descriptive elements in the UI. These improvements aim to streamline the process of editing, deleting, and viewing competency recommendations, making it more intuitive and efficient for instructors.

Changes

Files Change Summary
.../generate-competencies/competency-recommendation-detail.component.html
.../generate-competencies/competency-recommendation-detail.component.ts
Updated icons, added CSS class, improved empty value handling
.../generate-competencies/course-description-form.component.html Replaced heading with label, adjusted alert styling
.../generate-competencies/generate-competencies.component.html Added and updated elements for better title representation and conditional rendering

Possibly related issues

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

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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Apr 1, 2024
Copy link
Contributor

@Jan-Thurner Jan-Thurner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code LGTM

@rstief rstief added the deploy:artemis-test9 Testserver for Project Iris label Apr 2, 2024
@rstief rstief temporarily deployed to artemis-test9.artemis.cit.tum.de April 2, 2024 12:55 — with GitHub Actions Inactive
@github-actions github-actions bot added lock:artemis-test9 and removed deploy:artemis-test9 Testserver for Project Iris labels Apr 2, 2024
Copy link
Contributor

@mateusmm01 mateusmm01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Demonstrated in testing session. Works as expected !

Copy link
Contributor

@laurenzfb laurenzfb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested on ts9, works as expected. Code LGTM

Copy link
Contributor

@milljoniaer milljoniaer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

code looks good 👍

Copy link
Contributor

@egekurt123 egekurt123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested on ts9, works as expected

@rabeatwork
Copy link
Contributor

Maintainer approved

@krusche krusche added this to the 7.0.0 milestone Apr 5, 2024
@krusche krusche changed the title Adaptive Learning: Improve user interface for competency generation Adaptive learning: Improve user interface for competency generation Apr 5, 2024
@krusche krusche merged commit a919595 into develop Apr 5, 2024
77 of 82 checks passed
@krusche krusche deleted the enhancement/adaptive-learning/improve-competency-generation-ui branch April 5, 2024 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!) component:AdaptiveLearning enhancement small
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

8 participants