more attributes

Author: aimurphy

antora.yml

@@ -12,7 +12,7 @@ asciidoc:
     support-url: 'https://www.ibm.com/mysupport/s/'
     astra-db: 'Astra DB'
     product: 'Astra Streaming'
-    product-short: 'Astra'
+    astra: 'Astra' # This attribute is also used in include::common partials.
     astra-cli: 'Astra CLI'
     astra-ui: 'Astra Portal'
     astra-url: 'https://astra.datastax.com'
@@ -24,26 +24,37 @@ asciidoc:
     cass: 'Apache Cassandra'
     cass-reg: 'Apache Cassandra(R)'
     cass-short: 'Cassandra'
+    cql: 'Cassandra Query Language (CQL)'
+    cql-short: 'CQL'
+    cql-shell: 'CQL shell'
+    cql-console: 'CQL console'
     pulsar: 'Apache Pulsar'
     pulsar-short: 'Pulsar'
     pulsar-reg: 'Apache Pulsar(TM)'
-    pulsar-version: '3.1' #DO NOT INCLUDE PATCH VERSION <MAJOR>.<MINOR>.<PATCH>
+    pulsar-version: '3.1' #Don't include patch version (major.minor.patch)
     pulsar-version-patch: '3.1.0'
-
+    kafka-reg: 'Apache Kafka(R)'
+    kafka: 'Apache Kafka'
+    kafka-short: 'Kafka'
+    kafka-connect: 'Kafka Connect'
+    maven-reg: 'Apache Maven(TM)'
+    maven-short: 'Maven'
+    flink-reg: 'Apache Flink(R)'
+    geode-reg: 'Apache Geode(TM)'
+    hbase-reg: 'Apache HBase(R)'
+    kudu-reg: 'Apache Kudu(TM)'
+    phoenix-reg: 'Apache Phoenix(TM)'
+    solr-reg: 'Apache Solr(TM)'
     starlight-kafka: 'Starlight for Kafka'
     starlight-rabbitmq: 'Starlight for RabbitMQ'
     gpt-schema-translator: 'GPT schema translator'
-    astra-streaming-examples-repo: 'https://raw.githubusercontent.com/datastax/astra-streaming-examples/master'
-    scb: 'Secure Connect Bundle (SCB)'
-    scb-short: 'SCB'
-    scb-brief: 'Secure Connect Bundle'
+    astra-streaming-examples-repo: https://github.com/datastax/astra-streaming-examples
 
-    # Required for include::common partials that are shared with Luna Streaming
+    # Required for include::common partials; some shared with Luna Streaming
     web-ui: '{astra-ui}'
     debezium-version: '1.7'
-    astra: 'Astra'
+    scb: 'Secure Connect Bundle (SCB)'
+    scb-short: 'SCB'
+    scb-brief: 'Secure Connect Bundle'
 
-    # LEGACY ATTRIBUTES - CONSIDER REMOVING
-    langstream: 'RAGStack'
-    ragstack: 'RAGStack'
-    streaming_signup_url: 'https://astra.datastax.com/streaming'
+    # For more attributes, see release.yml in the datastax-docs-site repo

modules/ROOT/pages/astream-faq.adoc

@@ -100,14 +100,14 @@ The following questions address security and access control in {product}.
 
 === Does {product} support single-sign on?
 
-If your {product-short} organization is on a paid {product-short} subscription plan, your users can use SSO to sign in to the {astra-ui}.
+If your {astra} organization is on a paid {astra} subscription plan, your users can use SSO to sign in to the {astra-ui}.
 For more information, see xref:astra-db-serverless:administration:configure-sso.adoc[].
 
-=== How do {product-short} roles and permissions map to {pulsar-short} roles and permissions?
+=== How do {astra} roles and permissions map to {pulsar-short} roles and permissions?
 
 See xref:ROOT:astream-org-permissions.adoc[].
 
-=== What is the difference between {product-short} application tokens and the {pulsar-short} tokens?
+=== What is the difference between {astra} application tokens and the {pulsar-short} tokens?
 
 See xref:operations:astream-token-gen.adoc[].
 
@@ -128,7 +128,7 @@ See the following:
 Unless you are starting a project from scratch, you likely have message data that needs to be brought over to your {product} tenants.
 For migration assistance, contact {support-url}[IBM Support].
 
-Every tenant in {product} comes with custom ports for Kafka and RabbitMQ workloads.
+Every tenant in {product} comes with custom ports for {kafka-reg} and RabbitMQ workloads.
 {company} also offers a fully-compatible JMS implementation for your Java workloads.
 For more information, see xref:developing:starlight.adoc[].
 
@@ -161,7 +161,7 @@ Naturally, you have less control in a managed, serverless cluster than you do in
 Beyond those differences, the effort to develop locally and then move to {product} should not be significant, but {company} recommends that you develop directly in {product}.
 If you are trying to reduce costs, use the free tier of {product} and then switch when you are ready to stage your production services.
 
-=== Can I use {product} with my existing Kafka or RabbitMQ applications?
+=== Can I use {product} with my existing {kafka} or RabbitMQ applications?
 
 Yes, see xref:developing:starlight.adoc[].
 

modules/ROOT/pages/astream-org-permissions.adoc

@@ -1,8 +1,8 @@
 = Manage {product} roles and permissions
 :navtitle: Manage roles and permissions
 
-You manage role-based access control (RBAC) for {product} through your {product-short} organization.
-For information about {product-short} RBAC, including default roles, custom roles, permissions, and user management, see xref:astra-db-serverless:administration:manage-database-access.adoc[].
+You manage role-based access control (RBAC) for {product} through your {astra} organization.
+For information about {astra} RBAC, including default roles, custom roles, permissions, and user management, see xref:astra-db-serverless:administration:manage-database-access.adoc[].
 
 == {product} permissions
 
@@ -12,7 +12,7 @@ Permissions specific to {product} include the following:
 
 === Default roles for {product}
 
-There are no default {product-short} roles specifically scoped to {product}.
+There are no default {astra} roles specifically scoped to {product}.
 However, the following default roles have the *Manage Streaming* permission:
 
 * *Organization Administrator*
@@ -36,22 +36,22 @@ Additional permissions might be required, depending on the tasks the role needs
 To control access to specific streaming tenants, you can set granular xref:astra-db-serverless:administration:manage-database-access.adoc#role-scopes[resource scopes] on custom roles.
 ====
 
-== Authentication and authorization in {pulsar-reg} and {product-short}
+== Authentication and authorization in {pulsar-reg} and {astra}
 
 {pulsar-short} has the concept of https://pulsar.apache.org/docs/security-authorization/[clients with role tokens].
 In {pulsar-short}, authentication is the process of verifying a provided token (JWT), and authorization is the process of determining if the role claimed in that token is allowed to complete the requested action.
 
 {product} uses the {company} version of {pulsar} (xref:luna-streaming::index.adoc[Luna Streaming]).
 The https://github.com/datastax/pulsar[Luna project] is an open fork of the {pulsar-short} project that maintains feature parity with OSS {pulsar-short}. {product}, as a managed service, abstracts some features/options of {pulsar-short} to ensure continuous, reliable service.
 
-On a shared cluster, your {product-short} organization has one or more tenants on a shared {pulsar-short} cluster.
-Each of your tenants is secured by {pulsar-short} authentication and authorization models, as well as your {product-short} organization's authentication and authorization ({product-short} RBAC).
+On a shared cluster, your {astra} organization has one or more tenants on a shared {pulsar-short} cluster.
+Each of your tenants is secured by {pulsar-short} authentication and authorization models, as well as your {astra} organization's authentication and authorization ({astra} RBAC).
 
 {product} shared clusters are created and administered by {product} administrators.
 Each tenant is assigned a custom role and permissions limited to that tenant only.
 All tokens created within a tenant are assigned roles similar to the assigning tenant.
 
-For programmatic access, you use {product-short} application tokens or {pulsar-short} JWT, depending on the operation you need to perform.
+For programmatic access, you use {astra} application tokens or {pulsar-short} JWT, depending on the operation you need to perform.
 For more information, see xref:operations:astream-token-gen.adoc[].
 
 == See also

modules/ROOT/partials/subscription-prereq.adoc

@@ -2,7 +2,7 @@
 
 This example requires the following:
 
-* https://maven.apache.org/install.html[Apache Maven]
+* https://maven.apache.org/install.html[{maven-reg}]
 
 * https://openjdk.java.net/install/[Java OpenJDK 11]
 

modules/apis/pages/api-operations.adoc

@@ -17,15 +17,15 @@ Other available APIs include the xref:apis:index.adoc[{product} {devops-api}] an
 
 To send requests to the {product} {pulsar-short} Admin API, you need the following:
 
-* An active {product-short} account with access to {product}.
+* An active {astra} account with access to {product}.
 
 * A {product} tenant.
 
 * A xref:operations:astream-token-gen.adoc[{pulsar-short} token] for your tenant.
 +
 [IMPORTANT]
 ====
-An {product-short} application token _isn't_ the same as a {pulsar-short} token.
+An {astra} application token _isn't_ the same as a {pulsar-short} token.
 For more information, see xref:operations:astream-token-gen.adoc[].
 ====
 
@@ -1256,7 +1256,7 @@ curl -sS --fail -L -X GET "$WEB_SERVICE_URL/admin/v3/sinks/$TENANT/$NAMESPACE/$S
 
 To create a sink connector on a topic, you must provide the xref:connectors:index.adoc[sink connector configuration] in JSON format.
 
-The following example configures the built-in Kafka sink connector in {product}:
+The following example configures the built-in {kafka-reg} sink connector in {product}:
 
 .kafka-sink-config.json
 [source,json]

modules/apis/pages/index.adoc

@@ -2,7 +2,7 @@
 :description: Learn about the {product} {devops-api}.
 
 The {product} {devops-api} is one of the APIs that you can use to manage your {pulsar-reg} tenants and their resources.
-Use this API to manage higher-level {product} objects associated with your {product-short} organization, such as the Change Data Capture (CDC) settings, {pulsar-short} tenants, georeplication, {pulsar-short} stats, and {pulsar-short} tokens.
+Use this API to manage higher-level {product} objects associated with your {astra} organization, such as the Change Data Capture (CDC) settings, {pulsar-short} tenants, georeplication, {pulsar-short} stats, and {pulsar-short} tokens.
 
 .More endpoints
 [TIP]
@@ -18,9 +18,9 @@ Other available APIs include the xref:apis:api-operations.adoc[{product} {pulsar
 
 To use the {product} {devops-api}, you need the following:
 
-* An active {product-short} account with access to {product}.
+* An active {astra} account with access to {product}.
 
-* An xref:operations:astream-token-gen.adoc[{product-short} application token] that has a role with {product} permissions.
+* An xref:operations:astream-token-gen.adoc[{astra} application token] that has a role with {product} permissions.
 
 * Depending on the operations you need to perform, you might need additional information about your tenant, such as the cluster name or {pulsar-short} instance name.
 You can get this information with `<<get-tenant-details,GET "https://api.astra.datastax.com/v2/streaming/tenants">>` or from the xref:operations:create-delete-tenants.adoc#get-tenant-details[**Tenant Details** section in the {astra-ui}].
@@ -338,7 +338,7 @@ For more information, see xref:operations:astream-token-gen.adoc[].
 
 [TIP]
 ====
-For {product-short} application tokens, use the core xref:astra-db-serverless:api-reference:devops-api.adoc[{product-short} {devops-api}].
+For {astra} application tokens, use the core xref:astra-db-serverless:api-reference:devops-api.adoc[{astra} {devops-api}].
 ====
 
 [#get-existing-pulsar-tokens]

modules/connectors/pages/index.adoc

@@ -17,7 +17,7 @@ Supported sink connectors::
 The following sink connectors are included in {product}:
 +
 * xref:connectors:sinks/astra-db.adoc[{astra-db} and {cass} sink]
-* xref:connectors:sinks/kafka.adoc[Apache Kafka sink]
+* xref:connectors:sinks/kafka.adoc[{kafka-reg} sink]
 * xref:connectors:sinks/kinesis.adoc[AWS Kinesis sink]
 * xref:connectors:sinks/cloud-storage.adoc[Cloud Storage sink]
 * xref:connectors:sinks/elastic-search.adoc[Elasticsearch sink]
@@ -31,14 +31,14 @@ The following sink connectors are included in {product}:
 Experimental sink connectors::
 The following sink connectors are experimental.
 They are in development, and they aren't fully supported or tested with {product}.
-To get access to experimental connectors, contact {support_url}[{company} Support].
+To get access to experimental connectors, contact {support-url}[{company} Support].
 +
 * Aerospike
-* Apache Geode
-* Apache HBase
-* Apache Kudu
-* Apache Phoenix
-* Apache Solr
+* {geode-reg}
+* {hbase-reg}
+* {kudu-reg}
+* {phoenix-reg}
+* {solr-reg}
 * Batch Data Generator
 * CoAP
 * Couchbase
@@ -77,7 +77,7 @@ Source connectors ingest messages from external services into {pulsar-short} top
 Supported source connectors::
 The following source connectors are included in {product}:
 +
-* xref:connectors:sources/kafka.adoc[Apache Kafka source]
+* xref:connectors:sources/kafka.adoc[{kafka-reg} source]
 * xref:connectors:sources/kinesis.adoc[AWS Kinesis source]
 * xref:connectors:sources/data-generator.adoc[Data Generator source]
 * xref:connectors:sources/debezium-mongodb.adoc[Debezium MongoDB source]
@@ -89,12 +89,12 @@ The following source connectors are included in {product}:
 Experimental source connectors::
 The following source connectors are experimental.
 They are in development, and they aren't fully supported or tested with {product}.
-To get access to experimental connectors, contact {support_url}[{company} Support].
+To get access to experimental connectors, contact {support-url}[{company} Support].
 +
 * {cass}
-* Apache Geode
-* Apache Kudu
-* Apache Phoenix
+* {geode-reg}
+* {kudu-reg}
+* {phoenix-reg}
 * Batch Data Generator
 * Big Query
 * Canal

modules/connectors/pages/sinks/google-bigquery.adoc

@@ -25,11 +25,11 @@ include::common:streaming:partial$connectors/connector-params-intro.adoc[]
 include::common:streaming:partial$connectors/sinks/pulsar-config-params.adoc[]
 
 [#configs]
-=== Kafka Connect adaptor properties (`configs`)
+=== {kafka-connect} adaptor properties (`configs`)
 
 include::common:streaming:partial$connectors/sinks/google-bigquery-properties.adoc[]
 
 [#kafkaConnectorConfigProperties]
-=== Kafka Connect BigQuery Sink properties (`kafkaConnectorConfigProperties`)
+=== {kafka-connect} BigQuery Sink properties (`kafkaConnectorConfigProperties`)
 
 include::common:streaming:partial$connectors/sinks/google-bigquery-sink-properties.adoc[]

modules/connectors/pages/sinks/kafka.adoc

@@ -1,12 +1,13 @@
-= Kafka
+= {kafka-short}
+:navtitle: {kafka-short}
 :connectorType: kafka
 
-The Kafka sink connector reads messages from {pulsar-short} topics and writes them to https://kafka.apache.org/[Kafka] topics.
+The {kafka-short} sink connector reads messages from {pulsar-short} topics and writes them to https://kafka.apache.org/[{kafka-reg}] topics.
 
 [#compatibility]
 == Compatibility
 
-{product} supports {pulsar-reg} {pulsar-version}, which uses the https://github.com/apache/kafka/tree/2.7[Kafka 2.7.2 library].
+{product} supports {pulsar-reg} {pulsar-version}, which uses the https://github.com/apache/kafka/tree/2.7[{kafka} 2.7.2 library].
 
 == Create the connector
 
@@ -29,9 +30,9 @@ include::common:streaming:partial$connectors/connector-params-intro.adoc[]
 include::common:streaming:partial$connectors/sinks/pulsar-config-params.adoc[]
 
 [#configs]
-=== Kafka sink connector properties (`configs`)
+=== {kafka-short} sink connector properties (`configs`)
 
 Set these properties in the `configs` section of the connector configuration.
 
-Generally, all properties provided in the https://pulsar.apache.org/docs/io-kafka-sink[OSS {pulsar} Kafka sink connector] are supported.
+Generally, all properties provided in the https://pulsar.apache.org/docs/io-kafka-sink[OSS {pulsar} {kafka-short} sink connector] are supported.
 Exceptions include properties that aren't relevant to {product} and properties that aren't present in {pulsar} {pulsar-version}.

modules/connectors/pages/sources/kafka.adoc

@@ -1,7 +1,7 @@
-= Kafka
+= {kafka-short}
 :connectorType: kafka
 
-The Kafka source connector pulls data from https://kafka.apache.org/[Kafka] topics and persists it to {pulsar-short} topics.
+The {kafka-short} source connector pulls data from https://kafka.apache.org/[{kafka-reg}] topics and persists it to {pulsar-short} topics.
 
 == Create the connector
 
@@ -24,9 +24,9 @@ include::common:streaming:partial$connectors/connector-params-intro.adoc[]
 include::common:streaming:partial$connectors/sources/pulsar-config-params.adoc[]
 
 [#configs]
-=== Kafka source connector properties (`configs`)
+=== {kafka-short} source connector properties (`configs`)
 
 Set these properties in the `configs` section of the connector configuration.
 
-Generally, all properties provided in the https://pulsar.apache.org/docs/io-kafka-source[OSS {pulsar} Kafka source connector] are supported.
+Generally, all properties provided in the https://pulsar.apache.org/docs/io-kafka-source[OSS {pulsar} {kafka-short} source connector] are supported.
 Exceptions include properties that aren't relevant to {product} and properties that aren't present in {pulsar} {pulsar-version}.