Add minimum and recommended system requirements to local setup guide (#553) - #576
Add minimum and recommended system requirements to local setup guide (#553)#576ruchiralakshan123 wants to merge 4 commits into
Conversation
📝 WalkthroughWalkthroughThe local setup documentation adds a “System requirements” section with minimum and recommended requirements for operating system, CPU, RAM, disk space, and network access. ChangesLocal setup requirements
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Description checkExplanation The description covers the required sections and explains the documentation change, its purpose, approach, release note, testing, and impact. The Documentation section could link directly to the updated page instead of using N/A, but the description is otherwise complete. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/get-started/setup/local-setup.md`:
- Line 21: Update the Network requirement in the local setup prerequisites to
require internet only for installation and dependency downloads; remove WSO2
Cloud connectivity as a minimum prerequisite while preserving the existing
broadband recommendation.
- Line 17: Update the operating-system support row in the local setup
requirements table to include Fedora alongside the existing Linux distributions,
matching the RHEL/Fedora RPM installation instructions. Keep the macOS and
Windows requirements unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: d1b18288-feeb-4050-8146-f35ec6566adc
📒 Files selected for processing (1)
en/docs/get-started/setup/local-setup.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/get-started/setup/local-setup.md`:
- Line 20: Add blank lines immediately before and after the requirements table
in the setup documentation, preserving the table content and formatting while
satisfying Markdownlint MD058.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 5d0626af-5802-4bc8-89e9-3079b3ad198f
📒 Files selected for processing (1)
en/docs/get-started/setup/local-setup.md
AmilaSamith
added
the
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The documentation now contains a duplicated “Installation steps” heading that should be removed to avoid confusing rendered output and duplicate anchors.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds system requirement guidance to the Local Setup documentation so users can validate their environment before installing WSO2 Integrator IDE.
Changes:
- Introduced a new System requirements section with a minimum vs. recommended comparison table.
- Kept the existing installation flow, now preceded by the requirements section.
File summaries
| File | Description |
|---|---|
| en/docs/get-started/setup/local-setup.md | Adds a system requirements section/table ahead of the installation steps. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Broken links, images & orphan pages
Links/images come from one crawl of the production build (baseUrl-aware). Orphans are docs not referenced by Summary
Broken links & imagesIntroduced by this PRNo new broken link(s)/image(s) introduced by this PR. ✅ Already on
|
Purpose
Resolves #553
Goals
Specify the minimum and recommended system requirements in the local setup documentation to help users validate their environments before installation.
Approach
Added a new "System requirements" section with a comparison table (detailing OS, CPU, RAM, Disk Space, and Network specifications) to
en/docs/get-started/setup/local-setup.md.User stories
N/A
Release note
Add minimum and recommended system requirements to local setup guide.
Documentation
N/A (This is a documentation-only fix)
Training
N/A
Certification
N/A
Marketing
N/A
Automation tests
N/A
N/A
Security checks
Samples
N/A
Related PRs
N/A
Migrations (if applicable)
N/A
Test environment
Verified markdown formatting locally.
Learning
N/A
Summary by CodeRabbit