Minor DocOps optimizations

Author: eric-schneider

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

@@ -1,11 +1,7 @@
-name: astra-cli
-title: Astra CLI
+name: 'astra-cli'
+title: 'Astra CLI'
 version: '0.2'
-start_page: index.adoc
+start_page: 'index.adoc'
 
 nav:
 - modules/ROOT/nav.adoc
-
-asciidoc:
-  attributes:
-    astra_cli: 'Astra CLI'

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

@@ -20,7 +20,7 @@ Any user with the **Organization Administrator** role may use {astra_cli} comman
 
 Get started with the links below.
 
-[subs="macros,attributes"]
+[subs="macros,attributes+"]
 ++++
 
 <div class="grid lg:grid-rows-1 lg:grid-cols-3 gap-6 mt-6">

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

@@ -1,6 +1,6 @@
 = Managing {astra_db} databases with {astra_cli}
 
-Use the following {astra_cli} commands to manage your {astra_db} databases. 
+Use the following {astra_cli} commands to manage your {astra_db} databases.
 From the command line in a Terminal, the supported tasks are:
 
 * <<List databases>>
@@ -19,7 +19,7 @@ From the command line in a Terminal, the supported tasks are:
 
 == List databases
 
-To get the list of active databases in your {astra_db} organization, use the command `astra db list`. 
+To get the list of active databases in your {astra_db} organization, use the command `astra db list`.
 
 [TIP]
 ====
@@ -90,7 +90,7 @@ Sample result::
  test,7677a789-bd57-455d-ab2c-999999999999,eu-central-1,ACTIVE
  demo,071d7059-d55b-4cdb-90c6-999999999999,us-east-1,ACTIVE
  ac201,48c7178c-58cb-4657-b3d2-999999999999,us-east-1,ACTIVE
----- 
+----
 --
 ====
 
@@ -147,7 +147,7 @@ Sample result::
        "Name" : "ac201"
      } ]
    }
----- 
+----
 --
 ====
 
@@ -257,7 +257,7 @@ Sample result::
  | aws            | us-east-2           | US East (Ohio)                |
  | aws            | us-west-2           | US West (Oregon)              |
  +----------------+---------------------+-------------------------------+
----- 
+----
 --
 ====
 
@@ -307,7 +307,7 @@ Sample result::
  | aws            | us-east-2           | US East (Ohio)                |
  | aws            | us-west-2           | US West (Oregon)              |
  +----------------+---------------------+-------------------------------+
----- 
+----
 --
 ====
 
@@ -350,7 +350,7 @@ Sample result::
  +--------------------------------------+-----------------------------+---------------------+
  | b665658a-ae6a-4f30-a740-999999999999 | [email protected]  | active              |
  +--------------------------------------+-----------------------------+---------------------+
----- 
+----
 --
 ====
 
@@ -379,7 +379,7 @@ Sample result::
  | 825bd3d3-82ae-404b-9aad-999999999999 | [email protected]   | invited             |
  | b665658a-ae6a-4f30-a740-999999999999 | [email protected]  | active              |
  +--------------------------------------+-----------------------------+---------------------+
----- 
+----
 --
 ====
 
@@ -408,7 +408,7 @@ astra role get "Database Administrator"
 
 == Get database details
 
-To get general information or details on an entity, use the command `astra db get <db-name>`. 
+To get general information or details on an entity, use the command `astra db get <db-name>`.
 The output includes specific information about the list of keyspaces available and the different regions.
 
 [TIP]
@@ -455,7 +455,7 @@ Sample result::
  |                        |                                         |
  | Regions                | [0] us-east-1                           |
  +------------------------+-----------------------------------------+
----- 
+----
 --
 ====
 
@@ -464,10 +464,10 @@ To get a special property, add the option `--key` and its type.
 
 Multiple key types are available: `id`, `status`, `cloud`, `keyspace`, `keyspaces`, `region`, `regions`.
 
-Notice that the output is raw. 
+Notice that the output is raw.
 
-This command is expected to be used in scripts. 
-Example:  
+This command is expected to be used in scripts.
+Example:
 
 [tabs]
 ====
@@ -486,11 +486,11 @@ Sample result::
 [source,csv]
 ----
  dde308f5-a8b0-474d-afd6-999999999999
----- 
+----
 --
 ====
 
-To get the database status in a human readable result, use the `astra db status` command. 
+To get the database status in a human readable result, use the `astra db status` command.
 Example:
 
 [tabs]
@@ -510,14 +510,14 @@ Sample result::
 [source,csv]
 ----
  [ INFO ] - Database 'demo' has status 'ACTIVE'
----- 
+----
 --
 ====
 
 
 == Delete a database
 
-To delete an {astra_db} database, use the command `astra db delete <db-name>`. 
+To delete an {astra_db} database, use the command `astra db delete <db-name>`.
 Example:
 
 [source,bash]
@@ -550,7 +550,7 @@ astra help db list-keyspaces
 === Create a new keyspace
 
 To add a keyspace named `ks2` to an existing database named `demo`, use the following command.
-The option `--if-not-exist` is optional but could help you provide idempotent scripts. 
+The option `--if-not-exist` is optional but could help you provide idempotent scripts.
 Example:
 
 [source,bash]
@@ -577,7 +577,7 @@ The purpose of {astra_cli} is to integrate with `cqlsh` and to perform the integ
 
 === Interactive mode
 
-If no options are provided, by default you'll enter `cqlsh` interactive mode. 
+If no options are provided, by default you'll enter `cqlsh` interactive mode.
 Example:
 
 [tabs]
@@ -602,14 +602,14 @@ Sample result::
  Use HELP for help.
  token@cqlsh>
 
----- 
+----
 --
 ====
 
 
 === Execute CQL
 
-To execute a CQL statement with `cqlsh` use the flag `-e`. 
+To execute a CQL statement with `cqlsh` use the flag `-e`.
 Example:
 
 [source,bash]
@@ -620,7 +620,7 @@ astra db cqlsh demo -e "describe keyspaces;"
 === Execute CQL files
 
 To execute CQL files with `cqlsh` use the flag `-f`.
-You could also use the CQL syntax SOURCE. 
+You could also use the CQL syntax SOURCE.
 Example:
 
 [source,bash]
@@ -667,7 +667,7 @@ astra db cqlsh demo -k demo
 
 Create the table in cqlsh:
 
-[source,cqlsh]
+[source,cql]
 ----
 CREATE TABLE cities_by_country ( country_name text, name text, id int, state_id text, state_code text, state_name text, country_id text, country_code text, latitude double, longitude double, wikiDataId text, PRIMARY KEY ((country_name), name) );
 
@@ -719,14 +719,14 @@ Sample result::
  148,266 |      0 |  8,361 | 663.86 | 767.56 | 817.89 |   30.91
  Operation LOAD_20221123-182343-074618 completed successfully in 17 seconds.
  Last processed positions can be found in positions.txt
----- 
+----
 --
 ====
 
 
 === Count table row data
 
-Check than the data has been imported with cqlsh. 
+Check than the data has been imported with cqlsh.
 Example:
 
 [tabs]
@@ -769,7 +769,7 @@ country_name | name                | country_code | country_id | id   | latitude
   Bangladesh |            Bājitpur |           BD |         19 | 8472 | 24.21623 |  90.95002 |         13 |      771 |      Dhaka District |       null
   Bangladesh |            Chandpur |           BD |         19 | 8474 |    23.25 |  90.83333 |          B |      803 | Chittagong Division |       null
   Bangladesh |    Chapai Nababganj |           BD |         19 | 8475 | 24.68333 |     88.25 |         54 |      813 |   Rajshahi District |       null
----- 
+----
 --
 ====
 
@@ -799,14 +799,14 @@ Sample result::
  Operation directory: /Users/awesome.user/Downloads/logs/COUNT_20221123-182833-197954
    total | failed | rows/s |  p50ms |  p99ms | p999ms
  134,574 |      0 | 43,307 | 315.71 | 457.18 | 457.18
----- 
+----
 --
 ====
 
 
 === Unload data
 
-You can also unload data. 
+You can also unload data.
 Example:
 
 [tabs]
@@ -832,7 +832,7 @@ Sample result::
    total | failed | rows/s |  p50ms |    p99ms |   p999ms
  134,574 |      0 | 14,103 | 927.51 | 1,853.88 | 1,853.88
  Operation UNLOAD_20221123-183054-208353 completed successfully in 9 seconds.
----- 
+----
 --
 ====
 
@@ -845,9 +845,9 @@ Use the `astra db download-scb` command to download the different secure connect
 
 [source,bash]
 ----
-mkdir db-demo 
-cd db-demo 
-astra db download-scb demo 
+mkdir db-demo
+cd db-demo
+astra db download-scb demo
 ls
 ----
 
@@ -874,7 +874,7 @@ astra db download-scb demo -f /tmp/demo.zip
 
 When working with Astra DB, it's handy to generate a set of relevant environment variables such as database name, database region, API call URLs, and so on.
 
-This {astra_cli} command creates an `.env` file based on your environment. 
+This {astra_cli} command creates an `.env` file based on your environment.
 Example:
 
 [tabs]
@@ -908,19 +908,19 @@ Sample result::
  ASTRA_ORG_ID="f9460f14-9879-...."
  ASTRA_ORG_NAME="awe..."
  ASTRA_ORG_TOKEN="AstraCS:QeUmROPLeNbd..."
----- 
+----
 --
 ====
 
 
 == Resume a hibernated database
 
-If you are using the {astra_db} Free plan, your database will be hibernated (made inactive) after 23 hours of inactivity. 
+If you are using the {astra_db} Free plan, your database will be hibernated (made inactive) after 23 hours of inactivity.
 (This behavior does not occur when you upgrade to a paid {astra_db} plan.)
 
 To wake up the database, you can use the `astra db resume` command.
 
-Assume you have a hibernating database. 
+Assume you have a hibernating database.
 Example:
 
 [tabs]
@@ -944,7 +944,7 @@ Sample result::
  +---------------------+--------------------------------------+---------------------+----------------+
  | mydatabase          | 643c6bb8-2336-4649-97d5-999999999999 | eu-central-1        | HIBERNATED     |
  +---------------------+--------------------------------------+---------------------+----------------+
----- 
+----
 --
 ====
 
@@ -971,7 +971,7 @@ Sample result::
  +---------------------+--------------------------------------+---------------------+----------------+
  | mydatabase          | 643c6bb8-2336-4649-97d5-999999999999 | eu-central-1        | RESUMING       |
  +---------------------+--------------------------------------+---------------------+----------------+
----- 
+----
 
 After some time:
 
@@ -982,7 +982,7 @@ After some time:
  +---------------------+--------------------------------------+---------------------+----------------+
  | mydatabase          | 643c6bb8-2336-4649-97d5-999999999999 | eu-central-1        | ACTIVE         |
  +---------------------+--------------------------------------+---------------------+----------------+
----- 
+----
 --
 ====
 
@@ -1011,7 +1011,7 @@ astra config create dev --token <token_of_org_2>
 
 === Use your section configuration
 
-You can use an organization configuration anytime by qualifying the `astra` command with the `--config <config_name>` option. 
+You can use an organization configuration anytime by qualifying the `astra` command with the `--config <config_name>` option.
 Example:
 
 [source,bash]

local-preview-playbook.yml

@@ -56,8 +56,20 @@ asciidoc:
     astra_db: 'Astra DB'
     astra_stream: 'Astra Streaming'
     astra_ui: 'Astra Portal'
+    astra_cli: 'Astra CLI'
+    astra-streaming-examples-repo: 'https://raw.githubusercontent.com/datastax/astra-streaming-examples/master'
+    luna-streaming-examples-repo: 'https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main'
     support_url: 'https://support.datastax.com'
     glossary-url: 'https://docs.datastax.com/en/glossary/docs/index.html#'
+    emoji-tada: "🎉"
+    emoji-rocket: "🚀"
+    emoji-smile: "&#128512"
+    dse: 'DataStax Enterprise (DSE)'
+    cassandra: 'Apache Cassandra®'
+    classic: 'classic'
+    classic_cap: 'Classic'
+    serverless: 'serverless'
+    serverless_cap: 'Serverless'
     # Antora Atlas
     primary-site-url: https://docs.datastax.com/en
     primary-site-manifest-url: https://docs.datastax.com/en/site-manifest.json