Skip to content

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

Open

Description

@dblythy

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.

Activity

  1. TomWFox commented on Jan 3, 2021

    @TomWFox
    Contributor

    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.

  2. dblythy commented on Jan 3, 2021

    @dblythy
    MemberAuthor

    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

  3. TomWFox commented on Jan 3, 2021

    @TomWFox
    Contributor

    Yeah that would probably be good.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions