Skip to content

Commit 1804f4a

Browse files
aimurphyaimurphy
authored
DOC-5236 (#26)
* remove unused includes * eliminate use of tags * audit admonitions pt 1 * clean notes and tabs on installation.adoc * remove NOTE from managing.adoc * remove 1-line partials and region lists * apply product-short attribute * update scb attributes * peer review
1 parent 5ab79b2 commit 1804f4a

11 files changed

Lines changed: 216 additions & 398 deletions

‎docs-src/astra-cli-core/antora.yml‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,26 @@ nav:
88

99
asciidoc:
1010
attributes:
11+
# General attributes
12+
company: 'DataStax'
13+
support-url: 'https://support.datastax.com'
14+
# Other product attributes
15+
cass-reg: 'Apache Cassandra(R)'
16+
cass: 'Apache Cassandra'
17+
cass-short: 'Cassandra'
18+
# Astra DB attributes
19+
astra-db: 'Astra DB'
1120
product: 'Astra CLI'
21+
product-short: 'Astra'
1222
product-version: '0.6'
13-
astra: 'Astra'
1423
db-serverless: 'Serverless (Non-Vector)'
1524
db-serverless-vector: 'Serverless (Vector)'
1625
db-classic: 'Classic'
17-
astra-api: 'Data API'
18-
url-astra: 'https://astra.datastax.com'
19-
link-astra-portal: '{url-astra}[{astra_ui}^]'
20-
py-client-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$python-client/astrapy'
21-
ts-client-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$typescript-client'
22-
java-client-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$java-client'
23-
cass-short: 'Cassandra'
24-
scb-long: Secure Connect Bundle (SCB)
25-
scb-cap: Secure Connect Bundle
26-
scb: SCB
26+
devops-api: 'DevOps API'
27+
astra-stream: 'Astra Streaming'
28+
astra-ui: 'Astra Portal'
29+
astra-url: 'https://astra.datastax.com'
30+
astra-ui-link: '{astra-url}[{astra-ui}^]'
31+
scb: 'Secure Connect Bundle (SCB)'
32+
scb-short: 'SCB'
33+
scb-brief: 'Secure Connect Bundle'

‎docs-src/astra-cli-core/modules/ROOT/pages/administration.adoc‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
= Manage your Astra organization with the {product}
2-
:navtitle: Manage Astra administration
1+
= Manage your {product-short} organization with the {product}
2+
:navtitle: Manage {product-short} administration
33

4-
Use the {product} to manage your Astra organization.
4+
Use the {product} to manage your {product-short} organization.
55

66
== Get organization details
77

8-
Use the `astra org` command to get information about the current Astra organization:
8+
Use the `astra org` command to get information about the current {product-short} organization:
99

1010
[source,bash]
1111
----
@@ -49,7 +49,7 @@ SYNOPSIS
4949

5050
== List users
5151

52-
Use the `astra user list` command to list all users in your Astra organization:
52+
Use the `astra user list` command to list all users in your {product-short} organization:
5353

5454
[source,bash]
5555
----
@@ -113,7 +113,7 @@ OPTIONS
113113

114114
== Add a user
115115

116-
Use the `astra user invite` command to invite a new user to your Astra organization:
116+
Use the `astra user invite` command to invite a new user to your {product-short} organization:
117117

118118
[source,bash,subs="+quotes"]
119119
----
@@ -218,7 +218,7 @@ astra user invite alice@example.com -r "Organization Administrator"
218218

219219
== Get user details
220220

221-
Use the `astra user get` or `astra user describe` command to get information about a specific user in your Astra organization:
221+
Use the `astra user get` or `astra user describe` command to get information about a specific user in your {product-short} organization:
222222

223223
[source,bash,subs="+quotes"]
224224
----
@@ -358,7 +358,7 @@ The user can still access their personal {astra_db} account, if they have access
358358
If your organization uses SSO, make sure that you also remove the user from your IdP, if necessary.
359359
====
360360

361-
Use the `astra user delete` command to remove a user or revoke their invitation from your Astra organization:
361+
Use the `astra user delete` command to remove a user or revoke their invitation from your {product-short} organization:
362362

363363
[source,bash,subs="+quotes"]
364364
----
@@ -427,7 +427,7 @@ OPTIONS
427427
[#list-roles]
428428
== List roles
429429

430-
Use the `astra role list` command to list all xref:astra-db-serverless:administration:manage-database-access.adoc#default-roles[default roles] and xref:astra-db-serverless:administration:manage-database-access.adoc#custom-roles[custom roles] in your Astra organization:
430+
Use the `astra role list` command to list all xref:astra-db-serverless:administration:manage-database-access.adoc#default-roles[default roles] and xref:astra-db-serverless:administration:manage-database-access.adoc#custom-roles[custom roles] in your {product-short} organization:
431431

432432
[source,bash]
433433
----
@@ -505,7 +505,7 @@ OPTIONS
505505

506506
== Get role details
507507

508-
Use the `astra role get` or `astra role describe` command to get information about a specific role in your Astra organization:
508+
Use the `astra role get` or `astra role describe` command to get information about a specific role in your {product-short} organization:
509509

510510
[source,bash,subs="+quotes"]
511511
----
@@ -680,7 +680,7 @@ OPTIONS
680680
[#list-tokens]
681681
== Get a list of tokens
682682

683-
Use the `astra token list` command to list all of the application tokens in your Astra organization:
683+
Use the `astra token list` command to list all of the application tokens in your {product-short} organization:
684684

685685
[source,bash]
686686
----
@@ -741,7 +741,7 @@ OPTIONS
741741

742742
== Create an application token
743743

744-
Use the `astra token create` command to create a new application token in your Astra organization:
744+
Use the `astra token create` command to create a new application token in your {product-short} organization:
745745

746746
[source,bash,subs="+quotes"]
747747
----
@@ -875,7 +875,7 @@ OPTIONS
875875
Application tokens never expire.
876876
====
877877

878-
Use the `astra token delete` or `astra token revoke` command to delete an application token from your Astra organization:
878+
Use the `astra token delete` or `astra token revoke` command to delete an application token from your {product-short} organization:
879879

880880
[source,bash,subs="+quotes"]
881881
----

‎docs-src/astra-cli-core/modules/ROOT/pages/astra-streaming-cli.adoc‎

Lines changed: 18 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ https://api.astra.datastax.com/v2/streaming/tenants/my-streaming-tenant
2424

2525
Running `astra streaming create` without any options deploys the tenant in the default cloud provider (`aws`), region (`useast2`), plan (`free`) and namespace (`default`).
2626

27-
[NOTE]
28-
======
27+
[TIP]
28+
====
29+
Tenant names must be unique
30+
2931
All tenant names in {astra_stream} must be unique.
3032
If the tenant name is already in use, the command fails with with the following error message:
3133
@@ -40,6 +42,7 @@ You can use the `--if-not-exist` option to only create the tenant if it doesn't
4042
----
4143
astra streaming create **TENANT_NAME** --if-not-exist
4244
----
45+
====
4346

4447
.Result
4548
[%collapsible]
@@ -67,7 +70,6 @@ https://api.astra.datastax.com/v2/streaming/tenants/my-streaming-tenant
6770
[OK] Tenant 'my-streaming-tenant' exists.
6871
----
6972
====
70-
======
7173

7274
=== `streaming create` options
7375

@@ -541,7 +543,7 @@ OPTIONS
541543

542544
== Get a list of available {astra_stream} regions
543545

544-
Use the `astra streaming list-regions` command to get a list of available cloud provider regions that support {astra_stream}:
546+
Use the `astra streaming list-regions` command to get a list of available regions that support {astra_stream}:
545547

546548
[source,bash]
547549
----
@@ -550,34 +552,19 @@ astra streaming list-regions
550552

551553
.Result
552554
[%collapsible]
553-
======
554-
[source,console]
555+
====
556+
The result is a table with `Cloud Provider`, `Region`, and `Full Name` columns.
557+
`Full Name` can be empty or contain the region's name and location (city, state, or country).
558+
559+
[source,console,subs="+quotes"]
555560
----
556561
+-----------------+---------------------+-------------------------------+
557562
| Cloud Provider | Region | Full Name |
558563
+-----------------+---------------------+-------------------------------+
559-
| aws | apsouth1 | |
560-
| aws | apsoutheast1 | |
561-
| aws | apsoutheast2 | |
562-
| aws | eucentral1 | |
563-
| aws | euwest1 | |
564-
| aws | useast1 | |
565-
| aws | useast2 | |
566-
| aws | uswest2 | |
567-
| azure | australiaeast | |
568-
| azure | eastus | |
569-
| azure | westeurope | |
570-
| azure | westus2 | |
571-
| gcp | australiase1 | |
572-
| gcp | europewest1 | |
573-
| gcp | uscentral1 | |
574-
| gcp | useast1 | |
575-
| gcp | useast4 | |
564+
| **PROVIDER** | **REGION** | **NAME** |
576565
+-----------------+---------------------+-------------------------------+
577566
----
578-
579-
include::ROOT:partial$regions-change-admonition.adoc[]
580-
======
567+
====
581568

582569
=== `streaming list-regions` options
583570

@@ -1080,13 +1067,16 @@ ASTRA_STREAMING_WEBSOCKET_URL="wss://pulsar-aws-useast2.streaming.datastax.com:8
10801067

10811068
[WARNING]
10821069
====
1083-
The generated `.env` files contains sensitive information, including the application token that the {product} uses to connect to Astra.
1070+
The generated `.env` files contains sensitive information, including the application token that the {product} uses to connect to {product-short}.
10841071
10851072
The {scb} contains sensitive information that establishes a connection to your database, including key pairs and certificates.
10861073
====
10871074

10881075
=== `streaming create-dotenv` options
10891076

1077+
The directory must already exist before you run the `streaming create-dotenv` command.
1078+
If the directory doesn't exist, the command fails with the error `INVALID_ARGUMENT: Destination folder has not been found`.
1079+
10901080
.Expand to see all `streaming create-dotenv` options
10911081
[%collapsible]
10921082
====
@@ -1152,10 +1142,4 @@ astra streaming create-dotenv **TENANT_NAME** -d ~/tmp
11521142
----
11531143
[OK] File '/Users/USERNAME/tmp/.env' has been created/amended
11541144
----
1155-
====
1156-
1157-
[NOTE]
1158-
====
1159-
The directory must already exist before you run the command.
1160-
If the directory doesn't exist, the {product} will report the following error: `INVALID_ARGUMENT: Destination folder has not been found`.
1161-
====
1145+
====

0 commit comments

Comments
 (0)