Merge pull request #15 from datastax/using-s4r-guide

Merge Starlight for RabbitMQ guide

Author: mendonk

modules/use-cases-architectures/pages/starlight/rabbitmq/index.adoc

@@ -4,19 +4,22 @@
 :title: Getting started with the Starlight for RabbitMQ extension
 :navtitle: Starlight for RabbitMQ
 
-Starlight for RabbitMQ acts as a proxy between your https://www.rabbitmq.com/[RabbitMQ^]{external-link-icon} application and https://pulsar.apache.org/[Apache Pulsar™^]{external-link-icon} cluster. It implements the AMQP 0.9.1 protocol used by RabbitMQ clients and translates AMQP frames and concepts to Pulsar ones.
+Starlight for RabbitMQ acts as a proxy between your https://www.rabbitmq.com/[RabbitMQ^]{external-link-icon} application and https://pulsar.apache.org/[Apache Pulsar™^]{external-link-icon} cluster.
+It implements the AMQP 0.9.1 protocol used by RabbitMQ clients and translates AMQP frames and concepts to Pulsar concepts.
 
 If source code is your thing, visit the https://github.com/datastax/starlight-for-rabbitmq[project's repo on GitHub^]{external-link-icon}.
 
 == Architecture reference
 
-If you would like to get deep into how Starlight for RabbitMQ works, xref:starlight-for-rabbitmq:ROOT:index.adoc[read the docs].
+If you want to dive deep into how Starlight for RabbitMQ works, xref:starlight-for-rabbitmq:ROOT:index.adoc[read the documentation].
 
 image:s4r-architecture.png[Starlight for RabbitMQ Architecture]
 
 == Establishing the RabbitMQ protocol handler
 
-Before you can use a RabbitMQ client to interact with your Pulsar cluster, you need the Starlight for RabbitMQ protocol handler installed in the cluster. Installation looks a bit different depending on where your Pulsar cluster is running. Choose the option that best fits your needs.
+Before you can use a RabbitMQ client to interact with your Pulsar cluster, you need the Starlight for RabbitMQ protocol handler installed in the cluster.
+Installation looks a bit different depending on where your Pulsar cluster is running.
+Choose the option that best fits your needs.
 
 [tabs]
 ====
@@ -52,21 +55,25 @@ The Starlight for RabbitMQ extension is included in the `luna-streaming-all` ima
 Self Managed::
 +
 --
-Already got your own Pulsar Cluster? Or maybe your using a standalone cluster? Starlight for RabbitMQ can easily be a part of that cluster! Follow the "xref:starlight-for-rabbitmq:installation:getting-started.adoc[]" guide.
+Already have your own Pulsar Cluster? Or maybe you're using a standalone cluster? Starlight for RabbitMQ can easily be a part of that cluster! Follow the "xref:starlight-for-rabbitmq:installation:getting-started.adoc[]" guide.
 --
 ====
 
 == Messaging with Starlight for RabbitMQ
 
-Starlight for RabbitMQ supports quite a few different use cases. With a Pulsar cluster between publishers and consumers you can interchange the type of publisher and consumer to fit your needs. *The below examples are using an Astra Streaming tenant as the AMQP listener.* If you are using Luna or self-managed, switch the listener URL for your own.
+Starlight for RabbitMQ supports quite a few different use cases.
+With a Pulsar cluster between publishers and consumers you can interchange the type of publisher and consumer to fit your needs.
+
+*The below examples are using an Astra Streaming tenant as the AMQP listener.* If you are using Luna Streaming or a self-managed tenant, switch the listener URL for your own.
 
 === Retrieve RabbitMQ connection properties in Astra Streaming
 
-While on the "Connect" tab in the Astra Streaming portal, the "RabbitMQ" area will provide important connection information. You will need that to create a working RabbitMQ client or using the CLI.
+In the Astra Streaming portal "Connect" tab, the "RabbitMQ" area provides important connection information.
+You will need this connection information to create a working RabbitMQ client or use the CLI.
 
 image:rabbitmq-client-settings.png[Astra Streaming RabbitMQ settings]
 
-TIP: While reviewing the RabbitMQ connection settings in the Astra portal, if you click the clipboard icon you will get those values as well as a working token to paste in code.
+TIP: Click the clipboard icon to copy the RabbitMQ connection values, as well as a working token to paste in code.
 
 === Produce and consume a message
 
@@ -75,18 +82,19 @@ TIP: While reviewing the RabbitMQ connection settings in the Astra portal, if yo
 RabbitMQ Client (Java)::
 +
 --
-This example uses maven as the project structure. If you prefer gradle or another, this code should still be a good fit.
+This example uses Maven for the project structure.
+If you prefer Gradle or another tool, this code should still be a good fit.
 
-TIP: Visit our https://github.com/datastax/astra-streaming-examples[examples repo^]{external-link-icon} to see the complete source of this example.
+TIP: Visit our https://github.com/datastax/astra-streaming-examples[examples repo^]{external-link-icon} to see the complete source for this example.
 
-. Create a new maven project.
+. Create a new Maven project.
 +
 [source,shell]
 ----
 include::{astra-streaming-examples-repo}/java/starlight-for-rabbitmq/rabbitmq-client/create-project.sh[]
 ----
 
-. Open the new project in your favorite IDE or text editor and add the Kafka client dependency to "pom.xml".
+. Open the new project in your favorite IDE or text editor and add the RabbitMQ client dependency to "pom.xml".
 +
 [source,xml]
 ----
@@ -97,7 +105,9 @@ include::{astra-streaming-examples-repo}/java/starlight-for-rabbitmq/rabbitmq-cl
 </dependency>
 ----
 
-. Open the file "src/main/java/org/example/App.java" and replace the entire contents with the below code. Notice there are class variables that need replacing. Apply the values previously retrieved in Astra Streaming.
+. Open the file "src/main/java/org/example/App.java" and replace the entire contents with the below code.
+Notice there are class variables that need replacing.
+Apply the values previously retrieved in Astra Streaming.
 +
 [source,java]
 ----
@@ -106,43 +116,52 @@ include::{astra-streaming-examples-repo}/java/starlight-for-rabbitmq/rabbitmq-cl
 +
 NOTE: Don't worry if your editor shows errors, this isn't a complete program... yet.
 
-. Bring in the following code to create a valid connection, channel, and queue that will be used by both the producer and consumer.
+. Add the following code to create a valid connection, a channel, and a queue that will be used by both the producer and consumer.
 +
 [source,java]
 ----
 include::{astra-streaming-examples-repo}/java/starlight-for-rabbitmq/rabbitmq-client/StarlightForRabbitMqClient/src/main/java/org/example/App.java[tag=create-queue]
 ----
 
-. Now paste the producer code into the file. This is a very simple flow that sends a single message and awaits acknowledgment.
+. Add the producer code to the file.
+This is a very simple flow that sends a single message and awaits acknowledgment.
 +
 [source,java]
 ----
 include::{astra-streaming-examples-repo}/java/starlight-for-rabbitmq/rabbitmq-client/StarlightForRabbitMqClient/src/main/java/org/example/App.java[tag=build-producer]
 ----
 
-. Paste the consumer code into the file. This creates a basic consumer with callback on message receipt. Because the consumer isn't a blocking thread, we'll sleep for a few seconds and let things process.
+. Add the consumer code to the file.
+This creates a basic consumer with callback on message receipt.
+Because the consumer isn't a blocking thread, we'll sleep for a few seconds and let things process.
 +
 [source,java]
 ----
 include::{astra-streaming-examples-repo}/java/starlight-for-rabbitmq/rabbitmq-client/StarlightForRabbitMqClient/src/main/java/org/example/App.java[tag=build-consumer]
 ----
 
-. Now you should have a complete program. Let's see it in action! Build and run the jar with the following terminal commands.
+. You now have a complete program, so let's see it in action!
+Build and run the jar with the following terminal commands.
 +
 [source,shell]
 ----
 mvn clean package assembly:single
 java -jar target/StarlightForRabbitMqClient-1.0-SNAPSHOT-jar-with-dependencies.jar
 ----
 
-. If all goes as it should your output will be similar to this:
+. If all goes as it should, your output will be similar to this:
 +
 [source,shell]
 ----
 Sent 'Hello World!'
 Received 'Hello World!'
 ----
 
-Congrats! You have just used the RabbitMQ client to send and receive messages in Pulsar.
+Congrats! You used the RabbitMQ client to send and receive messages in Pulsar.
 --
-====
+====
+
+== What's next?
+
+* xref:starlight-for-rabbitmq:ROOT:index.adoc[Starlight for RabbitMQ documentation]
+* xref:luna-streaming:components:starlight-for-rabbitmq.adoc[]