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

fix typo in apollo-design.md #5154

Closed
wants to merge 1 commit into from

Conversation

yeguangsuixing
Copy link

@yeguangsuixing yeguangsuixing commented Jun 11, 2024

What's the purpose of this PR

fix typo in design page

Which issue(s) this PR fixes:

Fixes #

Brief changelog

fix typo in apollo-design.md

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

  • Read the Contributing Guide before making this pull request.
  • 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.
  • Run mvn clean test to make sure this pull request doesn't break anything.
  • Update the CHANGES log.

Summary by CodeRabbit

  • Documentation
    • Updated the sequence diagram to reflect communication from Portal to Admin Service instead of Config Service.
    • Corrected minor text related to metrics.

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Jun 11, 2024
Copy link
Contributor

coderabbitai bot commented Jun 11, 2024

Walkthrough

The recent changes in the docs/zh/design/apollo-design.md involve updating the communication flow in the sequence diagram, where the interaction is now directed from Portal to Admin Service instead of Config Service. Additionally, a minor correction was made to the text related to metrics.

Changes

File Change Summary
docs/zh/design/apollo-design.md Updated sequence diagram interaction from Config Service to Admin Service. Corrected text related to metrics.

Sequence Diagram(s)

sequenceDiagram
    participant Portal
    participant AdminService
    participant ConfigService

    Portal ->> AdminService: request
    AdminService ->> ConfigService: forward request
    ConfigService ->> AdminService: response
    AdminService ->> Portal: response
Loading

Poem

In the land of code, a change so slight,
Portal chats with Admin, day or night.
Metrics corrected, all in line,
Apollo's design, now refined.
🌟🛠️ The system hums, a tune so bright,
With every tweak, it scales new height. 🚀


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
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 <commit_id>.
    • 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


You can retrigger this bot by commenting recheck in this Pull Request

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6218cdd and c82b0bb.

Files selected for processing (1)
  • docs/zh/design/apollo-design.md (2 hunks)
Additional context used
LanguageTool
docs/zh/design/apollo-design.md

[uncategorized] ~6-~6: 您的意思是“"既"是”吗? (JI11_JI2)
Context: #   # 一、总体设计 ## 1.1 基础模型 如下即是Apollo的基础模型: 1. 用户在配置中心对配置进行修改并发布 2. 配...


[uncategorized] ~108-~108: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:极大"地"提高 (wb4)
Context: ...们的应用启动完之后,既充当了Eureka的角色,同时也是服务的提供者。这样就极大的提高了服务的可用性。 * **这一点是我们选择Eureka而不是zk、etcd...


[uncategorized] ~232-~232: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:好"地"实现 (wb4)
Context: ...consumer消费消息。通过一个消息组件(Message Queue)就能很好的实现Admin Service和Config Service的解耦。 在实现上...

Markdownlint
docs/zh/design/apollo-design.md

105-105: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation


107-107: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation


108-108: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation


109-109: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation


111-111: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation


132-132: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


133-133: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


174-174: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


176-176: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


178-178: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


180-180: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


182-182: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


184-184: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


186-186: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


188-188: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


194-194: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


196-196: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


198-198: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


200-200: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


202-202: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


203-203: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


205-205: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


207-207: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


209-209: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


211-211: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


280-280: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


281-281: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


283-283: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


284-284: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation


25-25: Column: 1 (MD010, no-hard-tabs)
Hard tabs


28-28: Column: 1 (MD010, no-hard-tabs)
Hard tabs


37-37: Column: 1 (MD010, no-hard-tabs)
Hard tabs


38-38: Column: 1 (MD010, no-hard-tabs)
Hard tabs


39-39: Column: 1 (MD010, no-hard-tabs)
Hard tabs


40-40: Column: 1 (MD010, no-hard-tabs)
Hard tabs


51-51: Column: 1 (MD010, no-hard-tabs)
Hard tabs


52-52: Column: 1 (MD010, no-hard-tabs)
Hard tabs


53-53: Column: 1 (MD010, no-hard-tabs)
Hard tabs


62-62: Column: 1 (MD010, no-hard-tabs)
Hard tabs


63-63: Column: 1 (MD010, no-hard-tabs)
Hard tabs


64-64: Column: 1 (MD010, no-hard-tabs)
Hard tabs


65-65: Column: 1 (MD010, no-hard-tabs)
Hard tabs


66-66: Column: 1 (MD010, no-hard-tabs)
Hard tabs


67-67: Column: 1 (MD010, no-hard-tabs)
Hard tabs


68-68: Column: 1 (MD010, no-hard-tabs)
Hard tabs


77-77: Column: 1 (MD010, no-hard-tabs)
Hard tabs


78-78: Column: 1 (MD010, no-hard-tabs)
Hard tabs


79-79: Column: 1 (MD010, no-hard-tabs)
Hard tabs


80-80: Column: 1 (MD010, no-hard-tabs)
Hard tabs


81-81: Column: 1 (MD010, no-hard-tabs)
Hard tabs


82-82: Column: 1 (MD010, no-hard-tabs)
Hard tabs


83-83: Column: 1 (MD010, no-hard-tabs)
Hard tabs


92-92: Column: 1 (MD010, no-hard-tabs)
Hard tabs


93-93: Column: 1 (MD010, no-hard-tabs)
Hard tabs


94-94: Column: 1 (MD010, no-hard-tabs)
Hard tabs


95-95: Column: 1 (MD010, no-hard-tabs)
Hard tabs


96-96: Column: 1 (MD010, no-hard-tabs)
Hard tabs


105-105: Column: 1 (MD010, no-hard-tabs)
Hard tabs


107-107: Column: 1 (MD010, no-hard-tabs)
Hard tabs


108-108: Column: 1 (MD010, no-hard-tabs)
Hard tabs


109-109: Column: 1 (MD010, no-hard-tabs)
Hard tabs


111-111: Column: 1 (MD010, no-hard-tabs)
Hard tabs


121-121: Column: 1 (MD010, no-hard-tabs)
Hard tabs


122-122: Column: 1 (MD010, no-hard-tabs)
Hard tabs


123-123: Column: 1 (MD010, no-hard-tabs)
Hard tabs


124-124: Column: 1 (MD010, no-hard-tabs)
Hard tabs


125-125: Column: 1 (MD010, no-hard-tabs)
Hard tabs


126-126: Column: 1 (MD010, no-hard-tabs)
Hard tabs


31-31: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


32-32: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


43-43: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


44-44: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


56-56: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


57-57: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


71-71: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


72-72: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


86-86: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


87-87: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


129-129: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


130-130: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


1-1: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


2-2: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


170-170: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


190-190: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


258-258: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


371-371: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


2-2: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document


213-213: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document


258-258: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document


303-303: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document


367-367: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document


97-97: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines

Additional comments not posted (2)
docs/zh/design/apollo-design.md (2)

81-82: The sequence diagram update correctly reflects the shift from Config Service to Admin Service. This change aligns with the PR's objective to update the communication flow in the documentation.

Tools
Markdownlint

81-81: Column: 1 (MD010, no-hard-tabs)
Hard tabs


82-82: Column: 1 (MD010, no-hard-tabs)
Hard tabs


386-386: The update to expose Prometheus metrics starting from version 1.5.0 is clearly stated and provides useful information for monitoring Apollo services.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jun 11, 2024
@shoothzj
Copy link
Member

Thanks for your contirbution. Would you like to check the CLA? :)

@@ -78,8 +78,8 @@ sequenceDiagram
Meta Server -->> Portal: Admin Service's instances(Multiple IP+Port)
loop until success
Portal ->> Portal: load balance choose a Admin Service instance
Portal ->> Config Service: request
Config Service -->> Portal: ack
Portal ->> Admin Service: request
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you please also help to fix the english version?

Copy link

stale bot commented Jul 14, 2024

This pull request has been automatically marked as stale because it has not had activity in the last 30 days. It will be closed in 14 days if no further activity occurs. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions!

@stale stale bot added the stale label Jul 14, 2024
Copy link

stale bot commented Jul 30, 2024

This pull request has been automatically closed because it has not had activity in the last 14 days. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions!

@stale stale bot closed this Jul 30, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Jul 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files. stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants