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

Exam mode: Update student documentation #9625

Merged
merged 13 commits into from
Nov 24, 2024

Conversation

edkaya
Copy link
Contributor

@edkaya edkaya commented Oct 29, 2024

Checklist

General

Motivation and Context

Since we made some minor changes in the exam sidebar and added "Exercise save" button, some of the screenshots in the documentation as well as on artemis features page remained outdated.

Description

I updated exam documentation with the latest screenshots.

Steps for Testing

Prerequisites:
1 Student

  1. Navigate to exam documentation and verify that screenshots look up-to-date.
  2. Login Artemis
  3. Navigate to the URL: https://artemis-testX.artemis.cit.tum.de/features/students and https://artemis-testX.artemis.cit.tum.de/features/instructors, where X is the current test server number
    (e.g. if you deploy on TS3, you need to navigate to https://artemis-test3.artemis.cit.tum.de/features/students)
  4. Verify that screenshots look consistent.

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

Summary by CodeRabbit

  • New Features

    • Added video links for enhanced guidance on accessing and participating in exams.
    • Expanded instructions on saving changes during exercises, clarifying options for different exercise types.
  • Documentation

    • Updated the student guide to improve clarity and usability for exam preparation.

@github-actions github-actions bot added client Pull requests that update TypeScript code. (Added Automatically!) documentation labels Oct 29, 2024
@github-actions github-actions bot removed the client Pull requests that update TypeScript code. (Added Automatically!) label Oct 29, 2024
Copy link

github-actions bot commented Nov 5, 2024

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.

@github-actions github-actions bot added the stale label Nov 5, 2024
@edkaya edkaya removed the stale label Nov 6, 2024
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.

@github-actions github-actions bot added the stale label Nov 14, 2024
@github-actions github-actions bot added client Pull requests that update TypeScript code. (Added Automatically!) and removed stale labels Nov 16, 2024
@edkaya edkaya marked this pull request as ready for review November 17, 2024 16:52
@edkaya edkaya requested a review from a team as a code owner November 17, 2024 16:52
Copy link

coderabbitai bot commented Nov 17, 2024

Walkthrough

The pull request updates the students_guide.rst document to enhance guidance on the exam process. Key changes include the addition of two video links for accessing and participating in exams, embedded in the "Welcome Screen" and "Summary" sections. The "Exam Conduction" section has been expanded to clarify saving options during exercises, with specific instructions for different exercise types. New button references for saving and uploading exercises have also been included to improve clarity for students.

Changes

File Path Change Summary
docs/user/exams/students_guide.rst - Added video link for exam access in "Welcome Screen" section.
- Added video link for exam participation in "Summary" section.
- Expanded "Exam Conduction" to specify saving options during exercises.
- Added button references for `

Possibly related PRs

Suggested labels

ready for review

Suggested reviewers

  • BBesrour
  • SimonEntholzer
  • egekurt123
  • krusche

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>, 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 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[bot]
coderabbitai bot previously approved these changes Nov 17, 2024
@edkaya edkaya changed the title Exam mode: Update exam mode student documentation General: Update exam mode student documentation Nov 17, 2024
Copy link
Contributor

@eceeeren eceeeren left a comment

Choose a reason for hiding this comment

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

Changes LGTM

@Fallthunderclap
Copy link

I tested according to the steps and everything worked as expected.

Copy link
Contributor

@magkue magkue left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

@HawKhiem HawKhiem left a comment

Choose a reason for hiding this comment

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

LGTM

@krusche krusche changed the title General: Update exam mode student documentation Exam mode: Update student documentation Nov 24, 2024
@krusche krusche merged commit fdc6755 into develop Nov 24, 2024
105 of 111 checks passed
@krusche krusche deleted the chore/general/update-exam-mode-documentation branch November 24, 2024 18:54
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!) documentation ready to merge small
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

8 participants