parse-community / parse-community/docs

Improve Parse Server Guide for Email Options, Account Lockout, PasswordPolicy 📕

Open
#808 3 comments 1 reaction 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

References:
There are a number of options for Parse Server that are only explained on github but aren't explained at all in the Parse Server Guide.

Proposed solution:
It's my view that the Parse Server Guide should be able to explain all the server options and configuration without readers having to know to go to github. For example, if you search for "Mail options (or similar)" on the docs, nothing shows. It could be assumed that these features don't exist.

On that note, I would propose stripping back the README.md on the repo, transitioning most of the contents to the docs site, and mostly pointing the readme to the docs, such as other packages do, eg react, vue. I think only basic configuration should be shown on the github, and the rest should point to the docs site.

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

Compare the Parse Server options described in README.md with the Parse Server Guide, especially the email, account-lockout, and PasswordPolicy sections. Inventory the missing explanations, update the Guide accordingly, and determine which README.md content should remain or point to the documentation site.

Written by the indexing model from the issue text.

Assessment

Tech stack
jekyll
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.