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

Learning path: Fix competency graph overflow and display minimap #8992

Merged
merged 2 commits into from
Jul 11, 2024

Conversation

JohannesWt
Copy link
Contributor

@JohannesWt JohannesWt commented Jul 8, 2024

Checklist

General

Client

Motivation and Context

When opening the competency graph the graph had a visible overflow at the bottom.

Description

This PR fixes the bottom overflow of the competency graph and shows the minimap of the graph to give the user better orientation.

Steps for Testing

Prerequisites:

  • 1 Instructor
  • 1 Student
  • at least 2 connected competencies with each at least one lecture unit (or Exercise)
  1. Log in to Artemis
  2. Navigate to the student learning path UI
  3. Open the Learning path navigation overview
  4. Verify that the graph can not be dragged out of the modal window vertically
  5. Verify that the minimap of the graph is shown

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

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Test Coverage

Screenshots

Minimap of the competency graph

(difficult to screenshot its better to see it on the test server)
image

Summary by CodeRabbit

  • New Features

    • Introduced mini-map functionality within the competency graph component with options for maximum width and height.
  • Style

    • Enhanced styling of the competency graph modal to prevent overflow issues, ensuring a better user experience.

@JohannesWt JohannesWt self-assigned this Jul 8, 2024
@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Jul 8, 2024
@JohannesWt JohannesWt marked this pull request as ready for review July 8, 2024 13:19
@JohannesWt JohannesWt requested a review from a team as a code owner July 8, 2024 13:19
Copy link

coderabbitai bot commented Jul 8, 2024

Walkthrough

The recent updates introduced notable enhancements to the competency graph component within the learning paths feature. Specifically, a mini-map display functionality has been incorporated, along with adjustable parameters to control its size. Other changes focus on layout and style improvements for the competency graph modal to ensure better overflow handling and visual presentation.

Changes

Files Change Summary
src/main/webapp/app/course/learning-paths/components/competency-graph-modal/competency-graph-modal.component.html Wrapped <jhi-competency-graph> in a <div> with class competency-graph-modal-body h-100.
src/main/webapp/app/course/learning-paths/components/competency-graph-modal/competency-graph-modal.component.scss Added overflow: hidden; property to the .competency-graph-modal class.
src/main/webapp/app/course/learning-paths/components/competency-graph/competency-graph.component.html Added attributes [showMiniMap]="true", [miniMapMaxWidth]="200", and [miniMapMaxHeight]="150".

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.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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.

coderabbitai[bot]
coderabbitai bot previously approved these changes Jul 8, 2024
Copy link

github-actions bot commented Jul 8, 2024

⚠️ Unable to deploy to test servers ⚠️

The docker build needs to run through before deploying.

@github-actions github-actions bot added the deployment-error Added by deployment workflows if an error occured label Jul 8, 2024
@Jan-Thurner Jan-Thurner added deploy:artemis-test3 and removed deployment-error Added by deployment workflows if an error occured labels Jul 8, 2024
@Jan-Thurner Jan-Thurner temporarily deployed to artemis-test3.artemis.cit.tum.de July 8, 2024 13:47 — with GitHub Actions Inactive
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.

Tested on TS3. The map is quite dark. The navigation works well though. Code also looking good.

Copy link
Contributor

@JohannesStoehr JohannesStoehr 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 TS3. The map is quite dark. The navigation works well though. Code also looks good

Copy link
Contributor

@florian-glombik florian-glombik left a comment

Choose a reason for hiding this comment

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

Approve code

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.

Code LGTM

Copy link
Contributor

@SimonEntholzer SimonEntholzer left a comment

Choose a reason for hiding this comment

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

code

Copy link
Contributor

@rabeatwork rabeatwork left a comment

Choose a reason for hiding this comment

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

Maintainer approved

@JohannesWt JohannesWt added ready to merge maintainer-approved The feature maintainer has approved the PR and removed ready for review labels Jul 10, 2024
@krusche krusche added this to the 7.4.2 milestone Jul 11, 2024
@krusche krusche merged commit 3e131aa into develop Jul 11, 2024
65 of 69 checks passed
@krusche krusche deleted the feature/learning-paths/fix-competency-graph-overflow branch July 11, 2024 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix client Pull requests that update TypeScript code. (Added Automatically!) maintainer-approved The feature maintainer has approved the PR ready to merge small
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

8 participants