Skip to content

Commit b4cd394

Browse files
aimurphyaimurphy
authored
DOC-3707 more attributes (#239)
* more attributes * fix attribute
1 parent f849c61 commit b4cd394

File tree

11 files changed

+408
-240
lines changed

11 files changed

+408
-240
lines changed

‎docs/antora.yml‎

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,31 @@ nav:
99
asciidoc:
1010
attributes:
1111
company: 'DataStax'
12-
cdc_cass_first: 'DataStax CDC for Apache Cassandra(R)'
13-
cdc_cass: 'CDC for Cassandra'
14-
csc_pulsar_first: 'DataStax Cassandra Source Connector for Apache Pulsar(TM)'
15-
csc_pulsar: 'CSC for Pulsar'
12+
product: 'DataStax CDC for Apache Cassandra(R)'
13+
product-short: 'CDC for Cassandra'
14+
product-repo: 'https://github.com/datastax/cdc-apache-cassandra'
1615
cdc_agent_first: 'DataStax Change Agent for Apache Cassandra(R)'
1716
cdc_agent: 'Change Agent for Cassandra'
1817
luna_version: '3.1'
1918
version: '2.3.6' # cdc-apache-cassandra latest {version}
2019
dse: 'DataStax Enterprise (DSE)'
2120
dse-short: 'DSE'
21+
metrics-collector: 'DSE Metrics Collector'
22+
opscenter: 'DSE OpsCenter'
23+
astra-db: 'Astra DB'
24+
astra-stream: 'Astra Streaming'
25+
astra-streaming-examples-repo: 'https://github.com/datastax/astra-streaming-examples'
26+
scb: 'Secure Connect Bundle (SCB)'
27+
dsbulk-repo: 'https://github.com/datastax/dsbulk'
28+
dsbulk: 'DataStax Bulk Loader (DSBulk)'
29+
dsbulk-short: 'DSBulk'
2230
cass-reg: 'Apache Cassandra(R)'
2331
cass: 'Apache Cassandra'
2432
cass-short: 'Cassandra'
33+
pulsar-reg: 'Apache Pulsar(TM)'
34+
pulsar: 'Apache Pulsar'
35+
pulsar-short: 'Pulsar'
36+
37+
# Attributes used in auto-generated content - Do not change the attribute name
38+
csc_pulsar_first: 'DataStax Cassandra Source Connector (CSC) for Apache Pulsar(TM)'
39+
csc_pulsar: 'CSC for Pulsar'

‎docs/local-preview-playbook.yml‎

Lines changed: 168 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -55,23 +55,176 @@ asciidoc:
5555
xrefstyle: short
5656
# CUSTOM ATTRIBUTES
5757
company: 'DataStax'
58+
trust-center: 'IBM Trust Center'
59+
trust-center-url: 'https://www.ibm.com/trust'
60+
trust-center-link: '{trust-center-url}[{trust-center}]'
61+
support-url: 'https://www.ibm.com/mysupport/s/'
62+
dsbulk: 'DataStax Bulk Loader (DSBulk)'
63+
dsbulk-short: 'DSBulk'
64+
dsbulk-repo: 'https://github.com/datastax/dsbulk'
65+
astra: 'Astra'
66+
astra-db: 'Astra DB'
67+
astra-ui: 'Astra Portal'
68+
astra-url: 'https://astra.datastax.com'
69+
astra-ui-link: '{astra-url}[{astra-ui}^]'
70+
db-classic: 'Managed Cluster'
71+
db-serverless: 'Serverless (non-vector)'
72+
db-serverless-vector: 'Serverless (vector)'
73+
scb: 'Secure Connect Bundle (SCB)'
74+
scb-short: 'SCB'
75+
scb-brief: 'Secure Connect Bundle'
76+
devops-api: 'DevOps API'
77+
devops-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$devops-api/index.html'
78+
astra-cli: 'Astra CLI'
79+
astra-stream: 'Astra Streaming'
80+
starlight-kafka: 'Starlight for Kafka'
81+
starlight-rabbitmq: 'Starlight for RabbitMQ'
82+
astra-streaming-examples-repo: 'https://github.com/datastax/astra-streaming-examples'
83+
sstable-sideloader: '{astra-db} Sideloader'
84+
zdm: 'Zero Downtime Migration'
85+
zdm-short: 'ZDM'
86+
zdm-proxy: 'ZDM Proxy'
87+
cass-migrator: 'Cassandra Data Migrator (CDM)'
88+
cass-migrator-short: 'CDM'
89+
hcd: 'Hyper-Converged Database (HCD)'
90+
hcd-short: 'HCD'
91+
dse: 'DataStax Enterprise (DSE)'
92+
dse-short: 'DSE'
93+
metrics-collector: 'DSE Metrics Collector'
94+
mc: 'Mission Control'
95+
opscenter: 'DSE OpsCenter'
96+
studio: 'DataStax Studio'
97+
cass-reg: 'Apache Cassandra(R)'
98+
cass: 'Apache Cassandra'
99+
cass-short: 'Cassandra'
100+
cql: 'Cassandra Query Language (CQL)'
101+
cql-shell: 'CQL shell'
102+
cql-console: 'CQL console'
103+
cql-service: 'CQL Service'
104+
pulsar-reg: 'Apache Pulsar(TM)'
105+
pulsar: 'Apache Pulsar'
106+
pulsar-short: 'Pulsar'
107+
spark-reg: 'Apache Spark(TM)'
108+
spark: 'Apache Spark'
109+
spark-short: 'Spark'
110+
spark-connect: 'Spark Connect'
111+
spark-connector: 'Apache Cassandra Spark Connector'
112+
spark-connector-short: 'Spark Connector'
113+
kafka-reg: 'Apache Kafka(R)'
114+
kafka: 'Apache Kafka'
115+
kafka-short: 'Kafka'
116+
kafka-connect: 'Kafka Connect'
117+
kafka-connector: 'DataStax Apache Kafka Connector'
118+
kafka-connector-short: 'Kafka Connector'
119+
solr-reg: 'Apache Solr(TM)'
120+
solr: 'Apache Solr'
121+
solr-short: 'Solr'
122+
lucene-reg: 'Apache Lucene(TM)'
123+
lucene: 'Apache Lucene'
124+
lucene-short: 'Lucene'
125+
hadoop-reg: 'Apache Hadoop(R)'
126+
hadoop: 'Apache Hadoop'
127+
hadoop-short: 'Hadoop'
128+
airflow-reg: 'Apache Airflow(R)'
129+
airflow: 'Apache Airflow'
130+
airflow-short: 'Airflow'
131+
maven-reg: 'Apache Maven(TM)'
132+
maven: 'Apache Maven'
133+
maven-short: 'Maven'
134+
flink-reg: 'Apache Flink(R)'
135+
flink: 'Apache Flink'
136+
flink-short: 'Flink'
137+
beam-reg: 'Apache Beam(R)'
138+
beam: 'Apache Beam'
139+
beam-short: 'Beam'
140+
geode-reg: 'Apache Geode(TM)'
141+
geode: 'Apache Geode'
142+
geode-short: 'Geode'
143+
hbase-reg: 'Apache HBase(R)'
144+
hbase: 'Apache HBase'
145+
hbase-short: 'HBase'
146+
kudu-reg: 'Apache Kudu(TM)'
147+
kudu: 'Apache Kudu'
148+
kudu-short: 'Kudu'
149+
phoenix-reg: 'Apache Phoenix(TM)'
150+
phoenix: 'Apache Phoenix'
151+
phoenix-short: 'Phoenix'
152+
zookeeper-reg: 'Apache ZooKeeper(TM)'
153+
zookeeper: 'Apache ZooKeeper'
154+
zookeeper-short: 'ZooKeeper'
155+
asf: 'Apache Software Foundation (ASF)'
156+
asf-short: 'ASF'
157+
tinkerpop-reg: 'Apache TinkerPop(TM)'
158+
tinkerpop: 'Apache TinkerPop'
159+
tinkerpop-short: 'TinkerPop'
160+
cloudstack-reg: 'Apache CloudStack(R)'
161+
cloudstack: 'Apache CloudStack'
162+
cloudstack-short: 'CloudStack'
163+
tomcat-reg: 'Apache Tomcat(R)'
164+
tomcat: 'Apache Tomcat'
165+
tomcat-short: 'Tomcat'
166+
ajp: 'Apache JServ Protocol (AJP)'
167+
ajp-short: 'AJP'
168+
activemq-reg: 'Apache ActiveMQ(R)'
169+
activemq: 'Apache ActiveMQ'
170+
activemq-short: 'ActiveMQ'
171+
tomee-reg: 'Apache TomEE(TM)'
172+
tomee: 'Apache TomEE'
173+
tomee-short: 'TomEE'
174+
bookkeeper-reg: 'Apache BookKeeper(TM)'
175+
bookkeeper: 'Apache BookKeeper'
176+
bookkeeper-short: 'BookKeeper'
177+
groovy-reg: 'Apache Groovy(TM)'
178+
groovy: 'Apache Groovy'
179+
groovy-short: 'Groovy'
180+
cpp-driver-url: 'https://github.com/datastax/cpp-driver'
181+
csharp-driver-url: 'https://github.com/datastax/csharp-driver'
182+
gocql-astra-url: 'https://github.com/datastax/gocql-astra'
183+
go-driver-url: 'https://github.com/apache/cassandra-gocql-driver'
184+
cql-proxy-url: 'https://github.com/datastax/cql-proxy'
185+
java-driver-url: 'https://github.com/apache/cassandra-java-driver'
186+
nodejs-driver-url: 'https://github.com/datastax/nodejs-driver'
187+
python-driver-url: 'https://github.com/datastax/python-driver'
188+
scala-driver-url: 'https://github.com/apache/cassandra-spark-connector'
189+
cass-driver-cpp-shield: 'image:https://img.shields.io/github/v/tag/datastax/cpp-driver?label=latest[alt="Latest cpp-driver release on GitHub",link="{cpp-driver-url}/tags"]'
190+
cass-driver-csharp-shield: 'image:https://img.shields.io/nuget/v/CassandraCSharpDriver?label=latest[alt="Latest CassandraCSharpDriver release on NuGet",link="https://www.nuget.org/packages/CassandraCSharpDriver"]'
191+
cass-driver-go-shield: 'image:https://img.shields.io/github/v/tag/apache/cassandra-gocql-driver?label=latest%20gocql[alt="Latest gocql release on GitHub",link="{go-driver-url}/tags"]'
192+
cass-driver-java-shield: 'image:https://img.shields.io/github/v/tag/apache/cassandra-java-driver?label=latest[alt="Latest cassandra-java-driver release on GitHub",link="{java-driver-url}/tags"]'
193+
cass-driver-nodejs-shield: 'image:https://img.shields.io/github/v/tag/datastax/nodejs-driver?label=latest[alt="Latest nodejs-driver release on GitHub",link="{nodejs-driver-url}/tags"]'
194+
cass-driver-python-shield: 'image:https://img.shields.io/github/v/tag/datastax/python-driver?label=latest[alt="Latest python-driver release on GitHub",link="{python-driver-url}/tags"]'
195+
cass-driver-scala-shield: 'image:https://img.shields.io/github/v/tag/apache/cassandra-spark-connector?label=latest[alt="Latest cassandra-spark-connector release on GitHub",link="{scala-driver-url}/releases"]'
196+
data-api: 'Data API'
197+
csharp-client-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$csharp-client'
198+
py-client-api-ref-url-2x: 'xref:astra-api-docs:ROOT:attachment$python-client/astrapy'
199+
ts-client-api-ref-url-2x: 'xref:astra-api-docs:ROOT:attachment$typescript-client'
200+
java-client-api-ref-url-2x: 'xref:astra-api-docs:ROOT:attachment$java-client'
201+
python-client-repo-url: 'https://github.com/datastax/astrapy'
202+
typescript-client-repo-url: 'https://github.com/datastax/astra-db-ts'
203+
typescript-client-examples-url: '{typescript-client-repo-url}/blob/v2.x/examples'
204+
java-client-repo-url: 'https://github.com/datastax/astra-db-java'
205+
csharp-client-repo-url: 'https://github.com/datastax/astra-db-csharp'
206+
python-client-python-version: '3.8'
207+
dataapi-java-client-shield: 'image:https://img.shields.io/maven-central/v/com.datastax.astra/astra-db-java.svg?label=latest[alt="Latest astra-db-java release on Maven Central",link="https://search.maven.org/artifact/com.datastax.astra/astra-db-java"]'
208+
dataapi-python-client-shield: 'image:https://img.shields.io/github/v/tag/datastax/astrapy?label=latest[alt="Latest astrapy release on GitHub",link="{python-client-repo-url}/releases"]'
209+
dataapi-typescript-client-shield: 'image:https://img.shields.io/github/v/tag/datastax/astra-db-ts?label=latest[alt="Latest astra-db-ts release on GitHub",link="{typescript-client-repo-url}/releases"]'
210+
dataapi-csharp-client-shield: 'image:https://img.shields.io/github/v/tag/datastax/astra-db-csharp?label=latest[alt="Latest astra-db-csharp release on GitHub",link="{csharp-client-repo-url}/releases"]'
211+
agent: 'DataStax Agent'
212+
repair-service: 'Repair Service'
213+
backup-service: 'Backup Service'
214+
performance-service: 'Performance Service'
215+
monitoring-service: 'OpsCenter Monitoring'
216+
nodesync-service: 'NodeSync Service'
217+
bestpractice-service: 'Best Practice Service'
218+
capacity-service: 'Capacity Service'
219+
lcm: 'Lifecycle Manager (LCM)'
220+
lcm-short: 'LCM'
221+
cr: 'custom resource (CR)'
222+
cr-short: 'CR'
223+
crd: 'custom resource definition (CRD)'
224+
crd-short: 'CRD'
225+
# Custom attributes only used in ragstack-ai
58226
astra_db: 'Astra DB'
59-
astra_stream: 'Astra Streaming'
60227
astra_ui: 'Astra Portal'
61-
astra_cli: 'Astra CLI'
62-
astra-streaming-examples-repo: 'https://raw.githubusercontent.com/datastax/astra-streaming-examples/master'
63-
luna-streaming-examples-repo: 'https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main'
64-
support_url: 'https://www.ibm.com/mysupport/s/'
65-
glossary-url: 'https://docs.datastax.com/en/glossary/docs/index.html#'
66-
emoji-tada: "🎉"
67-
emoji-rocket: "🚀"
68-
emoji-smile: "&#128512"
69-
dse: 'DataStax Enterprise (DSE)'
70-
cassandra: 'Apache Cassandra(R)'
71-
classic: 'classic'
72-
classic_cap: 'Classic'
73-
serverless: 'serverless'
74-
serverless_cap: 'Serverless'
75228
# Antora Atlas
76229
primary-site-url: https://docs.datastax.com/en
77230
primary-site-manifest-url: https://docs.datastax.com/en/site-manifest.json

0 commit comments

Comments
 (0)