Anonymitaet commented on code in PR #664: URL: https://github.com/apache/pulsar-site/pull/664#discussion_r1285645532
########## docs/getting-started-docker-compose.md: ########## @@ -2,6 +2,7 @@ id: getting-started-docker-compose title: Run a Pulsar cluster locally with Docker Compose sidebar_label: "Run Pulsar locally with Docker Compose" +description: To get up and run a Pulsar cluster locally with Docker Compose, let’s follow this tutorial! Just one command is all you need. Review Comment: ```suggestion description: Get started with Apache Pulsar on your local machine using Docker Compose. ``` Just need to keep the necessary info. ########## docs/getting-started-helm.md: ########## @@ -2,15 +2,16 @@ id: getting-started-helm title: Run a standalone Pulsar cluster in Kubernetes sidebar_label: "Run Pulsar in Kubernetes" +description: Want to run Pulsar in Kubernetes? This section guides you through every step of installing and running Apache Pulsar with Helm on Kubernetes quickly. Review Comment: ```suggestion description: Get started with Apache Pulsar on your local machine using Kubernetes. ``` ########## docs/getting-started-docker.md: ########## @@ -2,8 +2,14 @@ id: getting-started-docker title: Run a standalone Pulsar cluster in Docker sidebar_label: "Run Pulsar in Docker" +description: One command to run Pulsar in Docker. This tutorial guides you on how to start Pulsar in Docker and successfully produce and consume your first message. Review Comment: ```suggestion description: Get started with Apache Pulsar on your local machine using Docker. ``` ########## docs/getting-started-helm.md: ########## @@ -2,15 +2,16 @@ id: getting-started-helm title: Run a standalone Pulsar cluster in Kubernetes sidebar_label: "Run Pulsar in Kubernetes" +description: Want to run Pulsar in Kubernetes? This section guides you through every step of installing and running Apache Pulsar with Helm on Kubernetes quickly. --- This section guides you through every step of installing and running Apache Pulsar with Helm on Kubernetes quickly, including the following sections: -- Install the Apache Pulsar on Kubernetes using Helm -- Start and stop Apache Pulsar -- Create topics using `pulsar-admin` -- Produce and consume messages using Pulsar clients -- Monitor Apache Pulsar status with Prometheus and Grafana +1. Install the Apache Pulsar on Kubernetes using Helm +2. Start and stop Apache Pulsar +3. Create topics using `pulsar-admin` +4. Produce and consume messages using Pulsar clients +5. Monitor Apache Pulsar status with Prometheus and Grafana Review Comment: ```suggestion ``` Remove this part since the ToC is apparent on the right panel. ########## docs/getting-started-docker.md: ########## @@ -2,8 +2,14 @@ id: getting-started-docker Review Comment: Why not add "Step x" for this file? ########## docs/getting-started-standalone.md: ########## @@ -2,10 +2,21 @@ id: getting-started-standalone title: Run a standalone Pulsar cluster locally sidebar_label: "Run Pulsar locally" +description: Want to run Pulsar quickly? This section guides you through every step of running Pulsar in standalone mode on your machine. Come and give it a try! Review Comment: ```suggestion description: Get started with Apache Pulsar on your local machine. ``` ########## docs/about.md: ########## @@ -3,6 +3,7 @@ slug: / id: about title: Welcome to the Apache Pulsar documentation portal sidebar_label: "About" +description: Welcome to the Apache Pulsar documentation portal, and welcome to join the active and knowledgeable Pulsar community. Let’s begin your Pulsar journey here. Review Comment: ```suggestion description: Explore the Apache Pulsar documentation and join the knowledgeable Pulsar community. ``` Remove redundancy Keep it more compact while still conveying the essential info. ########## docs/getting-started-standalone.md: ########## @@ -2,10 +2,21 @@ id: getting-started-standalone title: Run a standalone Pulsar cluster locally sidebar_label: "Run Pulsar locally" +description: Want to run Pulsar quickly? This section guides you through every step of running Pulsar in standalone mode on your machine. Come and give it a try! --- For local development and testing, you can run Pulsar in standalone mode on your machine. The standalone mode runs all components inside a single Java Virtual Machine (JVM) process. +To run a standalone Pulsar cluster locally, include the following steps: + +1. Download Pulsar distribution +2. Start a Pulsar standalone cluster +3. Create a topic +4. Write messages to the topic +5. Read messages from the topic +6. Write some more messages +7. Stop the Pulsar cluster Review Comment: ```suggestion ``` ########## docs/getting-started-docker-compose.md: ########## @@ -2,6 +2,7 @@ id: getting-started-docker-compose Review Comment: This is not a complete tutorial (it lacks some steps). Feel free to test, run, and add missing steps. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
