Skip to content

Commit 883b62f

Browse files
committed
trailing-space
1 parent 1009a7b commit 883b62f

File tree

4 files changed

+52
-83
lines changed

4 files changed

+52
-83
lines changed

docs-src/astra-cli-core/modules/ROOT/pages/getting-started.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Read this topic to learn how to get started with {astra_cli}.
44

55
== Setup
66

7-
Before issuing CLI `astra` commands, initialize the configuration file `~/.astrarc`.
8-
Run the following command.
9-
You will be asked to provide your token, which begins with `AstraCS:\...`.
7+
Before issuing CLI `astra` commands, initialize the configuration file `~/.astrarc`.
8+
Run the following command.
9+
You will be asked to provide your token, which begins with `AstraCS:\...`.
1010
The token will be saved so that you're authorized to run the CLI commands.
1111

1212
[source,bash]
Lines changed: 23 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,61 @@
1-
= Astra CLI
1+
= {astra_cli} Landing Page
22
:page-layout: gcx-landing
33
:data-uri:
44

5-
== Getting started with {astra_cli}
5+
The DataStax Astra Command-Line Interface ({astra_cli}) is a set of commands used to create and manage Astra resources.
6+
{astra_cli} is available across Astra services and is designed to get you working quickly with {astra_db} and {astra_stream}, with an emphasis on automation.
67

7-
++++
8-
<div class="landing-row">
9-
++++
8+
{astra_cli} makes it possible to submit commands instead of *or in addition to* using {astra_ui} and DataStax API calls.
109

11-
[sidebar.landing-card]
12-
.Create your first thing
13-
****
14-
--
15-
You can do amazing things with {astra_cli}.
10+
{astra_cli} features are for operators, Site Reliability Engineers (SREs), and developers who want the option of using commands when working with {astra_db} databases and {astra_stream} tenants.
11+
The tools should be complementary and not restrictive, so choose what tool works best for you.
1612

17-
* Create a thing.
18-
* Create a more advanced thing.
19-
--
20-
[.landing-card-body-icon]
21-
image::what-is-astra-db.svg[icon description,40]
22-
****
13+
{astra_cli} is free.
2314

24-
++++
25-
</div>
26-
++++
15+
Any user with the **Organization Administrator** role may use {astra_cli} commands with:
16+
17+
* {astra_db} Serverless databases
18+
* {astra_db} Classic databases
19+
* {astra_stream} tenants
20+
21+
Get started with the links below.
2722

2823
++++
2924
<div class="landing-row">
3025
++++
3126

3227
[sidebar.landing-card]
33-
.Another thing
28+
.Install and get started
3429
****
3530
--
36-
More things to do with {astra_cli}.
31+
* xref:installation.adoc[Install {astra_cli}]
32+
* xref:getting-started.adoc[Get started]
3733
--
3834
[.landing-card-body-icon]
3935
image::create-db-now.svg[icon description,40]
4036
****
4137

4238
[sidebar.landing-card]
43-
.Another thing
39+
.Manage {astra_db}
4440
****
4541
--
46-
More things to do with {astra_cli}.
42+
* xref:managing.adoc[]
43+
*
4744
--
4845
[.landing-card-body-icon]
4946
image::what-is-astra-streaming.svg[icon description,40]
5047
****
5148

5249
[sidebar.landing-card]
53-
.Another thing
50+
.Manage {astra_stream}
5451
****
5552
--
56-
More things to do with {astra_cli}.
53+
* xref:astra-streaming-cli.adoc[]
5754
--
5855
[.landing-card-body-icon]
5956
image::what-is-stargate-api.svg[icon description,40]
6057
****
6158

6259
++++
6360
</div>
64-
++++
65-
66-
++++
67-
<div class="landing-row">
68-
++++
69-
70-
[sidebar.landing-card]
71-
.Another thing
72-
****
73-
--
74-
More things to do with {astra_cli}.
75-
--
76-
[.landing-card-body-icon]
77-
image::what-is-k8ssandra.svg[icon description,40]
78-
****
79-
80-
[sidebar.landing-card]
81-
.Another thing
82-
****
83-
--
84-
More things to do with {astra_cli}.
85-
--
86-
[.landing-card-body-icon]
87-
image::what-is-datastax-luna.svg[Luna card icon,40]
88-
****
89-
90-
++++
91-
</div>
92-
++++
61+
++++

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ The GitHub repo for {astra_cli} is https://github.com/datastax/astra-cli[here^].
66

77
* For information about the latest release, see https://github.com/datastax/astra-cli/releases[this page].
88
9-
* If installed previously, run `astra --version` to find your installed version and see if you need to update.
9+
* If installed previously, run `astra --version` to find your installed version and see if you need to update.
1010
1111
== Install {astra_cli} on macOS
1212

1313
You can install via Homebrew or manually.
1414

1515
=== Using Homebrew
1616

17-
Homebrew is the easiest way to manage your {astra_cli} install.
18-
Homebrew provides convenient ways to install, update, and uninstall.
19-
If you don't have Homebrew available on your system, install https://brew.sh/[Homebrew^] before continuing.
17+
Homebrew is the easiest way to manage your {astra_cli} install.
18+
Homebrew provides convenient ways to install, update, and uninstall.
19+
If you don't have Homebrew available on your system, install https://brew.sh/[Homebrew^] before continuing.
2020

2121
You can install {astra_cli} on macOS by updating your brew repository information, and then running the install command:
2222

@@ -25,7 +25,7 @@ You can install {astra_cli} on macOS by updating your brew repository informatio
2525
brew install datastax/astra-cli/astra-cli
2626
----
2727

28-
The Homebrew formula of {astra_cli} installs a completion file named `astra` in the Homebrew-managed completions directory.
28+
The Homebrew formula of {astra_cli} installs a completion file named `astra` in the Homebrew-managed completions directory.
2929
By default, the location is `/usr/local/etc/bash_completion.d/`.
3030

3131
To enable completion, please follow Homebrew's instructions https://docs.brew.sh/Shell-Completion[here^].

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

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Use the following {astra_cli} commands to manage your {astra_db} databases. From
1818
1919
== Create a database
2020

21-
You can create an {astra_db} Serverless or {astra_db} Classic database with the `astra db create <db-name>` command.
21+
You can create an {astra_db} Serverless or {astra_db} Classic database with the `astra db create <db-name>` command.
2222

2323
Example:
2424

@@ -45,7 +45,7 @@ The database name itself does not ensure uniqueness within your {astra_db} organ
4545

4646
To change this behavior, use the `--if-not-exist` option.
4747

48-
Database creation is asynchronous operation.
48+
Database creation is asynchronous operation.
4949
Still during your CI/CD you want the database to be in an `ACTIVE` state before moving forward.
5050
Using the option `--wait` will trigger a blocking command until the database is ready.
5151

@@ -56,7 +56,7 @@ Example:
5656
astra db create demo -k ks2 --if-not-exist --wait
5757
----
5858

59-
If you are using the Free plan, after a period of inactivity (23 hours) the database moves to a `HIBERNATED` state.
59+
If you are using the Free plan, after a period of inactivity (23 hours) the database moves to a `HIBERNATED` state.
6060
You can use the `astra db resume <db-name>` command to reactivate the database.
6161

6262

@@ -96,7 +96,7 @@ Sample output:
9696
+---------------------+--------------------------------------+---------------------+----------------+
9797
----
9898

99-
You can also change the database list's output type with the `astra db list -o <type>` command, where <type> can be `csv` or `json`.
99+
You can also change the database list's output type with the `astra db list -o <type>` command, where <type> can be `csv` or `json`.
100100

101101
Examples:
102102

@@ -359,7 +359,7 @@ To get a special property, add the option `--key` and its type.
359359

360360
Multiple key types are available: `id`, `status`, `cloud`, `keyspace`, `keyspaces`, `region`, `regions`.
361361

362-
Notice that the output is raw. This command is expected to be used in scripts.
362+
Notice that the output is raw. This command is expected to be used in scripts.
363363

364364
Example:
365365

@@ -428,7 +428,7 @@ astra help db list-keyspaces
428428

429429
=== Create a new keyspace
430430

431-
To add a keyspace named `ks2` to an existing database named `demo`, use the following command.
431+
To add a keyspace named `ks2` to an existing database named `demo`, use the following command.
432432
The option `--if-not-exist` is optional but could help you provide idempotent scripts. Example:
433433

434434
[source,bash]
@@ -447,7 +447,7 @@ astra db list-keyspaces demo
447447

448448
== Use cqlsh
449449

450-
https://cassandra.apache.org/doc/latest/cassandra/tools/cqlsh.html[cqlsh^] is a standalone shell to work with Apache Cassandra&reg;.
450+
https://cassandra.apache.org/doc/latest/cassandra/tools/cqlsh.html[cqlsh^] is a standalone shell to work with Apache Cassandra&reg;.
451451
It is compliant with {astra_cli} but requires a few extra steps of configuration.
452452
The purpose of {astra_cli} is to integrate with `cqlsh` and do the integration for you.
453453

@@ -500,7 +500,7 @@ astra db cqlsh demo -f sample.cql
500500

501501
== Use DSBulk with {astra_cli} to load, unload, and count data
502502

503-
https://github.com/datastax/dsbulk[DataStax Bulk Loader^] (`dsbulk`) allows you to you load, unload, and count data from Cassandra-based database tables, such as those in Apache Cassandra, DataStax Enterprise, and Astra DB. {astra_cli} commands can invoke dsbulk.
503+
https://github.com/datastax/dsbulk[DataStax Bulk Loader^] (`dsbulk`) allows you to you load, unload, and count data from Cassandra-based database tables, such as those in Apache Cassandra, DataStax Enterprise, and Astra DB. {astra_cli} commands can invoke dsbulk.
504504

505505
As for `cqlsh`, {astra_cli} will *download*, *install*, *setup* and *wrap* the `dsbulk` command for you.
506506
All options are available.
@@ -552,14 +552,14 @@ quit
552552

553553
[source,bash]
554554
----
555-
astra db load demo \
556-
-url https://raw.githubusercontent.com/awesome-astra/docs/main/docs/assets/cities.csv \
557-
-k demo \
558-
-t cities_by_country \
555+
astra db load demo \
556+
-url https://raw.githubusercontent.com/awesome-astra/docs/main/docs/assets/cities.csv \
557+
-k demo \
558+
-t cities_by_country \
559559
--schema.allowMissingFields true
560-
----
560+
----
561561

562-
The first time you run the `astra db load` command, the message -- `DSBulk is starting please wait` -- may take a few seconds to appear because
562+
The first time you run the `astra db load` command, the message -- `DSBulk is starting please wait` -- may take a few seconds to appear because
563563
{astra_cli} is downloading `dsbulk` (if it wasn't downloaded previously).
564564

565565
Sample output:
@@ -724,7 +724,7 @@ Sample output:
724724

725725
== Resume a hibernated database
726726

727-
If you are using the {astra_db} Free plan, your database will be hibernated (inactive) after 23 hours of inactivity. (This behavior does not occur when you upgrade to a paid {astra_db} plan.)
727+
If you are using the {astra_db} Free plan, your database will be hibernated (inactive) after 23 hours of inactivity. (This behavior does not occur when you upgrade to a paid {astra_db} plan.)
728728

729729
To wake up the database, you can use the `astra db resume` command.
730730

@@ -740,9 +740,9 @@ Sample output:
740740
[source,bash]
741741
----
742742
+---------------------+--------------------------------------+---------------------+----------------+
743-
| Name | id | Default Region | Status |
744-
+---------------------+--------------------------------------+---------------------+----------------+
745-
| mydatabase | 643c6bb8-2336-4649-97d5-999999999999 | eu-central-1 | HIBERNATED |
743+
| Name | id | Default Region | Status |
744+
+---------------------+--------------------------------------+---------------------+----------------+
745+
| mydatabase | 643c6bb8-2336-4649-97d5-999999999999 | eu-central-1 | HIBERNATED |
746746
+---------------------+--------------------------------------+---------------------+----------------+
747747
----
748748

@@ -799,7 +799,7 @@ Here we'll name a configuration `dev` and identify the auth token of a separate
799799
astra config create dev --token <token_of_org_2>
800800
----
801801

802-
=== Use your section configuration
802+
=== Use your section configuration
803803

804804
You can use an organization configuration anytime by qualifying the `astra` command with the `--config <config_name>` option.
805805

@@ -828,7 +828,7 @@ astra config list
828828

829829
=== Delete a section
830830

831-
You can delete any organization.
831+
You can delete any organization.
832832
If you delete the selected organization, you will have to pick a new one.
833833

834834
Delete your config:
@@ -847,4 +847,4 @@ astra config list
847847

848848

849849
// == What's next?
850-
// See the CLI commands that you can use with DataStax {astra_stream} Pulsar tenants. ( TODO: link )
850+
// See the CLI commands that you can use with DataStax {astra_stream} Pulsar tenants. ( TODO: link )

0 commit comments

Comments
 (0)