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

Add config options table to README #2465

Open
3 tasks done
mtrezza opened this issue Jun 18, 2023 · 1 comment
Open
3 tasks done

Add config options table to README #2465

mtrezza opened this issue Jun 18, 2023 · 1 comment
Labels
bounty:$20 Bounty applies for fixing this issue (Parse Bounty Program) type:docs Only change in the docs or README

Comments

@mtrezza
Copy link
Member

mtrezza commented Jun 18, 2023

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.
@parse-github-assistant
Copy link

Thanks for opening this issue!

  • 🎉 We are excited about your ideas for improvement!

@mtrezza mtrezza added type:docs Only change in the docs or README bounty:$20 Bounty applies for fixing this issue (Parse Bounty Program) labels Jun 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bounty:$20 Bounty applies for fixing this issue (Parse Bounty Program) type:docs Only change in the docs or README
Projects
None yet
Development

No branches or pull requests

1 participant