update the quick start doc to reflect the latest changes

nobodyiam commented 3 months ago

What's the purpose of this PR

Follow this checklist to help us incorporate your contribution quickly and easily:

[x] Read the Contributing Guide before making this pull request.
[x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
[ ] Write necessary unit tests to verify the code.
[x] Run mvn clean test to make sure this pull request doesn't break anything.
[ ] Update the CHANGES log.

Summary by CodeRabbit

Documentation
- Updated the English and Chinese Quick Start guides for the Apollo project.
- Included instructions for database service discovery.
- Provided updated steps for initializing the Apollo Configuration Center with new profile names and database configurations.
- Added guidance on initializing sample configurations and creating applications.
- Updated illustrations in the quick start guide.

coderabbitai[bot] commented 3 months ago

[!WARNING]

Rate Limit Exceeded

@nobodyiam has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 6 seconds before requesting another review.

How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?
CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.

Commits
Files that changed from the base of the PR and between c255389fc5c6ac08a7d0be4ee5dd639d9b57fcca and 057d401562edfce0ede2eea27639c21c7175aeb4.

Walkthrough

The updates focus on enhancing the apollo-quick-start project setup and configuration process. Key improvements include introducing a database-discovery environment variable for better database service discovery and detailed instructions for initializing the Apollo Configuration Center. Both English and Chinese documentation reflect these changes, with updates to project references, environment variable profiles, and startup commands. The Chinese guide now includes steps for initializing sample configurations and creating applications, along with updated illustrative images.

Changes

File Path	Change Summary
`docs/.../quick-start.md`	Renamed project to `apollo-quick-start`, updated environment variables for `database-discovery`, adjusted initialization instructions and startup commands, added steps for sample configurations and application creation (ZH), updated image URLs (ZH).

🐇✨
In the world of code, where changes abound,
A rabbit hopped in, with updates profound.
"Let's quick-start," it said, with a twirl,
"Apollo's new journey, ready to unfurl."
With discovery and steps so clearly penned,
Our guide now complete, on this path we ascend.
🚀🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 50.29%. Comparing base (c255389) to head (057d401).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #5116 +/- ## ============================================ - Coverage 50.30% 50.29% -0.01% + Complexity 2011 2010 -1 ============================================ Files 388 388 Lines 12216 12216 Branches 1207 1207 ============================================ - Hits 6145 6144 -1 Misses 5708 5708 - Partials 363 364 +1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

apolloconfig / apollo