Skip to content

Commit 3a045b2

Browse files
authored
find-and-replace for attributes (#53)
1 parent de43d44 commit 3a045b2

File tree

68 files changed

+457
-464
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+457
-464
lines changed

antora.yml

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,13 @@ nav:
88

99
asciidoc:
1010
attributes:
11-
product_name: 'Astra Streaming'
12-
pulsar_version: '2.10' #DO NOT INCLUDE PATCH VERSION <MAJOR>.<MINOR>.<PATCH>
13-
debezium_version: '1.7'
14-
request_feature_access_email: '[email protected]'
11+
product: 'Astra Streaming'
12+
pulsar: 'Apache Pulsar'
13+
pulsar-short: 'Pulsar'
14+
pulsar-reg: 'Apache Pulsar(TM)'
15+
pulsar-version: '2.10' #DO NOT INCLUDE PATCH VERSION <MAJOR>.<MINOR>.<PATCH>
16+
debezium-version: '1.7'
17+
astra-streaming-examples-repo: 'https://raw.githubusercontent.com/datastax/astra-streaming-examples/master'
18+
cass: Apache Cassandra
19+
cass-short: Cassandra
20+
cass-reg: Apache Cassandra(R)

example-guide.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
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 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 client to interact with the cluster. Create a single step in the guide with multiple tabs for each runtime.
13-
* *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 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 DataStax. But the read isn't from DataStax, so be mindful of their context.
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.
13+
* *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
====
1616

@@ -21,7 +21,7 @@ Have you ever wanted to use this new feature? Well look no further than this gui
2121
You will need the following things in place to complete this guide:
2222

2323
* about 5 minutes
24-
* a working Pulsar topic (xref:README.adoc[get started here] if you don't have one)
24+
* a working {pulsar-short} topic (xref:README.adoc[get started here] if you don't have one)
2525

2626
== First group of tasks
2727

modules/ROOT/nav.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@
1111
** xref:use-cases-architectures:real-time-data-pipeline/03-put-it-all-together.adoc[]
1212
** xref:use-cases-architectures:real-time-data-pipeline/04-debugging-and-clean-up.adoc[]
1313
14-
.Migrating to Apache Pulsar
14+
.Migrating to {pulsar}
1515
* xref:use-cases-architectures:starlight/index.adoc[]
1616
* xref:use-cases-architectures:starlight/kafka/index.adoc[]
1717
* xref:use-cases-architectures:starlight/rabbitmq/index.adoc[]
1818
* xref:use-cases-architectures:starlight/jms/index.adoc[]
1919
20-
.APIs & References
20+
.APIs and References
2121
* Connectors
2222
** xref:pulsar-io:connectors/index.adoc[]
2323
** Sources

modules/ROOT/pages/index.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
= DataStax Streaming Learning
1+
= {company} Streaming Learning
22

3-
The learning site is a collection of guides and articles about DataStax streaming products. Each product has its own area dedicated to providing specifics to get started, its features, and other details. The learning site helps you get the most out of each product and get to production using best practices.
3+
The learning site is a collection of guides and articles about {company} streaming products. Each product has its own area dedicated to providing specifics to get started, its features, and other details. The learning site helps you get the most out of each product and get to production using best practices.
44

55
== Processing Data
66

@@ -28,7 +28,7 @@ A real-time data pipeline is a series of steps that takes data from its original
2828
</div>
2929
++++
3030

31-
== Migrating to Apache Pulsar
31+
== Migrating to {pulsar-reg}
3232

3333
++++
3434
<div class="landing-row">
@@ -48,7 +48,7 @@ xref:streaming-learning:use-cases-architectures:starlight/jms/index.adoc[Get sta
4848
.xref:streaming-learning:use-cases-architectures:starlight/kafka/index.adoc[Starlight for Kafka]
4949
****
5050
--
51-
Starlight for Kafka brings native Apache Kafka(R) protocol support to Apache Pulsar by introducing a Kafka protocol handler on Pulsar brokers.
51+
Starlight for Kafka brings native {pulsar} protocol support by introducing a Kafka protocol handler on {pulsar-short} brokers.
5252
5353
xref:streaming-learning:use-cases-architectures:starlight/kafka/index.adoc[Get started now] | xref:starlight-for-kafka:ROOT:index.adoc[Configuring] | https://github.com/datastax/starlight-for-kafka[Source Code]
5454
--
@@ -58,7 +58,7 @@ xref:streaming-learning:use-cases-architectures:starlight/kafka/index.adoc[Get s
5858
.xref:streaming-learning:use-cases-architectures:starlight/rabbitmq/index.adoc[Starlight for RabbitMQ]
5959
****
6060
--
61-
Starlight for RabbitMQ combines the AMQP 0.9.1 API with Pulsar, providing a powerful way to modernize your RabbitMQ infrastructure, improve performance, and reduce costs.
61+
Starlight for RabbitMQ combines the AMQP 0.9.1 API with {pulsar-short}, providing a powerful way to modernize your RabbitMQ infrastructure, improve performance, and reduce costs.
6262
6363
xref:streaming-learning:use-cases-architectures:starlight/rabbitmq/index.adoc[Get started now] | xref:starlight-for-rabbitmq:ROOT:index.adoc[Configuring] | https://github.com/datastax/starlight-for-rabbitmq[Source Code]
6464
--
@@ -72,20 +72,20 @@ xref:streaming-learning:use-cases-architectures:starlight/rabbitmq/index.adoc[Ge
7272

7373
=== Connectors
7474

75-
A connector is a function that moves data between Apache Pulsar and external systems. Source are used to push data to Pulsar from external systems such as databases, message queues, and storage systems. Sinks are used to pull data from a Pulsar topic to an external system like a database, data warehouse, or storage system. +
75+
A connector is a function that moves data between {pulsar} and external systems. Source are used to push data to {pulsar-short} from external systems such as databases, message queues, and storage systems. Sinks are used to pull data from a {pulsar-short} topic to an external system like a database, data warehouse, or storage system. +
7676
xref:streaming-learning:pulsar-io:connectors/index.adoc#_source_connectors[Sources] | xref:streaming-learning:pulsar-io:connectors/index.adoc#_sink_connectors[Sinks] | xref:streaming-learning:pulsar-io:connectors/index.adoc#_experimental_connectors[Experimental]
7777

78-
=== Pulsar Functions
78+
=== {pulsar-short} Functions
7979

8080
Functions are lightweight compute processes that enable you to process each message received on a topic. You can apply custom logic to that message, transforming or enriching it, and then output it to a different topic. +
8181
xref:streaming-learning:functions:astream-functions.adoc[Learn more]
8282

8383
=== Transformation Functions
8484

85-
Transform functions are a low-code implementation of common Pulsar functions. They are used to transform messages from one format to another. Use them to transform a message, enrich messages with additional data, or filter messages based on their content. +
85+
Transform functions are a low-code implementation of common {pulsar-short} functions. They are used to transform messages from one format to another. Use them to transform a message, enrich messages with additional data, or filter messages based on their content. +
8686
xref:streaming-learning:functions:cast.adoc[Cast] | xref:streaming-learning:functions:compute.adoc[Compute] | xref:streaming-learning:functions:drop.adoc[Drop] | xref:streaming-learning:functions:flatten.adoc[Flatten] | xref:streaming-learning:functions:merge-key-value.adoc[Merge] | xref:streaming-learning:functions:unwrap-key-value.adoc[Unwrap]
8787

8888
=== Topic Subscriptions
8989

90-
Subscriptions in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +
90+
Subscriptions in {pulsar-short} describe which consumers are consuming data from a topic and how they want to consume that data. +
9191
xref:streaming-learning:subscriptions:astream-subscriptions-exclusive.adoc[Exclusive] | xref:streaming-learning:subscriptions:astream-subscriptions-shared.adoc[Shared] | xref:streaming-learning:subscriptions:astream-subscriptions-failover.adoc[Failover] | xref:streaming-learning:subscriptions:astream-subscriptions-keyshared.adoc[Key Shared]

0 commit comments

Comments
 (0)