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

Development: Update exercise documentation #8349

Merged
merged 8 commits into from
Apr 26, 2024
Merged

Conversation

milljoniaer
Copy link
Contributor

@milljoniaer milljoniaer commented Apr 8, 2024

Checklist

Motivation and Context

Adjusts the documentation to fit the current implementation and user interface of the exercise management.

Steps for Testing

  • See doc preview

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

Summary by CodeRabbit

  • Documentation
    • Updated the video link and removed guided mode from programming exercise setup documentation.
    • Introduced a validation bar for better form validation in programming exercises.
  • New Features
    • Enhanced quiz creation with a new method for adding Apollon drag-and-drop questions, allowing for detailed diagram-based quizzes.

Copy link

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

@milljoniaer milljoniaer marked this pull request as ready for review April 24, 2024 09:41
@milljoniaer milljoniaer requested a review from a team as a code owner April 24, 2024 09:41
Copy link

coderabbitai bot commented Apr 24, 2024

Warning

Rate Limit Exceeded

@milljoniaer has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 45 minutes and 18 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 59d2a61 and 54ab8bf.

Walkthrough

The recent updates in Artemis aim to enhance the user experience by removing the guided mode for programming exercises and introducing a validation bar for form validation. Additionally, the functionality of quiz exercises has been enriched with the ability to create Apollon drag-and-drop questions, offering a more interactive and detailed quiz creation process.

Changes

File Path Change Summary
docs/user/.../programming-exercise-setup.inc Removed guided mode, introduced validation bar, and updated a video link.
docs/user/exercises/quiz.rst Enhanced quiz exercise functionality by adding Apollon drag-and-drop question creation method with detailed editing.

Possibly related issues

  • Programming exercises: Add Athena Feedback Suggestions #7094: The validation bar addition in the programming exercise setup aligns with the objective of improving feedback mechanisms by ensuring better data validation before submission, contributing to enhancing the overall grading and feedback process.

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.
  • 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 Apr 24, 2024
rstief
rstief previously approved these changes Apr 24, 2024
Copy link
Contributor

@rstief rstief left a comment

Choose a reason for hiding this comment

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

lgtm

docs/user/exercises/programming-exercise-setup.inc Outdated Show resolved Hide resolved
docs/user/exercises/quiz.rst Outdated Show resolved Hide resolved
docs/user/exercises/quiz.rst Outdated Show resolved Hide resolved
docs/user/exercises/quiz.rst Outdated Show resolved Hide resolved
docs/user/exercises/quiz.rst Outdated Show resolved Hide resolved
docs/user/exercises/quiz.rst Outdated Show resolved Hide resolved
docs/user/exercises/quiz.rst Outdated Show resolved Hide resolved
@milljoniaer milljoniaer dismissed stale reviews from rstief and coderabbitai via 52df96f April 24, 2024 12:35
coderabbitai[bot]
coderabbitai bot previously approved these changes Apr 24, 2024
coderabbitai[bot]
coderabbitai bot previously approved these changes Apr 24, 2024
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 approve

@krusche krusche changed the title General: Update exercise docs Development: Update exercise documentation Apr 26, 2024
@krusche krusche added this to the 7.0.2 milestone Apr 26, 2024
@krusche krusche merged commit fc22065 into develop Apr 26, 2024
5 of 6 checks passed
@krusche krusche deleted the chore/jo-add-docs branch April 26, 2024 22:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

7 participants