Skip to content

Commit 0a74edb

Browse files
ddierufddieruf
committed
Fix page links, clean out attributes
1 parent c72ea86 commit 0a74edb

12 files changed

+73
-168
lines changed

‎antora.yml

Lines changed: 1 addition & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -5,104 +5,9 @@ start_page: starlight-for-jms::index.adoc
55

66
asciidoc:
77
attributes:
8-
source-highlighter: highlightjs
9-
page-pagination: ''
10-
sectanchors: ''
11-
sectlinks: ''
12-
id-prefix: ''
13-
id-separator: '-'
14-
158
starlight_jms: 'Starlight for JMS'
16-
jms_repo: 'https://github.com/datastax/pulsar-jms/'
17-
jms_repo_frag: 'datastax/'
189
product_version: '3.x'
19-
20-
company: 'DataStax'
21-
product: 'Product'
22-
product_name: 'Product'
23-
evalproduct: 'DB Classic'
24-
database: 'Astra DB'
25-
astra_db: 'Astra DB'
26-
astra_generic: 'Astra'
27-
classic: 'classic'
28-
classic_cap: 'Classic'
29-
serverless: 'serverless'
30-
serverless_cap: 'Serverless'
31-
astra_stream: 'Astra Streaming'
32-
advanced: 'no'
33-
34-
stargate-docker-tag: v1.0.41
35-
stargate-docker-tag-3x: v1.0.41
36-
stargate-docker-tag-40: v1.0.41
37-
stargate-docker-tag-68: v1.0.40
38-
cass-tag-3x: '3.11'
39-
cass-alt-tag-3x: '3_11'
40-
cass-tag-40: '4.0'
41-
cass-alt-tag-40: '4_0'
42-
dse-server-tag-68: '6.8.9'
43-
dse-tag-68: '6.8'
44-
dse-alt-tag-68: '68'
45-
46-
ASTRA_CLUSTER_ID: '8319febd-e7cf-4595-81e3-34f45d332d2a'
47-
ASTRA_REGION: 'us-east1'
48-
ASTRA_USERNAME: 'polandll'
49-
ASTRA_PASSWORD: '12345abcd'
50-
51-
auth_token: '$ASTRA_DB_APPLICATION_TOKEN'
52-
base_auth_url: 'http://$ASTRA_CLUSTER_ID-$ASTRA_REGION.apps.astra.datastax.com:8081'
53-
base_auth_api_path: '/v1/auth'
54-
cass_user: 'cassandra' # switch to auth_username
55-
cass_passwd: 'cassandra' # switch to auth_password
56-
57-
base_rest_url: 'https://$ASTRA_CLUSTER_ID-$ASTRA_REGION.apps.astra.datastax.com'
58-
base_doc_url: 'https://$ASTRA_CLUSTER_ID-$ASTRA_REGION.apps.astra.datastax.com'
59-
base_graphql_url: 'https://$ASTRA_CLUSTER_ID-$ASTRA_REGION.apps.astra.datastax.com:8080'
60-
61-
base_rest_schema: '/api/rest/v2/schemas/keyspaces'
62-
base_doc_schema: '/api/rest/v2/schemas/namespaces'
63-
base_gql_schema: '/api/graphql-schema'
64-
65-
base_gql_admin: '/api/graphql-admin'
66-
67-
base_rest_api: '/api/rest/v2/keyspaces'
68-
base_doc_api: '/api/rest/v2/namespaces'
69-
base_gql_api: '/api/graphql'
70-
71-
rkeyspace: 'users_keyspace'
72-
rkeyspace-dcs: 'users_keyspace-dcs'
73-
rpartitionkey: 'firstname'
74-
rclusteringkey: 'lastname'
75-
rtable: 'users'
76-
user1fn: 'Mookie'
77-
user1ln: 'Betts'
78-
user2fn: 'Janesha'
79-
user2ln: 'Doesha'
80-
81-
namespace: 'myworld'
82-
collection: 'fitness'
83-
user1: 'Janet'
84-
user2: 'Joey'
85-
user2a: 'Joseph'
86-
user3: 'Martha'
87-
88-
gkeyspace: 'library'
89-
gtable1: 'book'
90-
gtable2: 'reader'
91-
92-
support_url: 'https://houston.datastax.com/hc/requests/new'
93-
astra_docs_base_url: 'https://docs.datastax.com/en/astra/docs'
94-
95-
# The "glossary-url" attribute below is used by writers when linking to a
96-
# term in the glossary. Referencing this attribute in an adoc file will
97-
# automatically insert the root URL where the glossary pages are located.
98-
# For example, the following syntax will generate a link to the glossary
99-
# page for "agent": {glossary-url}agent[agent,window="_blank"]
100-
glossary-url: 'https://docs.datastax.com/en/glossary/docs/index.html#'
101-
102-
# Bsys requires the URLs of the content source repos of the current docset
103-
# to be listed as attributes in the site-publish playbook in the form
104-
# "<repo-name>: 'ssh://github.com/<org-name>/<repo-name>.git'".
105-
starlight-docs: 'ssh://github.com/datastax/starlight-docs.git'
10+
jms_repo: 'https://github.com/datastax/pulsar-jms/'
10611

10712
nav:
10813
- modules/ROOT/nav.adoc

‎modules/ROOT/nav.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
* Getting Started
22
** xref:index.adoc[About {starlight_jms}]
3-
** xref:pulsar-jms-install.adoc[Installation]
4-
** xref:pulsar-jms-mappings.adoc[Mapping Pulsar concepts to JMS]
5-
** xref:pulsar-jms-implementation.adoc[Implementation details]
6-
** xref:pulsar-jms-server-side-filters.adoc[Server-side filters]
7-
** xref:pulsar-jms-batch-ack.adoc[Batch index acknowledgement]
3+
** xref:jms-migration:pulsar-jms-install.adoc[Installation]
4+
** xref:reference:pulsar-jms-mappings.adoc[Mapping Pulsar concepts to JMS]
5+
** xref:examples:pulsar-jms-implementation.adoc[Implementation details]
6+
** xref:examples:pulsar-jms-server-side-filters.adoc[Server-side filters]
7+
** xref:examples:pulsar-jms-batch-ack.adoc[Batch index acknowledgement]
88
* Guides and Examples
9-
** xref:pulsar-jms-quickstart-sa.adoc[Pulsar standalone quick start]
10-
** xref:pulsar-jms-quickstart-astra.adoc[Astra Streaming quick start]
9+
** xref:jms-migration:pulsar-jms-quickstart-sa.adoc[Pulsar standalone quick start]
10+
** xref:jms-migration:pulsar-jms-quickstart-astra.adoc[Astra Streaming quick start]
1111
* Reference
12-
** xref:pulsar-jms-reference.adoc[{starlight_jms} Reference]
12+
** xref:reference:pulsar-jms-reference.adoc[{starlight_jms} Reference]
1313
** xref:pulsar-jms-faq.adoc[FAQs]
1414
** {jms_repo}[Github repo,window=_blank]

‎modules/ROOT/pages/index.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@
1919

2020
== What's next?
2121

22-
* *xref:pulsar-jms-quickstart-sa.adoc[]*: Create a simple command line Java JMS client that connects to a local Pulsar installation.
23-
* *xref:pulsar-jms-quickstart-astra.adoc[]*: Create a simple command line Java JMS client that connects to an Astra Streaming instance.
24-
* *xref:pulsar-jms-install.adoc[]*: Install {starlight_jms} in your own JMS project.
25-
* *xref:pulsar-jms-mappings.adoc[]*: Understand Pulsar concepts in the context of JMS.
26-
* *xref:pulsar-jms-implementation.adoc[]*: Understand key implementation details for {starlight_jms}.
22+
* *xref:jms-migration:pulsar-jms-quickstart-sa.adoc[]*: Create a simple command line Java JMS client that connects to a local Pulsar installation.
23+
* *xref:jms-migration:pulsar-jms-quickstart-astra.adoc[]*: Create a simple command line Java JMS client that connects to an Astra Streaming instance.
24+
* *xref:jms-migration:pulsar-jms-install.adoc[]*: Install {starlight_jms} in your own JMS project.
25+
* *xref:reference:pulsar-jms-mappings.adoc[]*: Understand Pulsar concepts in the context of JMS.
26+
* *xref:examples:pulsar-jms-implementation.adoc[]*: Understand key implementation details for {starlight_jms}.
2727
* *xref:pulsar-jms-faq.adoc[]*: Frequently asked questions about {starlight_jms}.
28-
* *xref:pulsar-jms-reference.adoc[]*: {starlight_jms} configuration reference.
28+
* *xref:reference:pulsar-jms-reference.adoc[]*: {starlight_jms} configuration reference.
2929
* *{jms_repo}[{starlight_jms} Github repo,window=_blank]*

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,10 @@ This https://javaee.github.io/jms-spec/[website,window=_blank] is useful as well
7676

7777
== What's next?
7878

79-
* *xref:pulsar-jms-quickstart-sa.adoc[]*: Create a simple command line Java JMS client that connects to a local Pulsar installation.
80-
* *xref:pulsar-jms-quickstart-astra.adoc[]*: Create a simple command line Java JMS client that connects to an Astra Streaming instance.
81-
* *xref:pulsar-jms-install.adoc[]*: Install {starlight_jms} in your own JMS project.
82-
* *xref:pulsar-jms-mappings.adoc[]*: Understand Pulsar concepts in the context of JMS.
83-
* *xref:pulsar-jms-implementation.adoc[]*: Understand key implementation details for {starlight_jms}.
84-
* *xref:pulsar-jms-reference.adoc[]*: {starlight_jms} configuration reference.
79+
* *xref:jms-migration:pulsar-jms-quickstart-sa.adoc[]*: Create a simple command line Java JMS client that connects to a local Pulsar installation.
80+
* *xref:jms-migration:pulsar-jms-quickstart-astra.adoc[]*: Create a simple command line Java JMS client that connects to an Astra Streaming instance.
81+
* *xref:jms-migration:pulsar-jms-install.adoc[]*: Install {starlight_jms} in your own JMS project.
82+
* *xref:reference:pulsar-jms-mappings.adoc[]*: Understand Pulsar concepts in the context of JMS.
83+
* *xref:examples:pulsar-jms-implementation.adoc[]*: Understand key implementation details for {starlight_jms}.
84+
* *xref:reference:pulsar-jms-reference.adoc[]*: {starlight_jms} configuration reference.
8585
* *{jms_repo}[{starlight_jms} Github repo,window=_blank]*

‎modules/examples/pages/pulsar-jms-batch-ack.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ acknowledgmentAtBatchIndexLevelEnabled=true
3737
== What's next?
3838

3939
For more on *server-side filtering*, see xref:pulsar-jms-server-side-filters.adoc[Server side filters]. +
40-
For more on acknowledgements in {starlight_jms}, see xref:pulsar-jms-mappings.adoc#consumer-mappings[Consumer Mappings].
40+
For more on acknowledgements in {starlight_jms}, see xref:reference:pulsar-jms-mappings.adoc#consumer-mappings[Consumer Mappings].
4141

4242

4343

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ A discussion of design and implementation decisions made to support JMS requirem
1414
* xref:pulsar-jms-implementation.adoc#message-selectors[Message selectors and `noLocal` subscriptions]
1515
* xref:pulsar-jms-implementation.adoc#schema-registry[]
1616
* xref:pulsar-jms-implementation.adoc#subscription-creation[Subscription creation]
17-
* xref:pulsar-jms-implementation.adoc#system-properites[System properties and fields]
17+
* xref:pulsar-jms-implementation.adoc#system-properties[System properties and fields]
1818
* xref:pulsar-jms-implementation.adoc#temporary-destinations[]
1919
* xref:pulsar-jms-implementation.adoc#transaction-emulation[]
2020
* xref:pulsar-jms-implementation.adoc#unsupported-features[Unsupported and emulated features]
@@ -36,7 +36,7 @@ When you set a `clientId`, the actual subscription name in Pulsar is constructed
3636

3737
One solution for this situation is the *dead letter topic* policy. The *dead-letter topic* policy routes the unsuccessful messages to the *dead-letter topic* for storage, so consumers can keep consuming while the unsuccessful messages are stored in the dead-letter topic for processing or evaluation.
3838

39-
{starlight_jms} allows further configuration of `deadLetterPolicy`. For more on `deadLetterTopic` configuration properties, see xref:pulsar-jms-reference.adoc[].
39+
{starlight_jms} allows further configuration of `deadLetterPolicy`. For more on `deadLetterTopic` configuration properties, see xref:reference:pulsar-jms-reference.adoc[].
4040
[source,language-java]
4141
----
4242
Map<String, Object> deadLetterPolicy = new HashMap<>();
@@ -86,7 +86,7 @@ A few usage notes on negative acknowledgement in {starlight_jms}:
8686

8787
* Calling `Session.recover()` stops delivery in the session, restarts message delivery with the oldest unacked message, and sends *negative acknowledgements* to the broker for the unacked messages.
8888

89-
* When using xref:pulsar-jms-reference.adoc#client-side-emulation[client side emulation] with *JMS Queues* and *Shared Subscriptions*, if a message does not match the xref:pulsar-jms-implementation.adoc#message-selectors[Selector], the JMS Client *negatively acknowledges* the message to let another consume pick up the message. +
89+
* When using xref:reference:pulsar-jms-reference.adoc[client side emulation] with *JMS Queues* and *Shared Subscriptions*, if a message does not match the xref:pulsar-jms-implementation.adoc#message-selectors[Selector], the JMS Client *negatively acknowledges* the message to let another consume pick up the message. +
9090

9191
* When using xref:pulsar-jms-server-side-filters.adoc[server side filtering] and xref:pulsar-jms-implementation.adoc#message-selectors[Selectors], there is still a chance that a *negative acknowledgement* will be sent when one message in a batch does not match the filter. +
9292
Using *negative acknowledgement* increases the count of deliveries of the message, which can trigger routing to the dead-letter topic if the number exceeds `maxRedeliverCount`. So if you're seeing messages in the dead-letter topic that shouldn't be there, they might be hitting a consumer with a local selector that doesn't match too many times.
@@ -157,7 +157,7 @@ NOTE: Apache ActiveMQ is licensed under Apache 2.0.
157157

158158
For {starlight_jms} to create subscriptions it must be granted permission, and the broker must be configured to automatically create subscriptions by setting the `allowAutoSubscriptionCreation=true` parameter on the broker configuration.
159159

160-
For more on subscription creation, including disabling automatic subscription creation, see xref:pulsar-jms-mappings.adoc#subscriptions[JMS subscriptions].
160+
For more on subscription creation, including disabling automatic subscription creation, see xref:reference:pulsar-jms-mappings.adoc#subscriptions[JMS subscriptions].
161161

162162
[#system-properties]
163163
=== System properties and fields:
@@ -401,10 +401,10 @@ For more on multi-topic subscriptions in Pulsar, see the https://pulsar.apache.o
401401

402402
== What's next?
403403

404-
* *xref:pulsar-jms-quickstart-sa.adoc[]*: Create a simple command line Java JMS client that connects to a local Pulsar installation.
405-
* *xref:pulsar-jms-quickstart-astra.adoc[]*: Create a simple command line Java JMS client that connects to an Astra Streaming instance.
406-
* *xref:pulsar-jms-install.adoc[]*: Install {starlight_jms} in your own JMS project.
407-
* *xref:pulsar-jms-mappings.adoc[]*: Understand Pulsar concepts in the context of JMS.
408-
* *xref:pulsar-jms-faq.adoc[]*: Frequently asked questions about {starlight_jms}.
409-
* *xref:pulsar-jms-reference.adoc[]*: {starlight_jms} configuration reference.
404+
* *xref:jms-migration:pulsar-jms-quickstart-sa.adoc[]*: Create a simple command line Java JMS client that connects to a local Pulsar installation.
405+
* *xref:jms-migration:pulsar-jms-quickstart-astra.adoc[]*: Create a simple command line Java JMS client that connects to an Astra Streaming instance.
406+
* *xref:jms-migration:pulsar-jms-install.adoc[]*: Install {starlight_jms} in your own JMS project.
407+
* *xref:reference:pulsar-jms-mappings.adoc[]*: Understand Pulsar concepts in the context of JMS.
408+
* *xref:ROOT:pulsar-jms-faq.adoc[]*: Frequently asked questions about {starlight_jms}.
409+
* *xref:reference:pulsar-jms-reference.adoc[]*: {starlight_jms} configuration reference.
410410
* *{jms_repo}[{starlight_jms} Github repo,window=_blank]*

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The `.nar` file filter is packaged with Luna Streaming *2.10.03+* and also avail
2222
====
2323
The path for the .nar is relative to your Pulsar directory.
2424
====
25-
For more, see xref:pulsar-jms-quickstart-sa.adoc[Standalone quick start].
25+
For more, see xref:jms-migration:pulsar-jms-quickstart-sa.adoc[Standalone quick start].
2626

2727
. Modify `PulsarConnectionFactory` in {starlight_jms} to disable client-side emulation and use server-side filtering:
2828
+
@@ -88,10 +88,10 @@ For the same reason, {starlight_jms} does not support custom formats like native
8888

8989
== What's next?
9090

91-
* *xref:pulsar-jms-quickstart-sa.adoc[]*: Create a simple command line Java JMS client that connects to a local Pulsar installation.
92-
* *xref:pulsar-jms-install.adoc[]*: Install {starlight_jms} in your own JMS project.
93-
* *xref:pulsar-jms-mappings.adoc[]*: Understand Pulsar concepts in the context of JMS.
91+
* *xref:jms-migration:pulsar-jms-quickstart-sa.adoc[]*: Create a simple command line Java JMS client that connects to a local Pulsar installation.
92+
* *xref:jms-migration:pulsar-jms-install.adoc[]*: Install {starlight_jms} in your own JMS project.
93+
* *xref:reference:pulsar-jms-mappings.adoc[]*: Understand Pulsar concepts in the context of JMS.
9494
* *xref:pulsar-jms-implementation.adoc[]*: Understand key implementation details for {starlight_jms}.
95-
* *xref:pulsar-jms-faq.adoc[]*: Frequently asked questions about {starlight_jms}.
96-
* *xref:pulsar-jms-reference.adoc[]*: {starlight_jms} configuration reference.
95+
* *xref:ROOT:pulsar-jms-faq.adoc[]*: Frequently asked questions about {starlight_jms}.
96+
* *xref:reference:pulsar-jms-reference.adoc[]*: {starlight_jms} configuration reference.
9797
* *{jms_repo}[{starlight_jms} Github repo,window=_blank]*

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ You can also use a "fat" JAR that includes all dependencies:
4646

4747
* *xref:pulsar-jms-quickstart-sa.adoc[]*: Create a simple command line Java JMS client that connects to a local Pulsar installation.
4848
* *xref:pulsar-jms-quickstart-astra.adoc[]*: Create a simple command line Java JMS client that connects to an Astra Streaming instance.
49-
* *xref:pulsar-jms-mappings.adoc[]*: Understand Pulsar concepts in the context of JMS.
50-
*xref:pulsar-jms-implementation.adoc[]*: Understand key implementation details for {starlight_jms}.
51-
* *xref:pulsar-jms-faq.adoc[]*: Frequently asked questions about {starlight_jms}.
52-
* *xref:pulsar-jms-reference.adoc[]*: {starlight_jms} configuration reference.
49+
* *xref:reference:pulsar-jms-mappings.adoc[]*: Understand Pulsar concepts in the context of JMS.
50+
* *xref:examples:pulsar-jms-implementation.adoc[]*: Understand key implementation details for {starlight_jms}.
51+
* *xref:ROOT:pulsar-jms-faq.adoc[]*: Frequently asked questions about {starlight_jms}.
52+
* *xref:reference:pulsar-jms-reference.adoc[]*: {starlight_jms} configuration reference.
5353
* *{jms_repo}[{starlight_jms} Github repo,window=_blank]*

‎modules/jms-migration/pages/pulsar-jms-quickstart-astra.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ In the code example above, note the following points of interest and make the re
166166
. This is the topic URI the client will use to publish and consume messages. You can create this using the Astra Streaming console. See the https://docs.datastax.com/en/astra-streaming/docs/astream-quick-start.html[Astra Streaming quick start].
167167
. Your Astra Streaming security token which you can retrieve from the *Connect* tab for your tenant in the Astra Streaming console. See the https://docs.datastax.com/en/astra-streaming/docs/astream-quick-start.html[Astra Streaming quick start].
168168
. A properties object containing your topic URI, your Astra Streaming token and the web and broker service URIs from the *Connect* tab for your tenant in the Astra Streaming console. See the https://docs.datastax.com/en/astra-streaming/docs/astream-quick-start.html[Astra Streaming quick start].
169-
. Creates a {starlight_jms} queue. For more information on mapping Pulsar to JMS concepts, see xref:pulsar-jms-mappings.adoc[]
169+
. Creates a {starlight_jms} queue. For more information on mapping Pulsar to JMS concepts, see xref:reference:pulsar-jms-mappings.adoc[]
170170
. Creates a {starlight_jms} consumer context using the `createConsumer` method...
171171
. ... and initializes an `onMessage` callback to consume the messages as they arrive.
172172
. Sends 10 "Hello World!" messages to the queue using the `createProducer` method.
@@ -254,8 +254,8 @@ TIP: You'll find message `0` is produced at the very top of the output. It can g
254254

255255
* *xref:pulsar-jms-quickstart-sa.adoc[]*: Create a simple command line Java JMS client that connects to a local Pulsar installation.
256256
* *xref:pulsar-jms-install.adoc[]*: Install {starlight_jms} in your own JMS project.
257-
* *xref:pulsar-jms-mappings.adoc[]*: Understand Pulsar concepts in the context of JMS.
258-
* *xref:pulsar-jms-implementation.adoc[]*: Understand key implementation details for {starlight_jms}.
259-
* *xref:pulsar-jms-faq.adoc[]*: Frequently asked questions about {starlight_jms}.
260-
* *xref:pulsar-jms-reference.adoc[]*: {starlight_jms} configuration reference.
257+
* *xref:reference:pulsar-jms-mappings.adoc[]*: Understand Pulsar concepts in the context of JMS.
258+
* *xref:examples:pulsar-jms-implementation.adoc[]*: Understand key implementation details for {starlight_jms}.
259+
* *xref:ROOT:pulsar-jms-faq.adoc[]*: Frequently asked questions about {starlight_jms}.
260+
* *xref:reference:pulsar-jms-reference.adoc[]*: {starlight_jms} configuration reference.
261261
* *{jms_repo}[{starlight_jms} Github repo,window=_blank]*

0 commit comments

Comments
 (0)