Development: Add documentation for build agent view

[mateusmm01]

Checklist

General

• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Motivation and Context

The docs were missing a user guide for the build agent view. This is a stacked PR with #8413

Description

https://artemis-platform--8417.org.readthedocs.build/en/8417/user/exercises/programming.html#build-agent-view

Review Progress

Performance Review

Code Review

• Code Review 1
• Code Review 2

Summary by CodeRabbit

Summary by CodeRabbit

• Documentation
  • Added a detailed guide on using Git for programming exercises, covering accessing and viewing submissions for students and reviewing submissions for instructors.
  • Enhanced the programming exercise documentation with sections on the integrated code lifecycle system, including Repository View and Build Agent View.

[coderabbitai]

Walkthrough

The recent changes enrich the Artemis platform by introducing new views for build agents and repositories, enhancing the management of programming exercises' lifecycle. These additions aim to offer improved interaction and oversight for both students and instructors.

Changes

Files	Change Summary
.../build-agent-view.inc, .../repository-view.inc	Introduce a new Build Agent View for administrators and a guide on using Git for programming exercises, enhancing the platform's functionality and user experience.
programming.rst	Updates the programming exercise documentation with sections on the integrated code lifecycle system, focusing on Repository View and Build Agent View.

Possibly related issues

• Missing Build plans of imported exercise #7439: The new Build Agent View could assist in managing and monitoring build plans, potentially addressing inconsistencies and errors with build plans in imported exercises.
• Programming exercises: Add Athena Feedback Suggestions #7094: While centered on feedback mechanisms, enhancements in repository navigation and build management could indirectly improve the environment where feedback systems like Athena operate, potentially facilitating smoother integration.

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 13a5084 and c2be6e4.

Files ignored due to path filters (5)

• docs/user/exercises/programming/commit-diff-view.png is excluded by !**/*.png
• docs/user/exercises/programming/commit-history-view.png is excluded by !**/*.png
• docs/user/exercises/programming/current-repository-content-view.png is excluded by !**/*.png
• docs/user/exercises/programming/open-repository-button.png is excluded by !**/*.png
• docs/user/exercises/programming/participations-open-repository.png is excluded by !**/*.png

Files selected for processing (1)

• docs/user/exercises/programming-integrated-code-lifecycle-repository-view.inc (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• docs/user/exercises/programming-integrated-code-lifecycle-repository-view.inc

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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]

Actionable comments posted: 1

[coderabbitai]

Actionable comments posted: 1

[laurenzfb]

lgtm 🚀

[JohannesWt]

Looks good

[JohannesWt]

Reapprove

[rstief]

LGTM 👍