apache / rocketmq

Apache RocketMQ is a cloud native messaging and streaming platform, making it simple to build event-driven applications.
https://rocketmq.apache.org/
Apache License 2.0
21.19k stars 11.67k forks source link

[Docs] Refactor Rocketmq documentation #4343

Closed kaori-seasons closed 1 year ago

kaori-seasons commented 2 years ago

At present, because rocketmq-site does not display according to the version number released by rocketmq, when users use it, they do not know whether a configuration item has been upgraded. Refer to kafka-site and pulsar-site。. Currently decided to refactor the 4.x version of the documentation

The work to be done in the first stage is as follows

  1. Organize the configuration documents of the broker and client modules, and confirm with the community
  2. Confirm the unit test of the broker and the client, and run the example. Locating and explaining key classes
  3. Organize the documentation of nameserver

FEATURE REQUEST

  1. Please describe the feature you are requesting.

  2. Provide any additional detail on your proposed use case for this feature.

  3. Indicate the importance of this issue to you (blocker, must-have, should-have, nice-to-have). Are you currently using any workarounds to address this issue?

  4. If there are some sub-tasks involved, use -[] for each sub-task and create a corresponding issue to map to the sub-task:

LXPWing commented 2 years ago

Cool I want to try it

kaori-seasons commented 2 years ago

Cool I want to try it

The tasks are being split recently, and it is expected that the specific sub-tasks will be improved before next Friday

kaori-seasons commented 2 years ago

According to the current release order of rocketmq, the documents of four versions of 4.6, 4.7, 4.8 and 4.9 are sorted at this stage. The official website homepage document is re-divided into five guide items: Quickstart , Configuration , Performance , Operations, Clients and API Docs Refer to the initial version of kafka (0.7) documentation Give an example of producer and consumer, and update the histogram of throughput comparison according to the stress test results

Currently only refactoring documentation for 4.9.3

github-actions[bot] commented 1 year ago

This issue is stale because it has been open for 365 days with no activity. It will be closed in 3 days if no further activity occurs.

github-actions[bot] commented 1 year ago

This issue was closed because it has been inactive for 3 days since being marked as stale.