parse-dashboard icon indicating copy to clipboard operation
parse-dashboard copied to clipboard

Add config options table to README

Open mtrezza opened this issue 2 years ago • 1 comments

New Feature / Enhancement Checklist

Current Limitation

The dashboard README is verbose and is missing a clear, single table that documents the config options:

  • CLI options
  • config file structure

Feature / Enhancement Description

  • Add a config table that documents each options and maps the CLI parameters to the config file structure. In other word it should be a single table for both.
  • A CLI config should also be supported by the dashboard config file, but sometimes is isn't (yet). The table should provide that overview.
  • Write a proper documentation for each parameter, instead of spreading bits all over code examples. In turn, much of the verbose examples and text can be removed from the README, unless a parameter requires its own section in the README.

Example Use Case

Option Config File Type CLI Argument Optional Description
Application ID apps[].appId String appId no The application ID. Must match the application ID set in Parse Server.

mtrezza avatar Jun 18 '23 12:06 mtrezza

Thanks for opening this issue!

  • 🎉 We are excited about your ideas for improvement!