Development: Update read the docs config

[krusche]

Checklist

• I chose a title conforming to the naming conventions for pull requests.
• All relevant checks pass

Motivation and Context

I received the following email:

We are announcing the deprecation of projects using Sphinx or MkDocs without an explicit configuration in their .readthedocs.yaml file. After January 20, 2025, Read the Docs will require explicit configuration for all Sphinx and MkDocs projects.

We used to automatically try to find the configuration file for your project, but in order to make builds more explicit and predictable, we are deprecating this behavior. This will also allows us to better support projects that don't use Sphinx or MkDocs in the near future.

What do I need to do?

If you're using Sphinx or MkDocs, ensure your .readthedocs.yaml file includes the appropriate configuration key. For example:

For Sphinx projects:

version: 2
sphinx:
configuration: docs/conf.py
For MkDocs projects:

version: 2
mkdocs:
configuration: mkdocs.yml
Note: If you're using build.commands, no changes are required.

Deprecation timeline

We will implement this change gradually:

January 6, 2025: Builds will be temporarily disabled for 12 hours (00:01 PST to 11:59 PST)
January 13, 2025: Builds will be temporarily disabled for 24 hours (00:01 PST to 23:59 PST)
January 20, 2025: Final cutoff date - builds without explicit configuration will be permanently disabled

Summary by CodeRabbit

• Documentation
  • Updated setup instructions for multiple instances of the Artemis application server, including configuration for the JHipster Registry and ActiveMQ broker.
  • Expanded guidance on running multiple instances locally with detailed commands for various operating systems.
  • Revised copyright and author information in documentation configuration files to reflect the new copyright holder.

[coderabbitai]

Walkthrough

The pull request involves updating copyright and authorship information across multiple files. The changes primarily affect the LICENSE file and documentation configuration, shifting the copyright holder from "TUM Applied Software Engineering" to "TUM Applied Education Technologies". The modifications are administrative in nature, updating organizational references while maintaining the core content and structure of the documents.

Changes

File	Change Summary
LICENSE	Updated copyright holder from "TUM Applied Software Engineering" to "TUM Applied Education Technologies"
docs/admin/setup/distributed.rst	Updated documentation with more detailed setup instructions for multiple Artemis application server instances, including configuration details and local deployment guidance
docs/conf.py	Updated copyright and author variables to reflect the new organizational name

Suggested Labels

documentation, config-change, ready for review

Suggested Reviewers

• SimonEntholzer
• HawKhiem
• Feras797

---

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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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]

Actionable comments posted: 0

🧹 Nitpick comments (4)

docs/admin/setup/distributed.rst (4)

20-20: Simplify the statement for clarity

The statement "Artemis also supports this setup (which is also used at TUM)" is redundant with "also" appearing twice. Consider simplifying it to "Artemis supports this setup (which is used at TUM)" or just "This setup is supported by Artemis".

---

Line range hint 1024-1025: Add security warnings and prerequisites for each OS setup

Consider adding the following for each OS section:

1. Prerequisites checklist (required software versions, permissions, etc.)
2. Security considerations for production deployments
3. Troubleshooting section for common issues

This will help users prepare their environment properly and avoid security pitfalls.

Also applies to: 1048-1049, 1058-1059

---

Line range hint 147-196: Add configuration validation steps

Consider adding validation steps after the Eureka configuration section to help users verify their setup:

1. How to verify the Eureka connection is successful
2. Common error messages and their solutions
3. Health check endpoints to monitor

This will help users confirm their configuration is working as expected.

---

Line range hint 1-1064: Enhance documentation with additional cross-references

The documentation is well-structured, but consider adding:

1. A table of contents at the beginning
2. Cross-references between related sections
3. Links to external documentation for third-party components
4. A troubleshooting section at the end

This will improve navigation and help users find related information quickly.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0d0a9e9 and aed58e3.

⛔ Files ignored due to path filters (1)

• docs/.readthedocs.yaml is excluded by !**/*.yaml

📒 Files selected for processing (3)

• LICENSE (1 hunks)
• docs/admin/setup/distributed.rst (1 hunks)
• docs/conf.py (1 hunks)

✅ Files skipped from review due to trivial changes (2)

• LICENSE
• docs/conf.py

🔇 Additional comments (1)

docs/admin/setup/distributed.rst (1)

Line range hint 1-1064: Documentation changes look good!

The documentation updates are comprehensive and well-structured. The changes successfully:

1. Update copyright and organizational references
2. Add detailed multi-instance setup instructions
3. Include OS-specific configuration steps
4. Provide clear technical guidance

While there are some suggestions for improvements, the core changes are solid and ready to be merged.