docs: Clarify cluster option is CLI-only

[ShravanthReddy]

Summary

• clarifies that the cluster option only takes effect when Parse Server is started through the CLI
• regenerates src/Options/Definitions.js and src/Options/docs.js from the option definition source

Closes parse-community/docs#848.
Refs #6894.

Verification

• npm run definitions
• npm run docs
• npm run ci:definitionsCheck
• npm run build

Note: this machine is currently on Node 23.6.1, so npm ci emitted engine warnings because the repo supports Node 20/22/24, but the commands above completed successfully.

Summary by CodeRabbit

• Documentation
  • Clarified cluster option behavior: it only applies when Parse Server is started via the CLI, not when configured in the options object.

[parse-github-assistant]

I will reformat the title to use the proper commit message syntax.

[parse-github-assistant]

🚀 Thanks for opening this pull request! We appreciate your effort in improving the project. Please let us know once your pull request is ready for review.

Tip

• Keep pull requests small. Large PRs will be rejected. Break complex features into smaller, incremental PRs.
• Use Test Driven Development. Write failing tests before implementing functionality. Ensure tests pass.
• Group code into logical blocks. Add a short comment before each block to explain its purpose.
• We offer conceptual guidance. Coding is up to you. PRs must be merge-ready for human review.
• Our review focuses on concept, not quality. PRs with code issues will be rejected. Use an AI agent.
• Human review time is precious. Avoid review ping-pong. Inspect and test your AI-generated code.

Note

Please respond to review comments from AI agents just like you would to comments from a human reviewer. Let the reviewer resolve their own comments, unless they have reviewed and accepted your commit, or agreed with your explanation for why the feedback was incorrect.

Caution

Pull requests must be written using an AI agent with human supervision. Pull requests written entirely by a human will likely be rejected, because of lower code quality, higher review effort and the higher risk of introducing bugs. Please note that AI review comments on this pull request alone do not satisfy this requirement. Our CI and AI review are safeguards, not development tools. If many issues are flagged, rethink your development approach. Invest more effort in planning and design rather than using review cycles to fix low-quality code.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4dd38222-0309-45e9-879a-0232dacae8c5

📥 Commits

Reviewing files that changed from the base of the PR and between 4f90c5e and 3acf8c1.

📒 Files selected for processing (3)

• src/Options/Definitions.js
• src/Options/docs.js
• src/Options/index.js

---

📝 Walkthrough

Walkthrough

This PR updates documentation for the cluster option across three files in the Options module to clarify that cluster behavior only applies when Parse Server is started via CLI and has no effect when set on the ParseServer options object.

Changes

Cluster Option Documentation Clarification

Layer / File(s)	Summary
Option Documentation Updates src/Options/Definitions.js, src/Options/docs.js, src/Options/index.js	The cluster option's help text and JSDoc/inline documentation are updated to specify that cluster configuration only applies when Parse Server is started through the CLI, and that setting cluster on the ParseServer options object has no effect.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

• mtrezza

🚥 Pre-merge checks | ✅ 6 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Engage In Review Feedback	❓ Inconclusive	Cannot verify PR review comments from local repo. Check requires GitHub PR page access to see review feedback and verify engagement.	Review the GitHub PR #10459 page to check for review comments and verify author engagement with feedback before closing/resolving.

✅ Passed checks (6 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title begins with the 'docs:' prefix and clearly summarizes the main change: clarifying cluster option documentation for CLI-only usage.
Description check	✅ Passed	The description covers the main changes, includes issue references (Closes/Refs), provides verification steps, and addresses documentation updates required by the template.
Linked Issues check	✅ Passed	The PR successfully addresses issue #848 by clarifying the cluster option documentation across multiple files and regenerating documentation sources from the definition.
Out of Scope Changes check	✅ Passed	All changes are focused on clarifying cluster option documentation across three files (Definitions.js, docs.js, index.js) as required by the linked issues.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Security Check	✅ Passed	This PR contains only documentation/help text updates. No code changes introduce security vulnerabilities. All modifications are in documentation strings across 3 files with 6 total lines changed.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 OpenGrep (1.20.0)

OpenGrep fatal error (exit code 2): [00.11][ERROR]: Error: exception Unix_error: No such file or directory stat src/Options/docs.js
Raised by primitive operation at UTmp.replace_named_pipe_by_regular_file_if_needed in file "libs/commons/UTmp.ml", line 145, characters 8-27
Called from Scan_CLI.replace_target_roots_by_regular_files_where_needed.(fun) in file "src/osemgrep/cli_scan/Scan_CLI.ml", lines 1086-1087, characters 19-65
Called from List_.fast_map in file "libs/commons/List_.ml", line 81, characters 17-20
Called from Scan_CLI

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

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.}

[ShravanthReddy]

Ready for review. This is a narrow docs-only/generated-options update for parse-community/docs#848; local verification completed with npm run definitions, npm run docs, npm run ci:definitionsCheck, and npm run build.