Improve Parse Server Guide for Email Options, Account Lockout, PasswordPolicy 📕
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- jekyll
- Domain
- documentation
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.
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.
- Dominant language
- SCSS
- Stars
- 317
- Forks
- 506
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from parse-community/docs
-
📙 Opendocs:cloud-code type:docs
Difficulty 1/5 1-3 hours Newbie friendliness 72/100
parse-community/docs#936 ·
-
type:bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
parse-community/docs#889 · 7 comments ·
-
docs:sdk-js
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
parse-community/docs#961 ·
-
type:bug
Difficulty 4/5 3-5 days Newbie friendliness 25/100
parse-community/docs#950 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
parse-community/docs#947 ·
All issues in parse-community/docs
Similar issues
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
githubnext/gh-aw-workshop#3692 ·
-
agent/guide documentation hive/hosted-available-lke648397-260827-5n31
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
priority-0
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
sync-en
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
sync-en
Difficulty 1/5 1-3 hours Newbie friendliness 88/100