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

Improve UX of evaluation show page #5636

Draft
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

jorg-vr
Copy link
Contributor

@jorg-vr jorg-vr commented Jun 24, 2024

This pull request replaces the old feedback status icons with the submissions status icons and textual buttons.

This is done because the old icon wasn't clear for new users. The table wasn't readable and it was also unclear that the icons where actually buttons.

Now that the table itself is clearer, I removed the help text.

image
image

For reference the old icons:
image

  • Documentation update can be found at dodona-edu/dodona-edu.github.io#

Closes #4173

@jorg-vr jorg-vr added the enhancement A change that isn't substantial enough to be called a feature label Jun 24, 2024
@jorg-vr jorg-vr self-assigned this Jun 24, 2024
@jorg-vr jorg-vr marked this pull request as ready for review June 24, 2024 15:21
@jorg-vr jorg-vr requested a review from bmesuere as a code owner June 24, 2024 15:21
@BTWS2
Copy link
Contributor

BTWS2 commented Jun 25, 2024

What do you think about vertically aligning the text?
image

Copy link
Member

@bmesuere bmesuere left a comment

Choose a reason for hiding this comment

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

I'm not sure about this. The current design didn't come out of nowhere and was the result of many iterations taking into account evaluations with multiple columns (in the overview), and limited v-space (on an evaluation itself). I'll first revisit the original iterations (at a later time) before reviewing this.

@jorg-vr
Copy link
Contributor Author

jorg-vr commented Jun 28, 2024

#1777

@jorg-vr
Copy link
Contributor Author

jorg-vr commented Aug 5, 2024

Bart, I don't remember what were the discussed requested changes for this pr?

I do remember discussing that the changes where now much less important due to the 'evaluate' buttons at the top.
So am also open to closing the pr and the underlying issue

@bmesuere
Copy link
Member

bmesuere commented Aug 5, 2024

I recall

  • that the icons were used throughout the feature and that removing half of them would make it more confusing on other places
  • that the overview is primarily an overview and that icons are preferred there over text links
  • that if some of the current icons aren't clear enough, we could try to come up with better alternatives e.g. instead of the colored lines to indicate correct/incorrect, add a badge to the icon.

Copy link

coderabbitai bot commented Aug 5, 2024

Walkthrough

The recent changes primarily enhance the user experience of the evaluations interface by simplifying the display of feedback statuses, improving button visibility, and refining the layout of feedback entries. Modifications to CSS styles streamline the visual presentation while new helper methods aid in generating clearer feedback titles. Overall, these changes focus on improving usability and clarity for users interacting with evaluations.

Changes

Files Change Summary
app/assets/stylesheets/components/*.css.scss Removed specific styles related to user feedback presentation, simplifying layout and potentially enhancing visual hierarchy.
app/helpers/evaluation_helper.rb Introduced feedback_title method to provide localized feedback status messages, enhancing clarity for users.
app/views/evaluations/*.html.erb Streamlined feedback status rendering and improved user feedback row layout for better organization and clarity.
config/locales/views/evaluations/*.yml Modified localization strings to improve clarity and consistency in feedback messages, removing redundant descriptions.

Assessment against linked issues

Objective Addressed Explanation
Improve clarity in feedback display and user interaction (e.g., button visibility)
Ensure users can easily locate grading functionalities Changes do not address navigation to grading directly.
Streamline user feedback for better understanding

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 Configuration 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.

@jorg-vr jorg-vr marked this pull request as draft August 5, 2024 08:48
@jorg-vr
Copy link
Contributor Author

jorg-vr commented Aug 5, 2024

What do you think of this?

image

Keeps the checkmark with comment icon used in other places. But also uses the known submission state icons, thus separating the two types of information into two columns.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement A change that isn't substantial enough to be called a feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve UX of evaluations
3 participants