parse-community / parse-community/docs

Remove forms that request sensitive information

Open
#898 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type:docs
Dominant language
SCSS
Stars
317
Forks
507
PR merge metrics
No merged PRs in 30d

Description

Link to section:

https://docs.parseplatform.org/rest/guide/#your-configuration

What is the issue?

I think this is a well-intended feature, but I don't think we should provide it for security reasons.

This feature asks developers to enter their Parse Server URL, master key and client keys on a webform and submit it. Asking that of a developer goes against establishing awareness for good security practice and facilitates phishing. IMO we should never ask a developer to enter this information anywhere, but in fact create awareness about the sensitivity of that data and remind to never share it with anyone outside a project.

The only way such a feature may make sense was if the docs were made part of a Parse Dashboard backend where the user logged into the dashboard already has access to that information and it is merely displayed from the backend data.

Can you propose a solution?

I'm for removing this feature from the docs and just use common placeholders throughout the code.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the linked “Your configuration” section in the documentation source and locate the form that requests the Parse Server URL, master key, and client keys. Replace the sensitive-information fields with common placeholders and check the surrounding examples to ensure the docs no longer ask users to submit credentials.

Written by the indexing model from the issue text.

Assessment

Tech stack
jekyll
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.