Skip to content

Commit 0834e61

Browse files
authored
more attributes (#37)
1 parent 9f37808 commit 0834e61

9 files changed

Lines changed: 43 additions & 43 deletions

File tree

antora.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,12 @@ nav:
88

99
asciidoc:
1010
attributes:
11-
# General attributes
1211
company: 'DataStax'
13-
# Other product attributes
14-
cass-reg: 'Apache Cassandra(R)'
15-
cass: 'Apache Cassandra'
16-
cass-short: 'Cassandra'
17-
# Astra DB attributes
1812
astra-db: 'Astra DB'
1913
product: 'Astra CLI'
2014
product-short: 'Astra'
2115
product-version: '1.0'
16+
product-repo: 'https://github.com/datastax/astra-cli'
2217
db-serverless: 'Serverless (non-vector)'
2318
db-serverless-vector: 'Serverless (vector)'
2419
db-classic: 'Managed Cluster'
@@ -30,3 +25,8 @@ asciidoc:
3025
scb: 'Secure Connect Bundle (SCB)'
3126
scb-short: 'SCB'
3227
scb-brief: 'Secure Connect Bundle'
28+
dsbulk: 'DataStax Bulk Loader (DSBulk)'
29+
dsbulk-short: 'DSBulk'
30+
cql: 'Cassandra Query Language (CQL)'
31+
cql-shell: 'CQL shell'
32+
pulsar-short: 'Pulsar'

in-progress/astra-streaming-cli.adoc

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ astra streaming status **TENANT_NAME**
283283
----
284284
====
285285

286-
Use the `astra streaming pulsar-token` command to get the Pulsar token for a specific tenant:
286+
Use the `astra streaming pulsar-token` command to get the {pulsar-short} token for a specific tenant:
287287

288288
[source,bash,subs="+quotes"]
289289
----
@@ -722,14 +722,14 @@ OPTIONS
722722
----
723723
====
724724

725-
== Use the Pulsar shell
725+
== Use the {pulsar-short} shell
726726

727-
The https://pulsar.apache.org/docs/next/administration-pulsar-shell/[Pulsar shell] is an interactive command-line interface tool for managing and interacting with Pulsar clusters.
728-
It is designed to allow developers and administrators to execute Pulsar commands interactively or in a script-like fashion, facilitating tasks such as creating topics, producing and consuming messages, managing schemas, and more.
727+
The https://pulsar.apache.org/docs/next/administration-pulsar-shell/[{pulsar-short} shell] is an interactive command-line interface tool for managing and interacting with {pulsar-short} clusters.
728+
It is designed to allow developers and administrators to execute {pulsar-short} commands interactively or in a script-like fashion, facilitating tasks such as creating topics, producing and consuming messages, managing schemas, and more.
729729

730-
The {product} provides built-in Pulsar shell support by downloading, installing, configuring, and wrapping the `pulsar-shell` utility.
730+
The {product} provides built-in {pulsar-short} shell support by downloading, installing, configuring, and wrapping the `pulsar-shell` utility.
731731

732-
Use the `astra streaming pulsar-shell` command to start the Pulsar shell in interactive mode:
732+
Use the `astra streaming pulsar-shell` command to start the {pulsar-short} shell in interactive mode:
733733

734734
[source,bash,subs="+quotes"]
735735
----
@@ -756,7 +756,7 @@ default(pulsar-aws-useast2.streaming.datastax.com)>
756756
----
757757
====
758758

759-
Type `exit` and press kbd:[Enter] to exit the Pulsar shell.
759+
Type `exit` and press kbd:[Enter] to exit the {pulsar-short} shell.
760760

761761
The first time you use the `astra streaming pulsar-shell` commands, the {product} downloads and installs the `pulsar-shell` utility to the {product} installation directory (`~/.astra/lunastreaming-shell-*`).
762762

@@ -825,7 +825,7 @@ OPTIONS
825825
----
826826
====
827827

828-
Use the `-e`/`--execute` option to execute a Pulsar shell command:
828+
Use the `-e`/`--execute` option to execute a {pulsar-short} shell command:
829829

830830
[source,bash,subs="+quotes"]
831831
----
@@ -834,7 +834,7 @@ astra streaming pulsar-shell **TENANT_NAME** -e "admin namespaces list **TENANT_
834834

835835
// TODO: Add the output of the command. The command reported a Java-related error. Determine if more java prerequisites are needed.
836836

837-
Use the `-f`/`--file` option to execute Pulsar shell commands from a file:
837+
Use the `-f`/`--file` option to execute {pulsar-short} shell commands from a file:
838838

839839
[source,bash,subs="+quotes"]
840840
----
@@ -843,9 +843,9 @@ astra streaming pulsar-shell **TENANT_NAME** -f sample.txt
843843

844844
// TODO: Add sample.txt content and the output of the command.
845845

846-
=== Pulsar shell example
846+
=== {pulsar-short} shell example
847847

848-
The following procedure shows an example of how to use the {product}'s built-in Pulsar shell support to write and read in a topic with a client:
848+
The following procedure shows an example of how to use the {product}'s built-in {pulsar-short} shell support to write and read in a topic with a client:
849849

850850
. Create a tenant:
851851
+
@@ -864,7 +864,7 @@ https://api.astra.datastax.com/v2/streaming/tenants/my-streaming-tenant
864864
----
865865
====
866866

867-
. In two separate terminals, run the following command to start the Pulsar shell in each terminal:
867+
. In two separate terminals, run the following command to start the {pulsar-short} shell in each terminal:
868868
+
869869
[source,bash]
870870
----
@@ -1033,7 +1033,7 @@ OPTIONS
10331033

10341034
== Create environment variables
10351035

1036-
When developing applications with {astra-stream} APIs, you will notice common values that are frequently reused, such as Pulsar tokens, broker URLs, and web service URLs.
1036+
When developing applications with {astra-stream} APIs, you will notice common values that are frequently reused, such as {pulsar-short} tokens, broker URLs, and web service URLs.
10371037
It's a good practice to store these values in environment variables to facilitate reuse in your scripts, simplify token rotation, and increase security by keeping sensitive information separate from your core application code.
10381038

10391039
The {product} can automatically generate a set of relevant variables for an {astra-stream} tenant that you can use in your applications.

in-progress/dsbulk.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
= Run DataStax Bulk Loader (DSBulk) commands
2-
:navtitle: DSBulk quickstart
1+
= Run {dsbulk} commands
2+
:navtitle: {dsbulk-short} quickstart
33

4-
xref:dsbulk:overview:dsbulk-about.adoc[DataStax Bulk Loader (DSBulk)] is a utility that you can use to load, unload, and count data in your database tables.
5-
The {product} provides embedded DSBulk support by downloading, installing, configuring, and wrapping the `dsbulk` utility.
4+
xref:dsbulk:overview:dsbulk-about.adoc[{dsbulk}] is a utility that you can use to load, unload, and count data in your database tables.
5+
The {product} provides embedded {dsbulk-short} support by downloading, installing, configuring, and wrapping the `dsbulk` utility.
66

7-
The {product} exposes DSBulk functionality through the following commands:
7+
The {product} exposes {dsbulk-short} functionality through the following commands:
88

99
* `xref:commands:astra-db-dsbulk-load.adoc[]`
1010
* `xref:commands:astra-db-dsbulk-unload.adoc[]`
@@ -147,9 +147,9 @@ To resume the current operation, re-run it with the same settings, and add the f
147147
----
148148
====
149149

150-
== Complete DSBulk example
150+
== Complete {dsbulk-short} example
151151

152-
The following end-to-end example shows how to use the {product}'s built-in DSBulk support to load data into a database, get information about the data, and unload the data into CSV files:
152+
The following end-to-end example shows how to use the {product}'s built-in {dsbulk-short} support to load data into a database, get information about the data, and unload the data into CSV files:
153153

154154
. Create an {astra-db} {db-serverless} database:
155155
+

in-progress/managing.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2774,9 +2774,9 @@ OPTIONS
27742774
====
27752775

27762776
[#cqlsh]
2777-
== Use cqlsh
2777+
== Use `cqlsh`
27782778

2779-
`cqlsh` is an interface that you can use to issue xref:astra@cql:ROOT:index.adoc[{cass-short} Query Language (CQL)] commands to your database.
2779+
`cqlsh` is an interface that you can use to issue xref:astra@cql:ROOT:index.adoc[{cql}] commands to your database.
27802780
The {product} provides built-in `cqlsh` support by downloading, installing, configuring, and wrapping the `cqlsh` utility.
27812781
This can act as a convenient alternative to installing and configuring a xref:astra-db-serverless:cql:develop-with-cql.adoc#connect-to-the-cql-shell[standalone cqlsh].
27822782

@@ -3021,12 +3021,12 @@ astra db cqlsh **DATABASE_ID** -e "SOURCE 'sample.cql'"
30213021
====
30223022
======
30233023

3024-
== Use DataStax Bulk Loader
3024+
== Use {dsbulk}
30253025

3026-
The xref:dsbulk:overview:dsbulk-about.adoc[DataStax Bulk Loader (DSBulk)] lets you load, unload, and count data in your database tables.
3027-
The {product} provides built-in DSBulk support by downloading, installing, configuring, and wrapping the `dsbulk` utility.
3026+
The xref:dsbulk:overview:dsbulk-about.adoc[{dsbulk}] lets you load, unload, and count data in your database tables.
3027+
The {product} provides built-in {dsbulk-short} support by downloading, installing, configuring, and wrapping the `dsbulk` utility.
30283028

3029-
The {product} exposes DSBulk functionality through the `astra db load`, `astra db unload`, and `astra db count` commands.
3029+
The {product} exposes {dsbulk-short} functionality through the `astra db load`, `astra db unload`, and `astra db count` commands.
30303030

30313031
The first time you run `astra db load`, `astra db unload`, or `astra db count` commands, the {product} downloads and installs the `dsbulk` utility to the {product} installation directory (`~/.astra/dsbulk-*`).
30323032
The {product} also downloads the {scb} for each database you connect to and stores the {scb-short} zip files in the `~/.astra/scb` directory.
@@ -3462,9 +3462,9 @@ OPTIONS
34623462
----
34633463
====
34643464

3465-
=== Complete DSBulk example
3465+
=== Complete {dsbulk-short} example
34663466

3467-
The following end-to-end example shows how to use the {product}'s built-in DSBulk support to load data into a database, get information about the data, and unload the data into CSV files:
3467+
The following end-to-end example shows how to use the {product}'s built-in {dsbulk-short} support to load data into a database, get information about the data, and unload the data into CSV files:
34683468

34693469
. Create an {astra-db} {db-serverless} database:
34703470
+

modules/ROOT/nav.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
include::ROOT:partial$partial-nav.adoc[]
1212

1313
.Release notes
14-
* https://github.com/datastax/astra-cli?tab=readme-ov-file#whats-changed[Release notes]
14+
* {product-repo}?tab=readme-ov-file#whats-changed[Release notes]
1515
1616
//-
1717

18-
* https://github.com/datastax/astra-cli[GitHub repository]
18+
* {product-repo}[GitHub repository]

modules/ROOT/pages/install.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ The response includes available commands and options for the {product}.
7979
Binary installation::
8080
+
8181
--
82-
. Download the appropriate binary archive for your OS and CPU architecture from https://github.com/datastax/astra-cli/releases[GitHub].
82+
. Download the appropriate binary archive for your OS and CPU architecture from {product-repo}/releases[GitHub].
8383

8484
. Extract the archive into the directory where you want to install the {product}.
8585
For example:
@@ -173,7 +173,7 @@ The response includes available commands and options for the {product}.
173173
Binary installation::
174174
+
175175
--
176-
. Download the `windows` zip file from https://github.com/datastax/astra-cli/releases[GitHub].
176+
. Download the `windows` zip file from {product-repo}/releases[GitHub].
177177

178178
. Extract the zip file into the directory where you want to install the {product}:
179179
+

modules/ROOT/pages/manage-cli.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -563,7 +563,7 @@ The {product} home folder contains the following items:
563563
* Cache files for <<command-auto-completion,command auto-completion>>
564564
* Logs
565565

566-
For more information about `ASTRA_HOME`, see the https://github.com/datastax/astra-cli?tab=readme-ov-file#home-folder-location[{product} README].
566+
For more information about `ASTRA_HOME`, see the {product-repo}?tab=readme-ov-file#home-folder-location[{product} README].
567567

568568
|`.astrarc`
569569
a|The {product} configuration file.
@@ -576,7 +576,7 @@ _Default location_:
576576

577577
The {product} uses this file to store your <<manage-configuration-profiles,configuration profiles>> and their associated application tokens.
578578

579-
For more information about the {product} configuration file, see the https://github.com/datastax/astra-cli?tab=readme-ov-file#astrarc-location[{product} README].
579+
For more information about the {product} configuration file, see the {product-repo}?tab=readme-ov-file#astrarc-location[{product} README].
580580
|===
581581

582582
=== Override the default home folder location

modules/ROOT/pages/upgrade-pre-1.0.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,5 +56,5 @@ However, there are some changes that might break certain scripted usage, such as
5656
* New standardized xref:ROOT:manage-cli.adoc#output-formats[JSON and CSV output formats and exit codes].
5757
5858
* Minor command and flag name changes.
59-
For a full list of name changes, see the https://github.com/datastax/astra-cli?tab=readme-ov-file#whats-changed[release notes].
59+
For a full list of name changes, see the {product-repo}?tab=readme-ov-file#whats-changed[release notes].
6060
====

modules/quickstarts/pages/cqlsh.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
= Issue CQL commands with cqlsh in the {product}
1+
= Issue CQL commands with {cql-shell} in the {product}
22
:navtitle: CQL quickstart
33

4-
The {cass-short} Query Language Shell (`cqlsh`) is a utility that you can use to issue xref:astra@cql:reference:cql-quick-reference.adoc[CQL commands] to your {astra-db} databases.
4+
The {cql-shell} (`cqlsh`) is a utility that you can use to issue xref:astra@cql:reference:cql-quick-reference.adoc[{cql} commands] to your {astra-db} databases.
55

66
The {product} provides embedded `cqlsh` support by downloading and installing the `cqlsh` utility in the background and exposing it through the `xref:commands:astra-db-cqlsh.adoc[]` commands.
77
This can act as a convenient alternative to installing and configuring a xref:astra-db-serverless:cql:develop-with-cql.adoc#connect-to-the-cql-shell[standalone cqlsh].

0 commit comments

Comments
 (0)