Skip to content

Add minimum and recommended system requirements to local setup guide (#553) - #576

Open
ruchiralakshan123 wants to merge 3 commits into
wso2:mainfrom
ruchiralakshan123:add-system-requirements
Open

Add minimum and recommended system requirements to local setup guide (#553)#576
ruchiralakshan123 wants to merge 3 commits into
wso2:mainfrom
ruchiralakshan123:add-system-requirements

Conversation

@ruchiralakshan123

@ruchiralakshan123 ruchiralakshan123 commented Jul 12, 2026

Copy link
Copy Markdown

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

  • Unit tests
    N/A
  • Integration tests
    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

  • Documentation
    • Added a new System requirements section to the local setup guide.
    • Documented minimum and recommended operating system, CPU, memory, disk space, and network requirements.

@coderabbitai

coderabbitai Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@ruchiralakshan123, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 48 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c5cc15d5-54a6-411d-8e50-dd075171aab7

📥 Commits

Reviewing files that changed from the base of the PR and between 632fd0d and 5ccbe71.

📒 Files selected for processing (1)
  • en/docs/get-started/setup/local-setup.md
📝 Walkthrough

Walkthrough

The local setup documentation adds a “System requirements” section with minimum and recommended requirements for operating system, CPU, RAM, disk space, and network access.

Changes

Local setup requirements

Layer / File(s) Summary
Document system requirements
en/docs/get-started/setup/local-setup.md
Adds a minimum-versus-recommended requirements table covering operating system, CPU, RAM, disk space, and network access.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: anupama-pathirage, kavinduzoysa, nipunaranasinghe, rosensilva

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly states the main documentation change and matches issue #553.
Description check ✅ Passed The description follows the template and covers purpose, goals, approach, release note, docs, testing, and security sections.
Linked Issues check ✅ Passed The added system requirements section covers the requested minimum/recommended OS, CPU, RAM, disk space, and network prerequisites.
Out of Scope Changes check ✅ Passed The PR is limited to the local setup documentation and does not introduce unrelated changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7e6d503 and d4241af.

📒 Files selected for processing (1)
  • en/docs/get-started/setup/local-setup.md

Comment thread en/docs/get-started/setup/local-setup.md Outdated
Comment thread en/docs/get-started/setup/local-setup.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between d4241af and 632fd0d.

📒 Files selected for processing (1)
  • en/docs/get-started/setup/local-setup.md

Comment thread en/docs/get-started/setup/local-setup.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Minimum and recommended system requirements are missing in the Local Setup documentation

1 participant