Feature/documentation

[ShuaiweiYu]

Thank you for contributing to Hades! Please fill out the details below to help us review and test your changes effectively.

✨ What is the change?

Enhance the README and replace the deprecated description

✅ PR Checklist

• I have tested these changes locally or on the dev environment
• Code is clean, readable, and documented
• Tests added or updated (if needed)
• Documentation updated (if relevant)

Summary by CodeRabbit

Release Notes

• Documentation
  • Updated Kubernetes deployment to use Helm-based approach with Hades Operator as the recommended method; Kubernetes Executor is now deprecated
  • Added VM deployment pathway with prerequisites and step-by-step guide
  • Reorganized documentation structure for improved clarity on deployment options

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR adds IDE run configuration for HadesOperator, updates documentation to deprecate Kubernetes Executor in favor of Hades Operator as the primary deployment method, and introduces Helm-based Kubernetes deployment and VM deployment pathways with reorganized content structure.

Changes

Cohort / File(s)	Summary
IDE Run Configurations .idea/runConfigurations/HadesCI.xml, .idea/runConfigurations/HadesOperaor.xml	Added new GoApplicationRunConfiguration entry for HadesOperator to the IDE run configuration setup, enabling direct execution from the development environment.
Documentation Updates Readme.md, HadesScheduler/HadesOperator/Readme.md	Updated main README to deprecate Kubernetes Executor, establish Hades Operator (CRD-based) as the primary Kubernetes deployment path, introduce Helm-based deployment flow, and add new VM deployment pathway. Minor header capitalization fix in HadesOperator subdirectory README.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

Hops of joy! New config hops in place,
Hades Operator takes the lead with grace,
From Kubernetes executor's weary stride,
Helm-based paths now light the way inside,
🐰 Documentation dances, fresh and bright!

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is largely incomplete, missing several required sections including detailed 'What is the change?' explanation, reason/issue link, and testing steps; only documentation checkbox is marked.	Fill in the missing sections: provide a detailed description of changes, link to relevant issues, include testing steps (e.g., how to verify README updates and run configurations), and address unchecked checklist items.
Title check	❓ Inconclusive	The title 'Feature/documentation' is vague and generic, using non-descriptive terms that don't convey meaningful information about the actual changes (README updates, Hades Operator configuration, and Kubernetes deployment path changes).	Use a more specific title that highlights the main change, such as 'Update README with Hades Operator and Helm-based Kubernetes deployment' or 'Document Hades Operator as primary Kubernetes deployment path'.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/documentation

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (3)

HadesScheduler/HadesOperator/Readme.md (3)

13-14: ⚠️ Potential issue | 🟡 Minor

Fix the incomplete sentence in the feature list.

Line 13 reads “Collect build logs using for…”, which is grammatically broken and unclear.

Suggested fix

-- Collect build logs using for easier debugging and monitoring.
+- Collect build logs for easier debugging and monitoring.

---

33-34: ⚠️ Potential issue | 🟡 Minor

Correct grammar and typos in the optional ClusterWide note.

The current sentence is awkward and has a typo (“top be”).

Suggested fix

-- (Optional) If you want to have the operator to have the Cluster wide access, 
-  modify `hadesOperator.clusterWide` top be `true`
+- (Optional) If you want the operator to have cluster-wide access,
+  modify `hadesOperator.clusterWide` to be `true`.

---

20-23: ⚠️ Potential issue | 🟠 Major

Update prerequisite versions to current standards.

The Go, kubectl, and Kubernetes versions specified are outdated. As of February 2026, the latest stable releases are Go 1.25.7 and Kubernetes v1.35.0. The listed Go v1.24.0+, kubectl v1.14.0+, and Kubernetes v1.16.0+ should be updated to reflect current upstream support. Kubernetes upstream maintains only three minor releases; recommend updating to at least Kubernetes v1.33.0+ (oldest in the current support window). Verify exact minimum versions based on your operator's controller-runtime and client-go dependencies, and ensure CRD API version compatibility (v1 CRDs require Kubernetes 1.19+).

🤖 Fix all issues with AI agents

In @.idea/runConfigurations/HadesCI.xml:
- Line 4: The run configuration name "HadesOperaor" is misspelled and will break
references; update the name attribute in the <toRun> element from "HadesOperaor"
to the correct spelling (e.g., "HadesOperator") so the
GoApplicationRunConfiguration entry matches expected references; ensure you only
change the name value in the <toRun name="HadesOperaor"
type="GoApplicationRunConfiguration" /> element to the corrected string and keep
the type unchanged.

In @.idea/runConfigurations/HadesOperaor.xml:
- Around line 1-10: Update the run configuration name and filename to fix the
typo "HadesOperaor": change the configuration attribute name="HadesOperaor" to
name="HadesOperator" inside the GoApplicationRunConfiguration block (the element
with type="GoApplicationRunConfiguration" and package
value="github.com/ls1intum/hades/HadesScheduler/HadesOperator/cmd" and filePath
value ending in "/HadesScheduler/HadesOperator/cmd/main.go"), and rename the
file .idea/runConfigurations/HadesOperaor.xml to
.idea/runConfigurations/HadesOperator.xml; ensure any references to the old
filename or the old name string are updated accordingly.