From e4fd9a8cf88af041a2dd180d0c47b9a014acc3ab Mon Sep 17 00:00:00 2001 From: kaxiya1021 Date: Mon, 3 Jun 2024 01:03:29 +0800 Subject: [PATCH 1/2] Modify directory names and document names --- docs/00-introduction/_category_.json | 2 +- docs/01-quickstart/01quickstart.md | 2 +- docs/01-quickstart/03quickstartWithDockercompose.md | 2 +- docs/01-quickstart/_category_.json | 4 ++++ .../current/01-quickstart/01quickstart.md | 2 +- .../01-quickstart/03quickstartWithDockercompose.md | 2 +- .../version-5.0/02-quickStart/01quickstart.md | 8 ++++---- .../02-quickStart/03quickstartWithDockercompose.md | 8 ++++---- .../version-5.0/02-quickStart/01quickstart.md | 12 ++++++------ .../02-quickStart/03quickstartWithDockercompose.md | 6 +++--- 10 files changed, 26 insertions(+), 22 deletions(-) create mode 100644 docs/01-quickstart/_category_.json diff --git a/docs/00-introduction/_category_.json b/docs/00-introduction/_category_.json index 750e4bf6c7..0d3ceb679e 100644 --- a/docs/00-introduction/_category_.json +++ b/docs/00-introduction/_category_.json @@ -1,4 +1,4 @@ { "label": "基本概念", - "position": 1 + "position": 0 } \ No newline at end of file diff --git a/docs/01-quickstart/01quickstart.md b/docs/01-quickstart/01quickstart.md index c17dcebe30..293317a738 100644 --- a/docs/01-quickstart/01quickstart.md +++ b/docs/01-quickstart/01quickstart.md @@ -1,4 +1,4 @@ -# 快速开始 +# 本地部署 RocketMQ 这一节介绍如何快速部署一个单 Master RocketMQ 集群，并完成简单的消息收发。 diff --git a/docs/01-quickstart/03quickstartWithDockercompose.md b/docs/01-quickstart/03quickstartWithDockercompose.md index 13b0c1d43e..b234c87872 100644 --- a/docs/01-quickstart/03quickstartWithDockercompose.md +++ b/docs/01-quickstart/03quickstartWithDockercompose.md @@ -1,4 +1,4 @@ -# Docker-compose 部署 RocketMQ +# Docker Compose 部署 RocketMQ 这一节介绍如何使用Docker-compose快速部署一个单节点单副本 RocketMQ 服务，并完成简单的消息收发。 diff --git a/docs/01-quickstart/_category_.json b/docs/01-quickstart/_category_.json new file mode 100644 index 0000000000..d1abad8b3c --- /dev/null +++ b/docs/01-quickstart/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "快速开始", + "position": 1 +} \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/01quickstart.md b/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/01quickstart.md index 1409fa2650..a951b0176f 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/01quickstart.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/01quickstart.md @@ -1,4 +1,4 @@ -# Quickstart +# Local Deployment of RocketMQ This section will introduce the method of quickly building and deploying a single-Master RocketMQ cluster to complete simple message sending and receiving. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/03quickstartWithDockercompose.md b/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/03quickstartWithDockercompose.md index 96a1cde872..8cab833bf6 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/03quickstartWithDockercompose.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/03quickstartWithDockercompose.md @@ -1,4 +1,4 @@ -# Docker-compose Deployment of RocketMQ +# Docker Compose Deployment of RocketMQ This section introduces how to quickly deploy a single-node, single-replica RocketMQ service using Docker-compose and complete simple message sending and receiving. diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/01quickstart.md b/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/01quickstart.md index 30fe8f7e8a..4c510c70d9 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/01quickstart.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/01quickstart.md @@ -1,4 +1,4 @@ -# Quick Start +# Local Deployment of RocketMQ This section will describe steps to quickly deploy a RocketMQ cluster with a single node; Commands to send and receive messages to/from it are also included as proof of work. @@ -164,13 +164,13 @@ We can also try to use the client sdk to send and receive messages, you can see import org.apache.rocketmq.client.apis.consumer.PushConsumer; import org.slf4j.Logger; import org.slf4j.LoggerFactory; - + public class PushConsumerExample { private static final Logger logger = LoggerFactory.getLogger(PushConsumerExample.class); - + private PushConsumerExample() { } - + public static void main(String[] args) throws ClientException, IOException, InterruptedException { final ClientServiceProvider provider = ClientServiceProvider.loadService(); String endpoints = "localhost:8081"; diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/03quickstartWithDockercompose.md b/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/03quickstartWithDockercompose.md index 2eb74c72a5..e98b4c2643 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/03quickstartWithDockercompose.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/03quickstartWithDockercompose.md @@ -1,4 +1,4 @@ -# Docker-compose Deployment of RocketMQ +# Docker Compose Deployment of RocketMQ This section introduces how to quickly deploy a single-node, single-replica RocketMQ service using Docker-compose and complete simple message sending and receiving. @@ -110,10 +110,10 @@ docker-compose -p rockermq_project up -d import org.apache.rocketmq.client.apis.producer.SendReceipt; import org.slf4j.Logger; import org.slf4j.LoggerFactory; - + public class ProducerExample { private static final Logger logger = LoggerFactory.getLogger(ProducerExample.class); - + public static void main(String[] args) throws ClientException { // Endpoint address, set to the Proxy address and port list, usually xxx:8080;xxx:8081 String endpoint = "localhost:8081"; @@ -149,7 +149,7 @@ docker-compose -p rockermq_project up -d } ``` 3. In the created Java project, create and run a program to subscribe to normal messages. Apache RocketMQ supports both [SimpleConsumer](https://rocketmq.apache.org/zh/docs/featureBehavior/06consumertype) and [PushConsumer](https://rocketmq.apache.org/zh/docs/featureBehavior/06consumertype) types of consumers. You can choose either method to subscribe to messages. - + ```java import java.io.IOException; import java.util.Collections; diff --git a/versioned_docs/version-5.0/02-quickStart/01quickstart.md b/versioned_docs/version-5.0/02-quickStart/01quickstart.md index d182206373..d31143153a 100644 --- a/versioned_docs/version-5.0/02-quickStart/01quickstart.md +++ b/versioned_docs/version-5.0/02-quickStart/01quickstart.md @@ -1,4 +1,4 @@ -# 快速开始 +# 本地部署 RocketMQ 这一节介绍如何快速部署一个单节点单副本 RocketMQ 服务，并完成简单的消息收发。 @@ -120,10 +120,10 @@ $ sh bin/tools.sh org.apache.rocketmq.example.quickstart.Consumer import org.apache.rocketmq.client.apis.producer.SendReceipt; import org.slf4j.Logger; import org.slf4j.LoggerFactory; - + public class ProducerExample { private static final Logger logger = LoggerFactory.getLogger(ProducerExample.class); - + public static void main(String[] args) throws ClientException { // 接入点地址，需要设置成Proxy的地址和端口列表，一般是xxx:8081;xxx:8081。 String endpoint = "localhost:8081"; @@ -174,13 +174,13 @@ $ sh bin/tools.sh org.apache.rocketmq.example.quickstart.Consumer import org.apache.rocketmq.client.apis.consumer.PushConsumer; import org.slf4j.Logger; import org.slf4j.LoggerFactory; - + public class PushConsumerExample { private static final Logger logger = LoggerFactory.getLogger(PushConsumerExample.class); - + private PushConsumerExample() { } - + public static void main(String[] args) throws ClientException, IOException, InterruptedException { final ClientServiceProvider provider = ClientServiceProvider.loadService(); // 接入点地址，需要设置成Proxy的地址和端口列表，一般是xxx:8081;xxx:8081。 diff --git a/versioned_docs/version-5.0/02-quickStart/03quickstartWithDockercompose.md b/versioned_docs/version-5.0/02-quickStart/03quickstartWithDockercompose.md index bd815a4e52..75b5be5a0a 100644 --- a/versioned_docs/version-5.0/02-quickStart/03quickstartWithDockercompose.md +++ b/versioned_docs/version-5.0/02-quickStart/03quickstartWithDockercompose.md @@ -1,4 +1,4 @@ -# Docker-compose 部署 RocketMQ +# Docker Compose 部署 RocketMQ 这一节介绍如何使用Docker-compose快速部署一个单节点单副本 RocketMQ 服务，并完成简单的消息收发。 @@ -108,10 +108,10 @@ docker-compose -p rockermq_project up -d import org.apache.rocketmq.client.apis.producer.SendReceipt; import org.slf4j.Logger; import org.slf4j.LoggerFactory; - + public class ProducerExample { private static final Logger logger = LoggerFactory.getLogger(ProducerExample.class); - + public static void main(String[] args) throws ClientException { // 接入点地址，需要设置成Proxy的地址和端口列表，一般是xxx:8080;xxx:8081 String endpoint = "localhost:8081"; From 1a6a8b7065b171b31426f76869b628491218f113 Mon Sep 17 00:00:00 2001 From: kaxiya1021 Date: Mon, 3 Jun 2024 11:22:59 +0800 Subject: [PATCH 2/2] revised the title --- .../current/01-quickstart/01quickstart.md | 2 +- .../current/01-quickstart/02quickstartWithDocker.md | 2 +- .../current/01-quickstart/03quickstartWithDockercompose.md | 2 +- .../version-5.0/02-quickStart/01quickstart.md | 2 +- .../version-5.0/02-quickStart/02quickstartwithDocker.md | 2 +- .../version-5.0/02-quickStart/03quickstartWithDockercompose.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/01quickstart.md b/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/01quickstart.md index a951b0176f..5fe51f1950 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/01quickstart.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/01quickstart.md @@ -1,4 +1,4 @@ -# Local Deployment of RocketMQ +# Run RocketMQ locally This section will introduce the method of quickly building and deploying a single-Master RocketMQ cluster to complete simple message sending and receiving. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/02quickstartWithDocker.md b/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/02quickstartWithDocker.md index 3848e81ff9..3707fe117e 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/02quickstartWithDocker.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/02quickstartWithDocker.md @@ -1,4 +1,4 @@ -# Docker Deployment of RocketMQ +# Run RocketMQ in Docker This section introduces how to quickly deploy a single-node, single-replica RocketMQ service using Docker and complete simple message sending and receiving. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/03quickstartWithDockercompose.md b/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/03quickstartWithDockercompose.md index 8cab833bf6..6ec0c9cdfa 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/03quickstartWithDockercompose.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/01-quickstart/03quickstartWithDockercompose.md @@ -1,4 +1,4 @@ -# Docker Compose Deployment of RocketMQ +# Run RocketMQ with Docker Compose This section introduces how to quickly deploy a single-node, single-replica RocketMQ service using Docker-compose and complete simple message sending and receiving. diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/01quickstart.md b/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/01quickstart.md index 4c510c70d9..3d5dfc2702 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/01quickstart.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/01quickstart.md @@ -1,4 +1,4 @@ -# Local Deployment of RocketMQ +# Run RocketMQ locally This section will describe steps to quickly deploy a RocketMQ cluster with a single node; Commands to send and receive messages to/from it are also included as proof of work. diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/02quickstartwithDocker.md b/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/02quickstartwithDocker.md index 40b7fca624..5c4ad572f9 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/02quickstartwithDocker.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/02quickstartwithDocker.md @@ -1,4 +1,4 @@ -# Docker Deployment of RocketMQ +# Run RocketMQ in Docker This section introduces how to quickly deploy a single-node, single-replica RocketMQ service using Docker and complete simple message sending and receiving. diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/03quickstartWithDockercompose.md b/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/03quickstartWithDockercompose.md index e98b4c2643..2b83591b33 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/03quickstartWithDockercompose.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-5.0/02-quickStart/03quickstartWithDockercompose.md @@ -1,4 +1,4 @@ -# Docker Compose Deployment of RocketMQ +# Run RocketMQ with Docker Compose This section introduces how to quickly deploy a single-node, single-replica RocketMQ service using Docker-compose and complete simple message sending and receiving.