Skip to content

Commit c3cf03e

Browse files
authored
DOC-5558 attribute usage and classic rename (#33)
* attribute usage and classic rename * adjust naming convention * peer review
1 parent 1c28e5b commit c3cf03e

9 files changed

Lines changed: 44 additions & 39 deletions

File tree

antora.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ asciidoc:
2222
product-version: '1.0'
2323
db-serverless: 'Serverless (Non-Vector)'
2424
db-serverless-vector: 'Serverless (Vector)'
25-
db-classic: 'Classic'
25+
db-classic: 'Managed Cluster'
2626
devops-api: 'DevOps API'
2727
astra-stream: 'Astra Streaming'
2828
astra-ui: 'Astra Portal'

in-progress/administration.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -352,8 +352,8 @@ OPTIONS
352352
====
353353
Removing a user removes their access to your organization, but it doesn't delete their account.
354354
355-
The user retains their personal {astra_db} account under their associated email address, including access to their default (personal) organization and any other organizations they belong to.
356-
The user can still access their personal {astra_db} account, if they have access to the associated xref:astra-db-serverless:administration:invite-users-to-organization.adoc#accept-the-invite[authentication method].
355+
The user retains their personal {product-short} account under their associated email address, including access to their default (personal) organization and any other organizations they belong to.
356+
The user can still access their personal {product-short} account, if they have access to the associated xref:astra-db-serverless:administration:invite-users-to-organization.adoc#accept-the-invite[authentication method].
357357
358358
If your organization uses SSO, make sure that you also remove the user from your IdP, if necessary.
359359
====

in-progress/astra-streaming-cli.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Writer's note: This page is no longer published but there is still content that should be retained and reformatted for Astra CLI 1.0.
2-
= {astra_stream} commands
2+
= {astra-stream} commands
33

4-
Use the {product} to manage your {astra_stream} deployments.
4+
Use the {product} to manage your {astra-stream} deployments.
55

66
== Create a tenant
77

@@ -28,7 +28,7 @@ Running `astra streaming create` without any options deploys the tenant in the d
2828
====
2929
Tenant names must be unique
3030
31-
All tenant names in {astra_stream} must be unique.
31+
All tenant names in {astra-stream} must be unique.
3232
If the tenant name is already in use, the command fails with with the following error message:
3333
3434
[source,console]
@@ -541,9 +541,9 @@ OPTIONS
541541
----
542542
====
543543

544-
== Get a list of available {astra_stream} regions
544+
== Get a list of available {astra-stream} regions
545545

546-
Use the `astra streaming list-regions` command to get a list of available regions that support {astra_stream}:
546+
Use the `astra streaming list-regions` command to get a list of available regions that support {astra-stream}:
547547

548548
[source,bash]
549549
----
@@ -959,7 +959,7 @@ key:[null], properties:[], content:hello
959959

960960
== Change Data Capture (CDC)
961961

962-
CDC for {astra_db} automatically captures changes in real time, de-duplicates the changes, and then streams the clean set of changed data into xref:astra-streaming:ROOT:index.adoc[{astra_stream}] where it can be processed by client applications or sent to downstream systems.
962+
CDC for {astra-db} automatically captures changes in real time, de-duplicates the changes, and then streams the clean set of changed data into xref:astra-streaming:ROOT:index.adoc[{astra-stream}] where it can be processed by client applications or sent to downstream systems.
963963

964964
For more information about using the {product} to configure CDC, see xref:ROOT:managing.adoc#cdc[Configure Change Data Capture].
965965

@@ -1033,12 +1033,12 @@ 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 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

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

1041-
Use the `astra streaming create-dotenv` command to generate a `.env` file containing relevant environment variables for a specific {astra_stream} tenant:
1041+
Use the `astra streaming create-dotenv` command to generate a `.env` file containing relevant environment variables for a specific {astra-stream} tenant:
10421042

10431043
[source,bash,subs="+quotes"]
10441044
----

in-progress/change-data-capture.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
= Configure Change Data Capture (CDC) with the {product}
22
:navtitle: Change Data Capture quickstart
33

4-
Change Data Capture (CDC) for {astra_db} automatically captures changes in real time, de-duplicates the changes, and then streams the clean set of changed data into xref:astra-streaming:ROOT:index.adoc[{astra_stream}] where it can be processed by client applications or sent to downstream systems.
4+
Change Data Capture (CDC) for {astra-db} automatically captures changes in real time, de-duplicates the changes, and then streams the clean set of changed data into xref:astra-streaming:ROOT:index.adoc[{astra-stream}] where it can be processed by client applications or sent to downstream systems.
55

6-
This page provides an end-to-end example that shows you how to use the {product} to enable CDC for an {astra-db} database.
6+
This page provides an end-to-end example that shows you how to use the {product} to enable CDC for an {astra} database.
77

88
== Create a database
99

10-
Create an {astra_db} database:
10+
Create a database:
1111

1212
[source,shell]
1313
----
@@ -25,7 +25,7 @@ Database 'cdc_demo_db' has been created with id 'ce5e563c-3248-4064-b03c-5892433
2525

2626
== Create a streaming tenant
2727

28-
Create an {astra_stream} tenant in the same region as your database:
28+
Create an {astra-stream} tenant in the same region as your database:
2929

3030
[source,shell]
3131
----

in-progress/dsbulk.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ To resume the current operation, re-run it with the same settings, and add the f
151151

152152
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:
153153

154-
. Create an {astra_db} {db-serverless} database:
154+
. Create an {astra-db} {db-serverless} database:
155155
+
156156
[source,shell]
157157
----

in-progress/managing.adoc

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
// Writer's note: This page is no longer published but there is still content that should be retained and reformatted for Astra CLI 1.0.
2-
= {astra_db} commands
2+
= {astra-db} commands
33
:embedding-provider-name: NVIDIA
44
:embedding-provider-name-api: nvidia
55
:embedding-provider-model-name-api: NV-Embed-QA
66

7-
Use the {product} to manage your {astra_db} deployments.
7+
Use the {product} to manage your {astra-db} databases.
88

99
[TIP]
1010
====
@@ -14,7 +14,7 @@ You can use `**DATABASE_NAME**` instead of `**DATABASE_ID**` in all `astra db` c
1414
== Create a database
1515

1616
The {product} can create {db-serverless} and {db-serverless-vector} databases with on-demand (non-PCU) capacity only.
17-
It cannot create {db-classic} databases; however, you can use the {product} to <<get-database-details,get information>> about your existing {db-classic} databases.
17+
It cannot create {product-short} {db-classic} (Classic) databases; however, you can use the {product} to <<get-database-details,get information>> about your existing {db-classic} databases.
1818

1919
If your organization requires that new databases to belong to a xref:astra-db-serverless:administration:provisioned-capacity-units.adoc[PCU group], you must xref:astra-db-serverless:databases:create-database.adoc[use the {astra-ui} or {devops-api} to create databases] because the {product} doesn't support PCU group assignment with database creation.
2020

@@ -171,7 +171,7 @@ astra db create **DATABASE_NAME** \
171171

172172
//TODO: Confirm that this no longer applies.
173173
////
174-
The database ID, not the database name, ensures uniqueness within your {astra_db} organization.
174+
The database ID, not the database name, ensures uniqueness within your {product-short} organization.
175175
Consequently, if you issue the `astra db create` command multiple times, you will create multiple database instances.
176176
To ensure that you don't create a database with the same name as another existing database, use the `--if-not-exist` option:
177177
@@ -183,7 +183,7 @@ astra db create demo -r us-east-1 -k keyspace1 --if-not-exist
183183

184184
== Manage keyspaces
185185

186-
{astra_db} databases store data in <<manage-collections,collections>> and <<manage-tables,tables>>, which exist inside keyspaces.
186+
{astra-db} databases store data in <<manage-collections,collections>> and <<manage-tables,tables>>, which exist inside keyspaces.
187187
Each database must have at least one keyspace, and you can create more as needed.
188188

189189
Use the `astra db create-keyspace` command to create a new keyspace in a database:
@@ -282,7 +282,7 @@ The database enters *Maintenance* status while it deletes the keyspace along wit
282282

283283
include::ROOT:partial$async-option-active.adoc[]
284284

285-
If you delete the default keyspace, {astra_db} automatically selects another keyspace to be the default keyspace.
285+
If you delete the default keyspace, {astra-db} automatically selects another keyspace to be the default keyspace.
286286

287287
=== `db create-keyspace` options
288288

@@ -501,7 +501,7 @@ astra db create-collection 58747660-464b-4085-bef2-c3f3e5401e3d \
501501
Use an {product-short}-hosted provider::
502502
+
503503
--
504-
To automatically generate embeddings with xref:astra-db-serverless:databases:embedding-generation.adoc[{astra_db} vectorize], add an embedding provider integration to your collection.
504+
To automatically generate embeddings with xref:astra-db-serverless:databases:embedding-generation.adoc[{product-short} vectorize], add an embedding provider integration to your collection.
505505
Embedding provider integrations are either {product-short}-hosted or external.
506506
507507
This option uses an {product-short}-hosted provider:
@@ -552,10 +552,10 @@ astra db create-collection 58747660-464b-4085-bef2-c3f3e5401e3d \
552552
Use an external provider::
553553
+
554554
--
555-
To automatically generate embeddings with xref:astra-db-serverless:databases:embedding-generation.adoc[{astra_db} vectorize], add an embedding provider integration to your collection.
555+
To automatically generate embeddings with xref:astra-db-serverless:databases:embedding-generation.adoc[{product-short} vectorize], add an embedding provider integration to your collection.
556556
Embedding provider integrations are either {product-short}-hosted or external.
557557
558-
To use an external embedding provider, you must add an xref:astra-db-serverless:databases:embedding-generation.adoc#supported-embedding-providers[embedding provider integration] to your {astra_db} organization, and then you can select that embedding provider when you create a collection:
558+
To use an external embedding provider, you must add an xref:astra-db-serverless:databases:embedding-generation.adoc#supported-embedding-providers[embedding provider integration] to your {product-short} organization, and then you can select that embedding provider when you create a collection:
559559
560560
[source,bash,subs="+quotes"]
561561
----
@@ -1920,7 +1920,7 @@ OPTIONS
19201920
----
19211921
====
19221922

1923-
== Get a list of available {astra_db} regions
1923+
== Get a list of available {astra-db} regions
19241924

19251925
Use the `astra db list-regions-serverless` command to get a list of available regions that support {db-serverless} databases:
19261926

@@ -1936,7 +1936,7 @@ Use the `astra db list-regions-vector` command to get a list of available cloud
19361936
astra db list-regions-vector
19371937
----
19381938

1939-
Use the `astra db list-regions-classic` command to get a list of available cloud provider regions that support {db-classic} databases:
1939+
Use the `astra db list-regions-classic` command to get a list of available cloud provider regions that support {product-short} {db-classic} (Classic) databases:
19401940

19411941
[source,bash]
19421942
----
@@ -2057,6 +2057,11 @@ OPTIONS
20572057

20582058
=== `db list-regions-classic` options
20592059

2060+
[TIP]
2061+
====
2062+
`classic` refers to {product-short} {db-classic} databases, which were previously known as {astra-db} Classic databases.
2063+
====
2064+
20602065
.Expand to see all `db list-regions-classic` options
20612066
[%collapsible]
20622067
====
@@ -3462,7 +3467,7 @@ OPTIONS
34623467

34633468
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:
34643469

3465-
. Create an {astra_db} {db-serverless} database:
3470+
. Create an {astra-db} {db-serverless} database:
34663471
+
34673472
[source,bash]
34683473
----
@@ -3680,11 +3685,11 @@ This command unloads row data from the `cities_by_country` table, and stores it
36803685

36813686
[IMPORTANT]
36823687
====
3683-
CDC for {astra_db} incurs billed charges based on your {astra_stream} usage.
3684-
For more information, see https://www.ibm.com/docs/en/astra-streaming?topic=astra-streaming-annual-price-plans[{astra_stream} pricing].
3688+
CDC for {astra-db} incurs billed charges based on your {astra-stream} usage.
3689+
For more information, see https://www.ibm.com/docs/en/astra-streaming?topic=astra-streaming-annual-price-plans[{astra-stream} pricing].
36853690
====
36863691

3687-
CDC for {astra_db} automatically captures changes in real time, de-duplicates the changes, and then streams the clean set of changed data into xref:astra-streaming:ROOT:index.adoc[{astra_stream}] where it can be processed by client applications or sent to downstream systems.
3692+
CDC for {astra-db} automatically captures changes in real time, de-duplicates the changes, and then streams the clean set of changed data into xref:astra-streaming:ROOT:index.adoc[{astra-stream}] where it can be processed by client applications or sent to downstream systems.
36883693

36893694
Use the `astra db create-cdc` command to create a CDC connection for a table in a {db-serverless} database:
36903695

@@ -3927,7 +3932,7 @@ OPTIONS
39273932

39283933
The following end-to-end example shows how to use the {product} to create a CDC connection for a table in a {db-serverless} database:
39293934

3930-
. Create an {astra_db} {db-serverless} database:
3935+
. Create an {astra-db} {db-serverless} database:
39313936
+
39323937
[source,bash]
39333938
----
@@ -3952,7 +3957,7 @@ get CLoud provider
39523957
----
39533958
====
39543959

3955-
. Create an {astra_stream} tenant in the same region as your database:
3960+
. Create an {astra-stream} tenant in the same region as your database:
39563961
+
39573962
[source,bash]
39583963
----
@@ -4203,7 +4208,7 @@ astra db download-scb **DATABASE_ID** -f **DESTINATION_FILE**.zip
42034208

42044209
== Create environment variables
42054210

4206-
When developing applications with {astra_db} APIs, you will notice common values that are frequently reused, such as application tokens, database API endpoints, database IDs, and keyspace names.
4211+
When developing applications with {astra-db} APIs, you will notice common values that are frequently reused, such as application tokens, database API endpoints, database IDs, and keyspace names.
42074212
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.
42084213

42094214
The {product} can automatically generate a set of relevant variables for a database that you can use in your applications.

in-progress/quickstart-databases.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -292,5 +292,5 @@ See xref:databases:create-database.adoc#get-db-id[Get your database ID].
292292

293293
== Find embedding providers
294294

295-
Get information about embedding providers for xref:databases:embedding-generation.adoc[{astra-db} vectorize], including supported providers, models, dimensions, and other configuration parameters.
295+
Get information about embedding providers for xref:databases:embedding-generation.adoc[{product-short} vectorize], including supported providers, models, dimensions, and other configuration parameters.
296296

modules/ROOT/pages/install.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
= Install the {product}
22
:navtitle: Install the CLI
33
:page-aliases: ROOT:installation.adoc, ROOT:getting-started.adoc
4-
:description: {product} makes it easier to integrate {product-short} into your applications and workflows by letting you perform common platform tasks for {astra_db} and {astra_stream} from the command line.
4+
:description: {product} makes it easier to integrate {product-short} into your applications and workflows by letting you perform common platform tasks for {astra-db} and {astra-stream} from the command line.
55

6-
Install the {product} to create and manage {astra_db} databases and {astra_stream} tenants from the command line.
6+
Install the {product} to create and manage {astra-db} databases and {astra-stream} tenants from the command line.
77

88
== Supported platforms
99

modules/quickstarts/pages/cqlsh.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= Issue CQL commands with cqlsh 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} database.
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.
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)