Skip to content
This repository was archived by the owner on Feb 3, 2026. It is now read-only.

Commit 3271f8c

Browse files
authored
DOC-4604 Move Starlight content to Starlight docs repos (#68)
* update links * combine Luna Streaming starlight content * revising unified pages b4 move to starlight repos * move table * finish revising rabbitmq tabs * revise and reorg starlight topics b4 move * move JMS to starlight * move s4r to s4r docs repo * move s4k to s4k repo
1 parent 46b9df2 commit 3271f8c

39 files changed

Lines changed: 90 additions & 771 deletions

antora.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ nav:
99
asciidoc:
1010
attributes:
1111
company: 'DataStax'
12-
product: 'Astra Streaming'
13-
product-short: 'Astra'
1412
astra-db: 'Astra DB'
1513
astra-ui: 'Astra Portal'
1614
astra-url: 'https://astra.datastax.com'
@@ -21,7 +19,7 @@ asciidoc:
2119
pulsar-version: '3.1' #DO NOT INCLUDE PATCH VERSION <MAJOR>.<MINOR>.<PATCH>
2220
debezium-version: '1.7'
2321
astra-streaming-examples-repo: 'https://raw.githubusercontent.com/datastax/astra-streaming-examples/master'
24-
kafka-for-astra: 'Starlight for Kafka'
22+
starlight-kafka: 'Starlight for Kafka'
2523
starlight-rabbitmq: 'Starlight for RabbitMQ'
2624
cass: Apache Cassandra
2725
cass-short: Cassandra

example-guide.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
A guide is a document offering step by step instruction to reach some goal. Guides are technical in nature and tend to make assumptions about the consumer's environment. To help create guides that will work in most environments, please follow these ideas.
1010
1111
* *Keep links to a minimum* - when someone is learning a new concept for the first time and xref:README.adoc[every] other xref:README.adoc[word] is linked it xref:README.adoc[makes] things xref:README.adoc[confusing] and hard to get a good flow going. Instead, annotate a word or phrase and provide a "Resources" area at the bottom of the guide.
12-
* *Separate products and runtimes in tabs* - it is common to reach the same result through multiple ways. An example is creating a tenant/namespace/topic in {product} and Luna Streaming. Both have the same result but get there in very different ways. Offer each as a tab and let the consumer choose their path. The step after the tabbed step can assume the consumer has complete the previious step and is in a known state. Runtimes follow the same pattern. Weather one is using Java or C#, they are still creating a {pulsar-short} client to interact with the cluster. Create a single step in the guide with multiple tabs for each runtime.
12+
* *Separate products and runtimes in tabs* - it is common to reach the same result through multiple ways. An example is creating a tenant/namespace/topic in Astra Streaming and Luna Streaming. Both have the same result but get there in very different ways. Offer each as a tab and let the consumer choose their path. The step after the tabbed step can assume the consumer has complete the previious step and is in a known state. Runtimes follow the same pattern. Weather one is using Java or C#, they are still creating a {pulsar-short} client to interact with the cluster. Create a single step in the guide with multiple tabs for each runtime.
1313
* *Be thoughtful about the names you use* - if you are leaning a new concept or feature with no background on the product, words matter. Labeling a tab as "Luna Helm" and then referring to it as "{pulsar-short} Helm Chart" are two distinct things to that reader. The author of the document has such deep understanding that they consider those things the same - and technically they are at {company}. But the read isn't from {company}, so be mindful of their context.
1414
* *Talk in first person* - humans create the guides and humans consume the guides. Write as if you are paired with your consumer in doing what ever the guide does. Use "we", "us", "you".
1515
====

modules/ROOT/nav.adoc

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
.Processing data
1+
.Process data
22
* xref:cdc-for-cassandra:ROOT:cdc-concepts.adoc[Change Data Capture (CDC)]
3-
* xref:astra-streaming:getting-started:real-time-data-pipelines-tutorial.adoc[Build real-time data pipelines with {product}]
3+
* xref:astra-streaming:getting-started:real-time-data-pipelines-tutorial.adoc[Build real-time data pipelines with Astra Streaming]
44
5-
.Migrating to {pulsar}
6-
* xref:use-cases-architectures:starlight/index.adoc[]
7-
* xref:use-cases-architectures:starlight/kafka/index.adoc[]
8-
* xref:use-cases-architectures:starlight/rabbitmq/index.adoc[]
9-
* xref:use-cases-architectures:starlight/jms/index.adoc[]
5+
.Migrate to {pulsar}
6+
* xref:starlight-for-kafka:ROOT:index.adoc[{starlight-kafka}]
7+
* xref:starlight-for-rabbitmq:ROOT:index.adoc[{starlight-rabbitmq}]
8+
* xref:starlight-for-jms:ROOT:index.adoc[Starlight for JMS]
109
1110
.APIs and References
1211
* Connectors

modules/ROOT/pages/index.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
We've included best practices for Apache Pulsar, a full connector reference,
2020
and examples for getting the most out of CDC.
2121
22-
xref:astra-streaming:getting-started:real-time-data-pipelines-tutorial.adoc[Build real-time data pipelines with {product}]
22+
xref:astra-streaming:getting-started:real-time-data-pipelines-tutorial.adoc[Build real-time data pipelines with Astra Streaming]
2323
2424
</div>
2525
@@ -106,8 +106,8 @@
106106
107107
<ul class="!m-0 [&>li]:my-2">
108108
<li>xref:starlight-for-jms::index.adoc[Starlight for JMS]</li>
109-
<li>xref:starlight-for-kafka::index.adoc[]</li>
110-
<li>xref:starlight-for-rabbitmq::index.adoc[]</li>
109+
<li>xref:starlight-for-kafka::index.adoc[Starlight for Kafka]</li>
110+
<li>xref:starlight-for-rabbitmq::index.adoc[Starlight for RabbitMQ]</li>
111111
</ul>
112112
113113
</div>

modules/functions/pages/astream-functions.adoc

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@
44
Functions are lightweight compute processes that enable you to process each message received on a topic.
55
You can apply custom logic to that message, transforming or enriching it, and then output it to a different topic.
66

7-
Functions run inside {product} and are therefore serverless.
7+
Functions run inside Astra Streaming and are therefore serverless.
88
You write the code for your function in Java, Python, or Go, then upload the code.
99
It is automatically run for each message published to the specified input topic.
1010

1111
Functions are implemented using https://pulsar.apache.org/docs/en/functions-overview/[{pulsar-reg} functions].
1212

1313
[IMPORTANT]
1414
====
15-
Custom functions require a xref:astra-streaming:operations:astream-pricing.adoc[paid {product} plan].
15+
Custom functions require a xref:astra-streaming:operations:astream-pricing.adoc[paid Astra Streaming plan].
1616
====
1717

1818
== Deploy Python functions in a zip file
1919

20-
{product} supports Python-based {pulsar-short} functions.
21-
These functions can be packaged in a zip file and deployed to {product} or {pulsar-short}.
20+
Astra Streaming supports Python-based {pulsar-short} functions.
21+
These functions can be packaged in a zip file and deployed to Astra Streaming or {pulsar-short}.
2222
The same zip file can be deployed to either environment.
2323

2424
To demonstrate this, the following steps create function configuration YAML file, package all necessary function files as a zip archive, and then use the `pulsar-admin` CLI to deploy the zip.
@@ -152,8 +152,8 @@ Replace the following:
152152
* `**INPUT_TOPIC_NAME**`: The input topic for the function
153153
* `**OUTPUT_TOPIC_NAME**`: The output topic for the function
154154

155-
. Use `pulsar-admin` to deploy the Python zip to {product} or {pulsar-short}.
156-
The command below assumes you've properly configured the `client.conf` file for `pulsar-admin` commands against your {pulsar-short} cluster. If you are using {product}, see xref:astra-streaming:developing:configure-pulsar-env.adoc[] for more information.
155+
. Use `pulsar-admin` to deploy the Python zip to Astra Streaming or {pulsar-short}.
156+
The command below assumes you've properly configured the `client.conf` file for `pulsar-admin` commands against your {pulsar-short} cluster. If you are using Astra Streaming, see xref:astra-streaming:developing:configure-pulsar-env.adoc[] for more information.
157157
+
158158
[source,console]
159159
----
@@ -163,7 +163,7 @@ bin/pulsar-admin functions create --function-config-file /absolute/path/to/func-
163163
. Verify that the function was deployed:
164164
+
165165
* Go to the {astra-ui} to see your newly deployed function listed under the **Functions** tab for your tenant.
166-
See <<controlling-your-function,Controlling your function>> for more information on testing and monitoring your function in {product}.
166+
See <<controlling-your-function,Controlling your function>> for more information on testing and monitoring your function in Astra Streaming.
167167
* Use the `pulsar-admin` CLI to list functions for a specific tenant and namespace:
168168
+
169169
[source,bash,subs="+quotes"]
@@ -173,8 +173,8 @@ bin/pulsar-admin functions list --tenant **TENANT_NAME** --namespace **NAMESPACE
173173

174174
== Deploy Java functions in a JAR file
175175

176-
{product} supports Java-based {pulsar-short} functions which are packaged in a JAR file.
177-
The JAR can be deployed to {product} or {pulsar-short}.
176+
Astra Streaming supports Java-based {pulsar-short} functions which are packaged in a JAR file.
177+
The JAR can be deployed to Astra Streaming or {pulsar-short}.
178178
The same JAR file can be deployed to either environment.
179179

180180
In this example, you'll create a function JAR file using Maven, then use the `pulsar-admin` CLI to deploy the JAR.
@@ -289,15 +289,15 @@ userConfig:
289289
+
290290
[IMPORTANT]
291291
====
292-
{product} requires the `inputs` topic to have a message schema defined before deploying the function.
292+
Astra Streaming requires the `inputs` topic to have a message schema defined before deploying the function.
293293
Otherwise, deployment errors may occur.
294294
Use the {astra-ui} to define the message schema for a topic.
295295
====
296296

297-
. Use the `pulsar-admin` CLI to deploy your function JAR to {product} or {pulsar-short}.
297+
. Use the `pulsar-admin` CLI to deploy your function JAR to Astra Streaming or {pulsar-short}.
298298
+
299299
The following command assumes you've properly configured the `client.conf` file for `pulsar-admin` commands against your {pulsar-short} cluster.
300-
If you are using {product}, see xref:astra-streaming:developing:configure-pulsar-env.adoc[] for more information.
300+
If you are using Astra Streaming, see xref:astra-streaming:developing:configure-pulsar-env.adoc[] for more information.
301301
+
302302
[source,bash]
303303
----
@@ -307,17 +307,17 @@ bin/pulsar-admin functions create --function-config-file /absolute/path/to/func
307307
. Verify that the function was deployed:
308308
+
309309
* Go to the {astra-ui} to see your newly deployed function listed under the **Functions** tab for your tenant.
310-
See <<controlling-your-function,Controlling your function>> for more information on testing and monitoring your function in {product}.
310+
See <<controlling-your-function,Controlling your function>> for more information on testing and monitoring your function in Astra Streaming.
311311
* Use the `pulsar-admin` CLI to list functions for a specific tenant and namespace:
312312
+
313313
[source,bash,subs="+quotes"]
314314
----
315315
bin/pulsar-admin functions list --tenant **TENANT_NAME** --namespace **NAMESPACE_NAME**
316316
----
317317

318-
== Add functions in {product} dashboard
318+
== Add functions in Astra Streaming dashboard
319319

320-
Add functions in the **Functions** tab of the {product} dashboard.
320+
Add functions in the **Functions** tab of the Astra Streaming dashboard.
321321

322322
. Select *Create Function* to get started.
323323

@@ -326,7 +326,7 @@ Add functions in the **Functions** tab of the {product} dashboard.
326326
image::astream-name-function.png[Function and Namespace]
327327

328328
. Select the file you want to pull the function from and which function you want to use within that file.
329-
{product} generates a list of acceptable classes.
329+
Astra Streaming generates a list of acceptable classes.
330330
+
331331
image::astream-exclamation-function.png[Exclamation Function]
332332
+
@@ -416,7 +416,7 @@ If you want to use different topics, change `in`, `out`, and `log` accordingly.
416416
. Verify that the response is `Created Successfully!`.
417417
This indicates that the function was deployed and ready to run when triggered by incoming messages.
418418
+
419-
If the response is `402 Payment Required` with `Reason: only qualified organizations can create functions`, then you must upgrade to a xref:astra-streaming:operations:astream-pricing.adoc[paid {product} plan].
419+
If the response is `402 Payment Required` with `Reason: only qualified organizations can create functions`, then you must upgrade to a xref:astra-streaming:operations:astream-pricing.adoc[paid Astra Streaming plan].
420420
+
421421
You can also verify that a function was created by checking the **Functions** tab or by running `./pulsar-admin functions list --tenant **TENANT_NAME**`.
422422

@@ -512,4 +512,4 @@ A *Function-name Deleted Successfully!* message confirms the function was perman
512512

513513
== Next steps
514514

515-
Learn more about developing functions for {product} and {pulsar-short} https://pulsar.apache.org/docs/en/functions-develop/[here].
515+
Learn more about developing functions for Astra Streaming and {pulsar-short} https://pulsar.apache.org/docs/en/functions-develop/[here].

modules/functions/pages/deploy-in-sink.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Before this update, functions transformed data either after it was written to a
55
This required either an intermediate topic, with additional storage, IO, and latency, or a custom connector. +
66
Now, functions can be deployed at sink creation and apply preprocessing to sink topic writes. +
77

8-
== Create sink function in {product}
8+
== Create sink function in Astra Streaming
99

1010
Creating a sink function is similar to creating a sink in the {astra-ui}, but with a few additional steps.
1111

12-
. xref:pulsar-io:connectors/index.adoc[Create a sink] as described in the {product} documentation.
12+
. xref:pulsar-io:connectors/index.adoc[Create a sink] as described in the Astra Streaming documentation.
1313

1414
. During sink creation, select the transform function you want to run inside the sink.
1515
+

modules/functions/pages/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ transform-function-2
158158
======
159159

160160
[#deploy-as]
161-
== Deploy with {product}
161+
== Deploy with Astra Streaming
162162

163163
Deploy transform functions in the *Functions* tab of the {astra-ui}.
164164

modules/pulsar-io/pages/connectors/index.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
= Connectors
22
:navtitle: Connector Overview
33

4-
{product} offers fully-managed {pulsar-reg} connectors.
4+
Astra Streaming offers fully-managed {pulsar-reg} connectors.
55

66
Create, monitor, and manage both source and sink connectors through our simple UI, the `pulsar-admin` CLI, or RESTful API.
77
Connect popular data sources to {pulsar} topics or sink data from {pulsar-short} topics to popular systems.
88

9-
Below is a list of {pulsar} source and sink connectors supported by {product}.
9+
Below is a list of {pulsar} source and sink connectors supported by Astra Streaming.
1010

1111
[IMPORTANT]
1212
====
13-
{product} doesn't support custom sink or source connectors.
13+
Astra Streaming doesn't support custom sink or source connectors.
1414
====
1515

1616
[#sink-connectors]
@@ -154,7 +154,7 @@ xref:connectors/sources/kinesis.adoc[Kinesis source connector documentation]
154154

155155
== Experimental Connectors
156156

157-
{company} is always experimenting with connectors. Below are the connectors currently in development that have not yet been promoted to official support in *{product}*.
157+
{company} is always experimenting with connectors. Below are the connectors currently in development that have not yet been promoted to official support in *Astra Streaming*.
158158

159159
To get access to these connectors, contact {support-url}[{company} Support].
160160

@@ -238,7 +238,7 @@ Zeebe +
238238

239239
== Listing Sink Connectors
240240

241-
To list available sink connectors in your {product} tenant, use any of the following.
241+
To list available sink connectors in your Astra Streaming tenant, use any of the following.
242242

243243
[tabs]
244244
====
@@ -288,7 +288,7 @@ curl "$WEB_SERVICE_URL/admin/v3/sinks/builtinsinks" -H "Authorization: $ASTRA_ST
288288

289289
== Listing Source Connectors
290290

291-
To list available source connectors in your {product} tenant, use any of the following.
291+
To list available source connectors in your Astra Streaming tenant, use any of the following.
292292

293293
[tabs]
294294
====

modules/pulsar-io/pages/connectors/sinks/astra-db.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
{company} {astra-db} Sink Connector is based on the open-source xref:pulsar-connector:ROOT:index.adoc[{cass-reg} sink connector for {pulsar-reg}]. Depending on how you deploy the connector, it can be used to sink topic messages with a table in {astra-db} or a table in a {cass-short} cluster outside of DB.
66

7-
The {product} portal provides simple way to connect this sink and a table in {astra-db} with simply a token. Using `pulsar-admin` or the REST API, you can configure the sink to connect with a {cass-short} connection manually.
7+
The Astra Streaming portal provides simple way to connect this sink and a table in {astra-db} with simply a token. Using `pulsar-admin` or the REST API, you can configure the sink to connect with a {cass-short} connection manually.
88

99
This reference assumes you are manually connecting to a {cass-short} table.
1010

modules/pulsar-io/pages/connectors/sinks/cloud-storage.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,9 @@ include::partial$connectors/sinks/monitoring.adoc[]
141141

142142
== Connector Reference
143143

144-
With the Cloud Storage Sink there are two sets of parameters: {product} parameters and cloud storage provider parameters.
144+
With the Cloud Storage Sink there are two sets of parameters: Astra Streaming parameters and cloud storage provider parameters.
145145

146-
=== {product} parameters for Cloud Storage Sink
146+
=== Astra Streaming parameters for Cloud Storage Sink
147147

148148
[%header,format=csv,cols="2,1,1,3"]
149149
|===

0 commit comments

Comments
 (0)