Skip to content

docs: Remove sensitive REST configuration form#973

Open
ShravanthReddy wants to merge 1 commit into
parse-community:gh-pagesfrom
ShravanthReddy:docs/remove-sensitive-config-form
Open

docs: Remove sensitive REST configuration form#973
ShravanthReddy wants to merge 1 commit into
parse-community:gh-pagesfrom
ShravanthReddy:docs/remove-sensitive-config-form

Conversation

@ShravanthReddy
Copy link
Copy Markdown

@ShravanthReddy ShravanthReddy commented May 10, 2026

Closes #898.

Summary

  • removes the interactive REST server configuration form that asked users to enter server URL, app ID, master key, client key, and REST API key values into the docs page
  • removes the JavaScript/localStorage customization handlers for those values
  • keeps static placeholders and adds guidance to replace keys only in local code or terminal sessions

Verification

  • npm run webpack
  • git diff --check
  • rg -n "parse-server-custom-(appid|masterkey|clientkey|restapikey|url|mount|protocol|values-reset)|localStorage\.setItem\('parse-server-custom|localStorage\.getItem\('parse-server-custom|your-master-key-here|your-client-key-here|your-rest-api-key-here" _includes/common/server-customize.md _app/main.js assets/js/bundle.js -S

Not run

  • bundle exec jekyll build: local Ruby tooling is incompatible with the checked-in lockfile on this machine; system Ruby 2.6 is too old for locked Nokogiri, while available Ruby 3.3 is too new for locked minitest 5.14.2.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Simplified server configuration documentation with clearer instructions for local development and security best practices. Removed interactive server field customization feature from the documentation page.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 10, 2026

📝 Walkthrough

Walkthrough

The PR removes a web form from the documentation that asked developers to enter sensitive server configuration (master key, client keys, and URL) and requested it on the page. This functionality is replaced with static documentation guidance to use placeholder values only in local code and terminals, improving security awareness.

Changes

Security: Remove Server Configuration Form

Layer / File(s) Summary
Documentation Guidance
_includes/common/server-customize.md
"Your Configuration" section with HTML form for entering sensitive credentials is replaced with "Server Configuration" section instructing users to use placeholder REST examples locally; masterKey security warning is retained.
Code Removal
_app/main.js
Call to setupServerFieldCustomization() is removed from docs initialization; entire method (localStorage persistence, event handlers) is deleted.

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 6 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Engage In Review Feedback ❓ Inconclusive Check requires engagement with review feedback. Git shows single commit, no metadata on review comments or revisions. GitHub PR review comments not visible in git repo. Cannot assess feedback engagement without GitHub PR system access.
✅ Passed checks (6 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed The pull request successfully removes the sensitive REST configuration form, JavaScript handlers, and localStorage logic as required by issue #898, replacing them with static placeholders and security guidance.
Out of Scope Changes check ✅ Passed All changes are directly aligned with the objectives in issue #898; no out-of-scope modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Security Check ✅ Passed Removes insecure form collecting Parse Server credentials. Eliminated setupServerFieldCustomization method and localStorage handlers. No new vulnerabilities found.
Title check ✅ Passed The pull request title begins with the required 'docs:' prefix and accurately describes the main change: removing a sensitive REST configuration form from the documentation.

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

✨ 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 and usage tips.

@ShravanthReddy ShravanthReddy changed the title Remove sensitive REST configuration form docs: Remove sensitive REST configuration form May 11, 2026
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.

Remove forms that request sensitive information

1 participant