Skip to content

Remove old documentation - #1549

Merged
lukasfrank merged 2 commits into
ironcore-dev:mainfrom
afritzler:chore/remove-stale-docs
Aug 28, 2026
Merged

lukasfrank merged 2 commits into
ironcore-dev:mainfrom
afritzler:chore/remove-stale-docs

Conversation

@afritzler

@afritzler afritzler commented Aug 27, 2026

Copy link
Copy Markdown
Member

Proposed Changes

Since the documentation of the IaaS layer moved to https://github.com/ironcore-dev/ironcore-dev.github.io/tree/main/docs/iaas it can be safely removed from the ironcore project.

Summary by CodeRabbit

  • Documentation
    • Removed architecture and execution-flow documentation.
    • Removed installation, development setup, contribution, and testing guides.
    • Removed usage documentation for compute, networking, IPAM, storage, and resource quota features.
    • Resource documentation no longer includes examples, field references, lifecycle details, or reconciliation guidance.
    • Updated README links to the hosted contribution guidelines and getting-started documentation.

Since the documentation of the IaaS layer moved to
https://github.com/ironcore-dev/ironcore-dev.github.io/tree/main/docs/iaas
it can be safely removed from the ironcore project.

Signed-off-by: Andreas Fritzler <andreas.fritzler@sap.com>
@afritzler
afritzler requested a review from a team as a code owner August 27, 2026 09:27
@github-actions github-actions Bot added chore documentation Improvements or additions to documentation labels Aug 27, 2026
@coderabbitai

coderabbitai Bot commented Aug 27, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: c76707ce-b2c3-414b-a716-497e3d4a635e

📥 Commits

Reviewing files that changed from the base of the PR and between 2a2d86f and c3c2908.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The change removes local architecture, development, installation, concept, and resource documentation. The README now links to hosted contribution and getting-started documentation. No exported or public entities change.

Changes

Documentation update

Layer / File(s) Summary
Remove local documentation
docs/architecture/*, docs/concepts/*, docs/development/*, docs/usage/*
The pull request removes documentation for architecture, development workflows, installation, compute resources, networking, storage, IPAM, and quotas.
Redirect README links
README.md
The development section links to hosted contribution guidelines and hosted getting-started documentation.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to c3c29

This change removes outdated documentation and redirects readers to the maintained documentation site; no actionable merge-blocking risk remains beyond normal checks and review.

Suggested reviewers: adracus

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the primary change: removal of outdated documentation.
Description check ✅ Passed The description explains that the IaaS documentation moved to the ironcore-dev.github.io repository and states why the local documentation can be removed. It is relevant and sufficiently complete, alt…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description explains that the IaaS documentation moved to the ironcore-dev.github.io repository and states why the local documentation can be removed. It is relevant and sufficiently complete, although it does not include a Fixes issue reference.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@hardikdr hardikdr added the area/iaas Issues related to IronCore IaaS development. label Aug 27, 2026
@hardikdr hardikdr added this to Roadmap Aug 27, 2026

@lukasfrank lukasfrank left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pls also update this link in the README:

⚠️ Before contributing, make sure you read the contribution guidelines

Signed-off-by: Andreas Fritzler <andreas.fritzler@sap.com>
@afritzler
afritzler force-pushed the chore/remove-stale-docs branch from dbf5d1c to c3c2908 Compare August 28, 2026 08:44
@lukasfrank
lukasfrank merged commit 1cc6777 into ironcore-dev:main Aug 28, 2026
10 checks passed
@github-project-automation github-project-automation Bot moved this to Done in Roadmap Aug 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/iaas Issues related to IronCore IaaS development. chore documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants