feat: Improve README config #2987
Conversation
|
I will reformat the title to use the proper commit message syntax. |
parse-github-assistant
bot
changed the title
|
🚀 Thanks for opening this pull request! We appreciate your effort in improving the project. Please let us know once your pull request is ready for review. |
📝 WalkthroughWalkthroughReplaces fragmented per-option documentation in README with a unified Configuration Reference: organized root keys, configuration file options, App/Global/User subsections, CLI & environment mappings, helper CLI commands, expanded examples, and standardized terminology/formatting. No code exports were changed. Changes
Sequence Diagram(s)(omitted — changes are documentation-only and do not modify control flow) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
🎉 Snyk checks have passed. No issues have been found so far.✅ security/snyk check is complete. No issues have been found. (View Details) |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
179-179: Link fragments should be valid
(MD051, link-fragments)
180-180: Link fragments should be valid
(MD051, link-fragments)
219-219: Link fragments should be valid
(MD051, link-fragments)
223-223: Link fragments should be valid
(MD051, link-fragments)
261-261: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Docker linux/amd64
🔇 Additional comments (6)
README.md (6)
182-192: LGTM!The column preference configuration table is well-structured and accurately documents the available options.
193-203: LGTM!The scripts configuration table accurately documents the script options with appropriate types and descriptions.
204-213: LGTM!The info panel configuration table is comprehensive and matches the feature documentation below.
226-240: LGTM!The user configuration table comprehensively documents authentication options including MFA settings and per-app permissions.
241-255: LGTM!The CLI and server options table is well-structured with appropriate warnings for the
--devflag and clear documentation of defaults.
145-261: Excellent comprehensive configuration reference!This documentation rewrite successfully achieves the PR objective from issue #2465. The new structure provides:
- A unified reference table format for all configuration options
- Clear mapping between config file parameters, CLI arguments, and environment variables
- Type information, defaults, and optionality for each parameter
- Logical organization into App, Global, User, and CLI sections
This is a significant improvement over the previous scattered documentation and will greatly help users understand all available configuration options.
However, please address the link fragment issues and markdown formatting flagged in the other comments.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
README.md (1)
258-263: Add blank line after table.The Helper CLI Commands table should be followed by a blank line before the next section heading to comply with markdown formatting standards.
Apply this diff:
| `--createUser` | Interactive tool to generate secure user passwords and MFA secrets. | | `--createMFA` | Interactive tool to generate MFA secrets for existing users. | + ### FileBased on static analysis hints.
🧹 Nitpick comments (2)
README.md (2)
661-663: Remove blank line inside blockquote.The warning blockquote contains a blank line which should be removed for proper markdown formatting.
Based on static analysis hints.
984-986: Add language identifier to code block.The fenced code block should specify a language for proper syntax highlighting. Since this is a Docker command, use
bashorshell.Apply this diff:
-``` +```bash docker run -d -p 8080:4040 -v host/path/to/config.json:/src/Parse-Dashboard/parse-dashboard-config.json parseplatform/parse-dashboard --devBased on static analysis hints. </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: CodeRabbit UI **Review profile**: CHILL **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 142494341697ff2d74d73a3e4ec38d428a9f81aa and 9ee3ac22042bf4ffe9a105c60e32208217318fd7. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `README.md` (44 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 markdownlint-cli2 (0.18.1)</summary> <details> <summary>README.md</summary> 663-663: Blank line inside blockquote (MD028, no-blanks-blockquote) --- 998-998: Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 1006-1006: Emphasis used instead of a heading (MD036, no-emphasis-as-heading) </details> </details> </details> <details> <summary>⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)</summary> * GitHub Check: Node 18 * GitHub Check: Node 22 * GitHub Check: Docker linux/amd64 </details> <details> <summary>🔇 Additional comments (5)</summary><blockquote> <details> <summary>README.md (5)</summary><blockquote> `181-182`: **LGTM! Anchor links fixed.** The anchor links for `#scripts` and `#info-panel` now correctly match the actual section headers. The previous issue with `#scripts-configuration` and `#info-panel-configuration` has been resolved. --- `221-221`: **LGTM! User configuration anchor fixed.** The anchor link `#user-configuration-users` now correctly matches the section header "##### User Configuration (`users[]`)". --- `147-256`: **Excellent configuration documentation structure!** The comprehensive configuration tables successfully achieve the PR objectives: - Unified documentation for CLI options, config file structure, and environment variables - Clear mapping between different configuration methods - Proper type annotations and examples - Well-organized into logical sections (App, User, Global, CLI/Server) This is a significant improvement over scattered documentation. --- `147-1590`: **Excellent documentation restructuring!** This PR successfully achieves its objectives by creating a comprehensive, well-organized configuration reference that: ✅ Provides unified tables mapping CLI options, config file parameters, and environment variables ✅ Includes clear type annotations, default values, and examples ✅ Organizes options into logical sections (App, User, Global, CLI/Server, Scripts, Info Panel, etc.) ✅ Replaces scattered documentation with a structured, easy-to-navigate reference ✅ Maintains backward compatibility while improving clarity The restructuring makes Parse Dashboard configuration significantly easier to understand and use. The table format provides a clear overview while detailed sections offer in-depth guidance where needed. --- `225-225`: **No ambiguity: '#configuration' anchor is unique.** The only "### Configuration" heading (anchor `#configuration`) appears under "## AI Agent" at line 1396, while "#### Configuration File Options" uses `#configuration-file-options`. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
536-537: Fix typo in scripts option reference.
scripsshould bescripts; otherwise, readers may miss the correct configuration key.-You can also specify custom fields with the `scrips` option: +You can also specify custom fields with the `scripts` option:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(9 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
514-514: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
514-514: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
649-649: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
649-649: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Docker linux/amd64
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Docker linux/amd64
| | `apiKey` | String | yes | - | - | - | `"myFileKey"` | File key (also called apiKey) for file migrations. | | ||
| | `graphQLServerURL` | String | yes | - | `--graphQLServerURL` | `PARSE_DASHBOARD_GRAPHQL_SERVER_URL` | `"http://localhost:1337/graphql"` | The URL where your Parse GraphQL Server is running. | |
There was a problem hiding this comment.
Restore the documented key name to fileKey.
The dashboard config expects the field to be named fileKey; documenting it as apiKey will break readers who follow this table literally. Please rename the entry (and its description/example) back to fileKey.
+| fileKey | String | yes | - | - | - | "myFileKey" | File key used for file migrations. |
🤖 Prompt for AI Agents
In README.md around lines 176 to 177, the table row currently documents the key
as `apiKey` with description/example referencing file migrations; change the key
name back to `fileKey` and update its description and example to match the
dashboard config (e.g., label as "File key used for file migrations" and keep
the example value `"myFileKey"`), ensuring the column entries and example cell
reflect `fileKey` rather than `apiKey`.
There was a problem hiding this comment.
@coratgerl I assume you've been using an AI agent for these changes. Could you please also do a manual review of the changes, to make sure they are all valid?
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
New Pull Request Checklist
Closes: #2465
Summary by CodeRabbit