Development: Add documentation for build queue 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 queue view. This is a stacked PR with #8417

Description

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

Review Progress

Performance Review

Code Review

• Code Review 1
• Code Review 2

Summary by CodeRabbit

• New Features

  • Introduced a Build Agent View for Administrators, providing a Summary View and a Details View for efficient monitoring and management of build agents.
  • Launched a Build Queue View for Administrators and Instructors to track running, queued, and finished build jobs with interactive control options.
  • Added a guide on Repository View for Git interactions in programming exercises, enabling students and instructors to access and review submissions.

• Documentation

  • Updated documentation to include detailed information on new programming exercise features: Repository View, Build Agent View, and Build Queue View.

• Refactor

  • Adjusted pagination settings to display 5 items per page, improving user experience and system performance.

[coderabbitai]

Walkthrough

The recent updates enhance Artemis' integrated code lifecycle system with new views and functionalities, providing improved control and visibility for instructors and administrators. These changes introduce new views for managing build agents, build queues, and repositories, aimed at enhancing the efficiency of programming exercises. Additionally, the pagination setting in the web application has been optimized by reducing the items per page, enhancing user interface interactions.

Changes

File Path	Summary of Changes
.../programming-integrated-code-lifecycle-build-agent-view.inc .../programming-integrated-code-lifecycle-build-queue-view.inc	Introduced Build Agent View and Build Queue View for administrators and instructors, respectively, to monitor and manage build jobs.
.../programming-integrated-code-lifecycle-repository-view.inc	Added a guide on using Git for version control in programming exercises, detailing submission and repository management.
docs/user/exercises/programming.rst	Updated to include descriptions of new features: Repository View, Build Agent View, and Build Queue View.
src/main/webapp/app/shared/constants/pagination.constants.ts	Modified ITEMS_PER_PAGE constant value from 50 to 5 for improved pagination in the application.

Possibly related issues

• Missing Build plans of imported exercise #7439: The introduction of Build Agent View and Build Queue View in this PR addresses the need to ensure build plans work as expected and are not missing, aligning with the objective of addressing inconsistencies in imported exercises.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f136883 and 356d55c.

Files selected for processing (1)

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

Additional comments not posted (3)

docs/user/exercises/programming-integrated-code-lifecycle-build-queue-view.inc (3)

23-34: The description and figure for the "Running Build Jobs" section are clear and effectively communicate the functionality. Good use of visuals and text.

---

38-50: The "Queued Build Jobs" section is well-documented, providing clear instructions and visuals on managing queued jobs.

---

54-66: The "Finished Build Jobs" section is comprehensive, with detailed instructions on accessing build logs for completed jobs. This is crucial for understanding and troubleshooting builds.

---

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.

[laurenzfb]

Documentation overall looks good, minor nitpicks

[krusche]

There are still small issues in the documentation. I tried to improve as much as possible. Unfortunately, @mateusmm01 left the team without properly finishing the work :-( therefore, we merge this PR now and improve the documentation step by step in the future.