Development: Add documentation for Aeolus service

[reschandreas]

Checklist

General

• 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, Description and Context

Adding some documentation on how to setup aeolus as a service for Artemis to use.

https://artemis-platform--8133.org.readthedocs.build/en/8133/dev/setup/aeolus.html
https://artemis-platform--8133.org.readthedocs.build/en/8133/admin/setup/aeolus.html

Steps for Testing

read the newly added docs

Review Progress

Code Review

• Code Review 1
• Code Review 2

Summary by CodeRabbit

• Documentation
  • Introduced the Aeolus service for custom build plan generation in the Arte application, including setup and integration instructions.
  • Added documentation for configuring Artemis to use the Aeolus service for programming exercises, supporting multiple CI systems and programming languages.
  • Included new setup instructions for the Aeolus service, detailing the installation of dependencies and configuration steps.
  • Provided instructions for setting up the Aeolus service in Jenkins and Integrated code lifecycle in Artemis, along with API key authentication details.

[coderabbitai]

Walkthrough

The recent update enhances the Arte application by integrating the Aeolus service, which provides a REST API for generating and customizing build plans for programming exercises within the Artemis platform. This enhancement enables seamless integration with various CI systems, supports the translation of Bamboo build plans, and expands customization options for programming exercises across all supported languages.

Changes

Files	Change Summary
docs/.gitignore, .../generate_code_cov_table/.gitignore	Added .idea/ to the .gitignore file.
docs/admin/extension-services.rst, docs/dev/setup.rst, docs/user/exercises/programming-exercise-setup.inc	Introduced Aeolus service for custom build plans; added setup instructions and customization options.
docs/admin/setup/aeolus.rst, docs/dev/setup/aeolus.rst	New files detailing the setup process for Aeolus, including Docker installation and Artemis configuration.
docs/conf.py	Updated exclude_patterns list by adding 'venv'.

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-tests 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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[b-fein]

Overall documentation looks good and is clear apart from the ‘API Keys’ section. I’ve left some smaller suggestions.

[laurenzfb]

I have some minor suggestions. Other than that lgtm

[rstief]

Looks good, thanks for adding the documentation :)

[mateusmm01]

LGTM!

[laurenzfb]

lgtm after changes