Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
dblythy opened this issue Jan 3, 2021 · 3 comments · May be fixed by #809
Open

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

dblythy opened this issue Jan 3, 2021 · 3 comments · May be fixed by #809

Comments

@dblythy
Copy link
Member

dblythy commented Jan 3, 2021

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.

@TomWFox
Copy link
Contributor

TomWFox commented Jan 3, 2021

I would agree that it makes sense to document all the options (that aren't experimental - unless clearly denoted). I'm definitely in agreement on stripping back the readme, this should make future docs changes more clear IMO.

@dblythy
Copy link
Member Author

dblythy commented Jan 3, 2021

Maybe a subcategory on the docs page for experimental / untested “at your own risk” features? And then after a period of time transition those features into the core set when we’re confident with them

@TomWFox
Copy link
Contributor

TomWFox commented Jan 3, 2021

Yeah that would probably be good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants