Skip to content

Commit 7a56cc6

Browse files
authored
DOC-3707 more attributes (#19)
* more attributes * fix xref
1 parent 32bb57c commit 7a56cc6

9 files changed

Lines changed: 40 additions & 32 deletions

antora.yml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,18 @@ nav:
88

99
asciidoc:
1010
attributes:
11-
jms_repo: 'https://github.com/datastax/pulsar-jms/'
11+
jms_repo: 'https://github.com/datastax/pulsar-jms'
12+
astra-streaming-examples-repo: 'https://github.com/datastax/astra-streaming-examples'
13+
astra: 'Astra'
1214
pulsar-reg: 'Apache Pulsar(TM)'
1315
pulsar: 'Apache Pulsar'
1416
pulsar-short: 'Pulsar'
1517
product: 'Starlight for JMS'
1618
luna-streaming: 'Luna Streaming'
17-
astra-streaming: 'Astra Streaming'
19+
astra-stream: 'Astra Streaming'
20+
activemq-reg: 'Apache ActiveMQ(R)'
21+
activemq-short: 'ActiveMQ'
22+
tomee-reg: 'Apache TomEE(TM)'
23+
maven-reg: 'Apache Maven(TM)'
24+
maven-short: 'Maven'
25+
kafka-reg: 'Apache Kafka(R)'

modules/ROOT/pages/pulsar-jms-faq.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ IMPORTANT: Globally unique subscription names aren't supported so the correspond
4646

4747
We've provided the following integration examples:
4848

49-
* {jms_repo}blob/master/examples/spring[Spring Boot(R)]
50-
* {jms_repo}blob/master/examples/payara-micro[Payara Micro(R)]
51-
* {jms_repo}blob/master/resource-adapter-tests[Apache TomEE(R)]
49+
* {jms_repo}/blob/master/examples/spring[Spring Boot(R)]
50+
* {jms_repo}/blob/master/examples/payara-micro[Payara Micro(R)]
51+
* {jms_repo}/blob/master/resource-adapter-tests[{tomee-reg}]
5252

5353
== How can I build {product} from source?
5454

@@ -61,7 +61,7 @@ If you'd like to fork or contribute to {product}:
6161
git clone git@github.com:datastax/pulsar-jms.git
6262
----
6363

64-
. Build using Maven:
64+
. Build using {maven-short}:
6565
+
6666
[source,bash]
6767
----

modules/ROOT/partials/jms-quickstart-create-project.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
. Create a new Maven project:
1+
. Create a new {maven-short} project:
22
+
33
[source,bash]
44
----
@@ -19,7 +19,7 @@ cd StarlightForJMSClient
1919
. Open the project in your IDE, and then add the {product} dependency to the `pom.xml` file.
2020
+
2121
This quickstart uses the `pulsar-jms-all` package, which is a fat JAR file that includes all dependencies.
22-
{company} recommends using the {jms_repo}releases[latest stable release].
22+
{company} recommends using the {jms_repo}/releases[latest stable release].
2323
+
2424
.pom.xml
2525
[source,xml]
@@ -46,7 +46,7 @@ This quickstart uses the `pulsar-jms-all` package, which is a fat JAR file that
4646
4747
. For this quickstart, include the following plugin configuration in the `build` section:
4848
+
49-
* **`<artifactId>maven-assembly-plugin</artifactId>`**: The Maven Assembly Plugin that is used to compile a JAR file with all dependencies included.
49+
* **`<artifactId>maven-assembly-plugin</artifactId>`**: The {maven-short} Assembly Plugin that is used to compile a JAR file with all dependencies included.
5050
* **`<descriptorRef>jar-with-dependencies</descriptorRef>`**: An additional descriptor appended to the compiled JAR file name.
5151
* **`<mainClass>org.example.App</mainClass>`**: The default package and class so you can run the compiled JAR file without any additional specifications.
5252
+
@@ -72,7 +72,7 @@ This quickstart uses the `pulsar-jms-all` package, which is a fat JAR file that
7272
</build>
7373
----
7474
75-
. In your Maven project, create an `example` subdirectory at `/src/main/java/org`:
75+
. In your {maven-short} project, create an `example` subdirectory at `/src/main/java/org`:
7676
+
7777
[source,bash]
7878
----

modules/examples/pages/pulsar-jms-implementation.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@ Both of those features can be emulated on the client side with the following lim
133133
* For shared subscriptions, especially on queues, the message is discarded on the client and is "negative acknowledged" in order to let other consumers receive the message.
134134
* For `QueueBrowsers`, the message is discarded on the client side.
135135
136-
Currently, the implementation of message selectors is based on Apache ActiveMQ(R) Java client classes, which are imported as a dependency in {product}.
137-
Apache ActiveMQ is licensed under Apache 2.0.
136+
Currently, the implementation of message selectors is based on {activemq-reg} Java client classes, which are imported as a dependency in {product}.
137+
{activemq-short} is licensed under Apache 2.0.
138138
139139
[#subscription-creation]
140140
== Subscription creation

modules/examples/pages/pulsar-jms-server-side-filters.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ Batch messages with compression consume a non-negligible amount of CPU, heap, an
3737
This doesn't apply to compressed single messages.
3838

3939
* *Unsupported message types*: {product} doesn't support encrypted batch messages because the filter can't decode the payload of the entry.
40-
For the same reason, {product} doesn't support custom formats like native Kafka messages.
40+
For the same reason, {product} doesn't support custom formats like native {kafka-reg} messages.
4141

4242
== Enable server-side filtering
4343

44-
The `.nar` file filter is packaged with {luna-streaming} *2.10.03+* and also available in the GitHub repo https://github.com/datastax/pulsar-jms/releases[here].
44+
The `.nar` file filter is packaged with {luna-streaming} *2.10.03+* and also available in the GitHub repo {jms_repo}/releases[here].
4545

4646
. Install {product} with the fat JAR that includes all dependencies.
4747
Put the `.nar` file in `/pulsar/filters`.

modules/jms-migration/pages/pulsar-jms-install.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ However, certain features and compatibility issues that require a specific versi
3030

3131
[tabs]
3232
======
33-
{astra-streaming}::
33+
{astra-stream}::
3434
+
3535
--
36-
The {pulsar-short} version is managed by Astra.
37-
Typically, the latest {product} version is compatible with the {pulsar-short} version used by {astra-streaming}.
36+
The {pulsar-short} version is managed by {astra}.
37+
Typically, the latest {product} version is compatible with the {pulsar-short} version used by {astra-stream}.
3838
--
3939
4040
{luna-streaming}::

modules/jms-migration/pages/pulsar-jms-quickstart-sa.adoc

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ This quickstart explains how to prepare an {pulsar-reg} streaming instance, and
1111

1212
[tabs]
1313
======
14-
{astra-streaming}::
14+
{astra-stream}::
1515
+
1616
--
17-
To use {product} with an {astra-streaming} {pulsar-short} cluster, you need the following:
17+
To use {product} with an {astra-stream} {pulsar-short} cluster, you need the following:
1818
19-
* An active {astra-streaming} {pulsar-short} cluster with a tenant, namespace, and topic that you want to use with {product}.
20-
If you don't have these structures configured in {astra-streaming}, see the xref:astra-streaming:getting-started:index.adoc[].
19+
* An active {astra-stream} {pulsar-short} cluster with a tenant, namespace, and topic that you want to use with {product}.
20+
If you don't have these structures configured in {astra-stream}, see the xref:astra-streaming:getting-started:index.adoc[].
2121
2222
* The connection details for your tenant, which are found on the tenant's **Connect** tab under **Tenant Details**:
2323
+
@@ -91,23 +91,23 @@ Starting the Docker container produces many status messages and output similar t
9191

9292
== Produce and consume messages with {product}
9393

94-
This example shows how to produce and consume messages with Starlight for JMS using a JMS client, https://openjdk.java.net/install/[Java OpenJDK] 8 or 11, and https://maven.apache.org/install.html[Apache Maven].
94+
This example shows how to produce and consume messages with Starlight for JMS using a JMS client, https://openjdk.java.net/install/[Java OpenJDK] 8 or 11, and https://maven.apache.org/install.html[{maven-reg}].
9595
You can also use Gradle with some modifications.
9696

97-
For the complete source code for this example, see the https://github.com/datastax/astra-streaming-examples/tree/master/java/starlight-for-jms[{company} streaming examples repository].
98-
This example was written for {astra-streaming} but it can be used with {luna-streaming} or self-managed {pulsar-short} clusters by setting the connection properties appropriately.
97+
For the complete source code for this example, see the {astra-streaming-examples-repo}/tree/master/java/starlight-for-jms[{company} streaming examples repository].
98+
This example was written for {astra-stream} but it can be used with {luna-streaming} or self-managed {pulsar-short} clusters by setting the connection properties appropriately.
9999

100100
[tabs]
101101
======
102-
{astra-streaming}::
102+
{astra-stream}::
103103
+
104104
--
105105
include::ROOT:partial$jms-quickstart-create-project.adoc[]
106106
107107
. In the `example` directory, create an `App.java` file.
108108
In the next steps, you will add code to this file to create a complete program that produces and consumes messages.
109109
110-
. Paste the following code in the file, and then replace the placeholders with the <<prepare-your-pulsar-cluster,tenant connection details, namespace, and topic from {astra-streaming}>>.
110+
. Paste the following code in the file, and then replace the placeholders with the <<prepare-your-pulsar-cluster,tenant connection details, namespace, and topic from {astra-stream}>>.
111111
Your editor will report errors because this isn't a complete program yet.
112112
+
113113
./src/main/java/org/example/App.java
@@ -195,9 +195,9 @@ Sending: Hello there!
195195
Received: Hello there!
196196
----
197197
198-
. In {astra-streaming}, go to your tenant's **Namespaces and Topics** tab to inspect the activity in the namespace that you used in the Java program.
198+
. In {astra-stream}, go to your tenant's **Namespaces and Topics** tab to inspect the activity in the namespace that you used in the Java program.
199199
+
200-
If you everything was configured correctly, then the namespace's metrics should reflect that at least one message was published and consumed by your {astra-streaming} {pulsar-short} topic.
200+
If you everything was configured correctly, then the namespace's metrics should reflect that at least one message was published and consumed by your {astra-stream} {pulsar-short} topic.
201201
--
202202
203203
{luna-streaming}::
@@ -279,7 +279,7 @@ For more information about consumers, see xref:reference:pulsar-jms-mappings.ado
279279
mvn clean install
280280
----
281281
+
282-
The first time you compile the JAR file, Maven downloads all required dependencies.
282+
The first time you compile the JAR file, {maven-short} downloads all required dependencies.
283283
Subsequent runs are faster.
284284
285285
. Run the sample application:
@@ -408,7 +408,7 @@ For more information about consumers, see xref:reference:pulsar-jms-mappings.ado
408408
mvn clean install
409409
----
410410
+
411-
The first time you compile the JAR file, Maven downloads all required dependencies.
411+
The first time you compile the JAR file, {maven-short} downloads all required dependencies.
412412
Subsequent runs are faster.
413413
414414
. Run the sample application:

modules/reference/pages/pulsar-jms-mappings.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@ The special `JMSXGroupID` property is defined in the JMS specs as a way to group
459459

460460
{product} maps that property to the message key in {pulsar-short}, ensuring that `JMSXGroupID` is used as the routing key.
461461

462-
This is the same behavior implemented in https://activemq.apache.org/message-groups[Apache ActiveMQ].
462+
This is the same behavior implemented in https://activemq.apache.org/message-groups[{activemq-reg}].
463463

464464
== See also
465465

modules/reference/pages/pulsar-jms-reference.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Other entries are ignored.
8686
| String
8787
| If not specified, for {pulsar-short} standalone instances running on localhost, defaults to the same value as `webServiceUrl`, \`http://localhost:8080`. Can also be specified as \`pulsar://localhost:6650` for {pulsar-short} standalone instances on localhost.
8888
a| The URL to connect to the {pulsar-short} broker or proxy
89-
The `brokerServiceUrl` must be specified for {astra-streaming}. Must be customized as required for {pulsar-short} standalone instances that aren't running on localhost.
89+
The `brokerServiceUrl` must be specified for {astra-stream}. Must be customized as required for {pulsar-short} standalone instances that aren't running on localhost.
9090

9191
| `consumerConfig`
9292
| no

0 commit comments

Comments
 (0)