apache / apache/rocketmq-site

[DOC] some possible language errors and example errors in the v5.0 version document

Open
#580 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
66
Forks
262
Avg merge
4d 19h
Merged PRs (30d)
2

Description

**Language Errors**
1. Domain Model > Topic > Behavior constraints:
![image](https://github.com/apache/rocketmq-site/assets/34032341/83b57869-90ba-44e6-987c-c901de3b8252)
![image](https://github.com/apache/rocketmq-site/assets/34032341/2104ee22-6688-4037-b720-43164b4d06e6)
advised to change these sentences to:
1.1 Consistent message types. The messages that...
1.2 Only one type of messages sent to a topic. The messages that...
1.3 消息类型必须一致:发送的消息的类型必须和目标主题定义的消息类型一致。。。
1.4 主题类型必须单一:每个主题只支持一种消息类型,不允许将多种类型的消息发送到同一个主题中。。。

2. 功能特性 > 消息发送重试和流控机制 > 背景信息:
![image](https://github.com/apache/rocketmq-site/assets/34032341/62f6cac8-b72a-43f6-a747-e11d0f2f81b9)
There is an extra space between the letters M and Q.

3. Feature Behavior > Message Filtering > Attribute-based SQL filtering:
![image](https://github.com/apache/rocketmq-site/assets/34032341/37b3597a-0187-438b-bb6b-89f218c294ba)
![image](https://github.com/apache/rocketmq-site/assets/34032341/8823e946-54eb-47d0-aca2-05ba7f2686fc)
Use '/' instead of '\'.

4. Feature Behavior > Consumer Load Balancing > Message-based load balancing:
![image](https://github.com/apache/rocketmq-site/assets/34032341/7d9e4d02-05bf-49c8-9d1b-d5c1a79f54b8)
![image](https://github.com/apache/rocketmq-site/assets/34032341/f926a909-b394-4c70-96f4-8d07e6a59f90)
advised to change these sentences to:
4.1 More balanced consumption allocation. In conventional queue-based load...
4.2 More forgiving to differences in networking capacities. In an online production...
4.3 Easier O\&M for queue allocation. In scenarios where conventional...
4.4 消费分摊更均衡:对于传统队列级的负载均衡策略,如果。。。
4.5 对非对等消费者更友好:在线上生产环境中,由于。。。
4.6 队列分配运维更方便:传统基于绑定队列的负载均衡策略必须保证。。。

5. 领域模型 > 队列 > 使用建议:
![image](https://github.com/apache/rocketmq-site/assets/34032341/b7491d67-a525-4245-9ba2-346229c0935e)
空轮询一词容易产生误解,空轮询多指Java NIO在Linux环境下的epoll bug,此处也许可以修改为:队列过多对应更多的轮询请求,增加系统负荷。

**Example Errors**
1. Feature Behavior > Normal Message > Example:

```bash
sh mqadmin updateTopic -n -t -c -a +message.type=Normal

# Normal -> NORMAL (case sensitive)
```
2. Feature Behavior > Ordered Message > Example:

```bash
./bin/mqadmin updateTopic -c DefaultCluster -t FIFOTopic -o true -n 127.0.0.1:9876

# lack -a +message.type=FIFO
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the v5.0 version document and review the listed Domain Model, Feature Behavior, and 功能特性 sections. Check each proposed wording, spacing, slash, and command example, including the Normal and Ordered Message snippets. Done means the documented language and examples match the corrections described in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, shell
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.