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

[ISSUE #202] refine the supporting document for cluster LB and failover #224

Closed
wants to merge 1 commit into from

Conversation

HudsonShi
Copy link

@HudsonShi HudsonShi commented Jun 17, 2024

…ver' documentation

Fixes #issue_id [ISSUE #202]

Motivation

Refined the supporting document for cluster load balancing and failover
The previous documentation of cluster load balancing and failover is incomplete

Modifications

*Add the supporting document for cluster load balancing and failover in the runtime instruction *

Documentation

  • Does this pull request introduce a new feature?
  • no

@Pil0tXia
Copy link
Member

Please fix the PR title and fill in body.

@Pil0tXia
Copy link
Member

@HudsonShi

image

Your PR title is truncated, and please fill in some information in the PR body.

@HudsonShi HudsonShi changed the title [ISSUE #202] refine the 'Support for cluster load balancing and failo… [ISSUE #202] refine the supporting document for cluster LB and failover Jun 17, 2024
Copy link
Member

@Pil0tXia Pil0tXia left a comment

Choose a reason for hiding this comment

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

Please note that these contents do not involve the deployment environment/steps or commands of the EventMesh cluster, so they should not be placed under the Installation and Deployment category. You can create a category about the cluster in the Design Document.

Additionally, there are the following issues:

  1. The EventMesh website supports both English and Chinese languages. If possible, please make synchronous modifications to the Chinese documentation as well.
  2. The added text is too colloquial and seems to be extracted from someone's narrative during a meeting, lacking structural elements as a document. For example, you can add multiple subheadings such as "Using the Registry Center" or "Using a Distributed Consistency Protocol," taking Nacos and JRaft as examples, respectively, to introduce the differences in their support levels. Their usage and configuration differences can be written in another document, placed under the Installation and Deployment section.
  3. Please pay attention to the standard naming of proprietary terms, as it will help with search engine optimization. For example, you should use "EventMesh" instead of "event-mesh," "JRaft" instead of "j-raft," and "Nacos" instead of "NACOS."
  4. Please be mindful of inaccuracies to avoid misleading users. For instance, currently, the JRaft protocol is actually functional, so your original statement "that PR is not functional" is inaccurate.

The existing content is far from sufficient to explain the cluster features of EventMesh. You can continue to improve it in subsequent PRs. Projects like Apache RocketMQ, Apache Flink, Apache Doris, Apache Druid have comprehensive documentation on cluster deployment, which you can refer to. ☺️

@Pil0tXia
Copy link
Member

@HudsonShi There are some errors in your PR's body regarding the usage of the Fixes keyword, which will render this keyword ineffective. You can refer to other merged PRs to see how the Fixes keyword is used correctly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants