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

typo: portal access admin service #5305

Merged
merged 1 commit into from
Jan 2, 2025
Merged

Conversation

liuby01
Copy link
Contributor

@liuby01 liuby01 commented Jan 2, 2025

What's the purpose of this PR

Fixed a error in sequence diagram.

Which issue(s) this PR fixes:

Fixes #

Brief changelog

Fixed a error in sequence diagram. Portal should access admin service, not config service.

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 Apollo design documentation in English and Chinese versions
    • Corrected sequence diagram to show Portal interacting directly with Admin Service instead of Config Service
    • Clarified service interaction flow in architectural documentation

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

coderabbitai bot commented Jan 2, 2025

Walkthrough

The pull request updates the Apollo design documentation in both English and Chinese versions, focusing on correcting the service interaction sequence between the Portal and the services. The key modification involves changing the documentation to show that the Portal now sends requests directly to the Admin Service instead of the Config Service, reflecting an updated communication flow in the Apollo system's architecture.

Changes

File Change Summary
docs/en/design/apollo-design.md Updated sequence diagram to show Portal requesting services from Admin Service
docs/zh/design/apollo-design.md Modified service interaction flow, replacing Config Service with Admin Service in documentation

Sequence Diagram

sequenceDiagram
    participant Portal
    participant AdminService
    
    Portal ->> AdminService: Request configuration
    AdminService -->> Portal: Acknowledge request
Loading

Possibly related PRs

Suggested labels

lgtm

Suggested reviewers

  • nobodyiam

Poem

🐰 Hopping through Apollo's design,
Services dance in a new align,
Portal speaks to Admin with grace,
Config Service steps back with a trace,
Documentation now shines bright! 🌟


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

github-actions bot commented Jan 2, 2025

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@liuby01
Copy link
Contributor Author

liuby01 commented Jan 2, 2025

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

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

🧹 Nitpick comments (2)
docs/zh/design/apollo-design.md (1)

81-82: LGTM! Documentation now correctly shows Portal accessing Admin Service.

The sequence diagram update accurately reflects the intended architecture where Portal interacts with Admin Service for configuration management tasks.

Replace hard tabs with spaces for consistent formatting:

-		Portal ->> Admin Service: request
-		Admin Service -->> Portal: ack
+    Portal ->> Admin Service: request
+    Admin Service -->> Portal: ack
🧰 Tools
🪛 Markdownlint (0.37.0)

81-81: Column: 1
Hard tabs

(MD010, no-hard-tabs)


82-82: Column: 1
Hard tabs

(MD010, no-hard-tabs)

docs/en/design/apollo-design.md (1)

77-78: LGTM! Documentation now correctly shows Portal accessing Admin Service.

The sequence diagram update in the English documentation matches the Chinese version and accurately reflects the intended architecture.

Replace hard tabs with spaces for consistent formatting:

-  		Portal ->> Admin Service: request
-  		Admin Service -->> Portal: ack
+    Portal ->> Admin Service: request
+    Admin Service -->> Portal: ack
🧰 Tools
🪛 Markdownlint (0.37.0)

77-77: Column: 3
Hard tabs

(MD010, no-hard-tabs)


78-78: Column: 3
Hard tabs

(MD010, no-hard-tabs)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0c7c341 and 05e1e77.

📒 Files selected for processing (2)
  • docs/en/design/apollo-design.md (1 hunks)
  • docs/zh/design/apollo-design.md (1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
docs/en/design/apollo-design.md

77-77: Column: 3
Hard tabs

(MD010, no-hard-tabs)


78-78: Column: 3
Hard tabs

(MD010, no-hard-tabs)

docs/zh/design/apollo-design.md

81-81: Column: 1
Hard tabs

(MD010, no-hard-tabs)


82-82: Column: 1
Hard tabs

(MD010, no-hard-tabs)

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 2, 2025
@hezhangjian hezhangjian merged commit b6cd5b0 into apolloconfig:master Jan 2, 2025
7 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jan 2, 2025
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants