Update nav format

eric-schneider · eric-schneider · commit 616046405b71 · 2024-07-22T15:21:34.000-07:00
diff --git a/antora.yml b/antora.yml
@@ -4,11 +4,11 @@ version: ~
 start_page: 'index.adoc'
 
 nav:
-  - modules/getting-started/nav.adoc
-  - modules/developing/nav.adoc
-  - modules/operations/nav.adoc
-  - modules/ROOT/nav.adoc
-  - modules/apis/nav.adoc
+- modules/getting-started/nav.adoc
+- modules/developing/nav.adoc
+- modules/operations/nav.adoc
+- modules/ROOT/nav.adoc
+- modules/apis/nav.adoc
 
 asciidoc:
   attributes:
diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc
@@ -1,13 +1,16 @@
-* Guides and Examples
-** xref:astream-faq.adoc[FAQs]
-** Manage permissions
-*** xref:astream-org-permissions.adoc[]
-*** xref:astream-custom-roles.adoc[]
-** Pulsar subscriptions
-*** xref:astream-subscriptions.adoc[Pulsar subscriptions overview]
-*** xref:astream-subscriptions-exclusive.adoc[Exclusive]
-*** xref:astream-subscriptions-shared.adoc[Shared]
-*** xref:astream-subscriptions-failover.adoc[Failover]
-*** xref:astream-subscriptions-keyshared.adoc[Key_shared]
+.Guides and examples
+* xref:astream-faq.adoc[]
+* Manage permissions
+** xref:astream-org-permissions.adoc[]
+** xref:astream-custom-roles.adoc[]
+* Pulsar subscriptions
+** xref:astream-subscriptions.adoc[]
+** xref:astream-subscriptions-exclusive.adoc[]
+** xref:astream-subscriptions-shared.adoc[]
+** xref:astream-subscriptions-failover.adoc[]
+** xref:astream-subscriptions-keyshared.adoc[]
+
+//
+
 * xref:streaming-learning:pulsar-io:connectors/index.adoc[IO Connectors]
-* xref:operations:astream-release-notes.adoc[Changelog]
+* xref:operations:astream-release-notes.adoc[Changelog]
diff --git a/modules/ROOT/pages/astream-faq.adoc b/modules/ROOT/pages/astream-faq.adoc
@@ -1,4 +1,5 @@
 = {product_name} FAQs
+:navtitle: FAQs
 :page-tag: astra-streaming,dev,admin,planner,plan,pulsar
 
 == How do I sign up for the {product_name}?
diff --git a/modules/ROOT/pages/astream-subscriptions-exclusive.adoc b/modules/ROOT/pages/astream-subscriptions-exclusive.adoc
@@ -1,4 +1,5 @@
 = Exclusive subscriptions in Pulsar
+:navtitle: Exclusive
 :page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar
 
 *Subscriptions* in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +
diff --git a/modules/ROOT/pages/astream-subscriptions-failover.adoc b/modules/ROOT/pages/astream-subscriptions-failover.adoc
@@ -1,4 +1,5 @@
 = Failover subscriptions in Pulsar
+:navtitle: Failover
 :page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar
 
 *Subscriptions* in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +
diff --git a/modules/ROOT/pages/astream-subscriptions-keyshared.adoc b/modules/ROOT/pages/astream-subscriptions-keyshared.adoc
@@ -1,4 +1,5 @@
 = Key_Shared subscriptions in Pulsar
+:navtitle: Key_Shared
 :page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar
 
 *Subscriptions* in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +
diff --git a/modules/ROOT/pages/astream-subscriptions-shared.adoc b/modules/ROOT/pages/astream-subscriptions-shared.adoc
@@ -1,4 +1,5 @@
 = Shared subscriptions in Pulsar
+:navtitle: Shared
 :page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar
 
 *Subscriptions* in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +
diff --git a/modules/ROOT/pages/astream-subscriptions.adoc b/modules/ROOT/pages/astream-subscriptions.adoc
@@ -1,4 +1,5 @@
 = Subscriptions in Pulsar
+:navtitle: Pulsar subscriptions overview
 :page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar
 
 *Subscriptions* in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +
diff --git a/modules/ROOT/pages/nav.adoc b/modules/ROOT/pages/nav.adoc
diff --git a/modules/apis/nav.adoc b/modules/apis/nav.adoc
@@ -1,3 +1,3 @@
-* API references
-** xref:index.adoc[API references overview]
-** xref:api-operations.adoc[API operations]
+.API references
+* xref:index.adoc[]
+* xref:api-operations.adoc[]
diff --git a/modules/apis/pages/api-operations.adoc b/modules/apis/pages/api-operations.adoc
@@ -1,4 +1,5 @@
 = API Operations
+:navtitle: API operations
 
 This Astra Streaming workbook is a comprehensive guide that provides detailed examples and  practices for managing the Astra Streaming platform using the DevOps APIs.  It provides details on the most commonly used APIs for managing Astra Streaming and Pulsar instances.  These details include required parameters and the expected output from the API.  The workbook is designed to fill the gap between detailed API reference docs and HowTo guides.  The result is to help customers in operating and managing Astra Streaming and provide guidance on how to use DevOps API to automate many common tasks.
 
@@ -173,7 +174,7 @@ With file input::
 --
 [source,bash]
 ----
-curl --fail --location --request POST 'https://api.astra.datastax.com/v2/streaming/tenants' --header 'Content-Type: application/json' --header "Authorization: Bearer $ASTRA_ORG_TOKEN" --data "@mytenant-config.json" | python3 -mjson.tool 
+curl --fail --location --request POST 'https://api.astra.datastax.com/v2/streaming/tenants' --header 'Content-Type: application/json' --header "Authorization: Bearer $ASTRA_ORG_TOKEN" --data "@mytenant-config.json" | python3 -mjson.tool
 ----
 --
 
diff --git a/modules/apis/pages/index.adoc b/modules/apis/pages/index.adoc
@@ -1,4 +1,5 @@
 = API References
+:navtitle: API references overview
 :description: Astra provides APIs to manage both DB and Streaming instances
 :page-tag: astra-streaming,dev,develop,pulsar
 
diff --git a/modules/developing/nav.adoc b/modules/developing/nav.adoc
@@ -1,20 +1,20 @@
-* Developing
-** xref:gpt-schema-translator.adoc[]
-** xref:configure-pulsar-env.adoc[]
-** xref:using-curl.adoc[]
-** xref:astra-cli.adoc[]
-** xref:astream-functions.adoc[]
-** xref:astream-kafka.adoc[]
-** xref:astream-rabbit.adoc[]
-** Producing and consuming messages
-*** xref:produce-consume-astra-portal.adoc[Astra Portal]
-*** xref:produce-consume-pulsar-client.adoc[Pulsar Cli]
-*** Client applications
-**** xref:clients/index.adoc[Pulsar clients]
-**** xref:clients/java-produce-consume.adoc[Java]
-**** xref:clients/python-produce-consume.adoc[Python]
-**** xref:clients/csharp-produce-consume.adoc[C#]
-**** xref:clients/golang-produce-consume.adoc[Golang]
-**** xref:clients/nodejs-produce-consume.adoc[Node.js]
-**** xref:clients/spring-produce-consume.adoc[Spring]
-** xref:astream-cdc.adoc[]
+.Developing
+* xref:gpt-schema-translator.adoc[]
+* xref:configure-pulsar-env.adoc[]
+* xref:using-curl.adoc[]
+* xref:astra-cli.adoc[]
+* xref:astream-functions.adoc[]
+* xref:astream-kafka.adoc[]
+* xref:astream-rabbit.adoc[]
+* Producing and consuming messages
+** xref:produce-consume-astra-portal.adoc[]
+** xref:produce-consume-pulsar-client.adoc[]
+** Client applications
+*** xref:clients/index.adoc[]
+*** xref:clients/java-produce-consume.adoc[]
+*** xref:clients/python-produce-consume.adoc[]
+*** xref:clients/csharp-produce-consume.adoc[]
+*** xref:clients/golang-produce-consume.adoc[]
+*** xref:clients/nodejs-produce-consume.adoc[]
+*** xref:clients/spring-produce-consume.adoc[]
+* xref:astream-cdc.adoc[]
diff --git a/modules/developing/pages/clients/csharp-produce-consume.adoc b/modules/developing/pages/clients/csharp-produce-consume.adoc
@@ -1,5 +1,6 @@
 = Producing and consuming messages using the C# pulsar client on Astra Streaming
-:description: This is a guide to create a simple producer and consumer using Pulsar's c# client.
+:navtitle: C#
+:description: This is a guide to create a simple producer and consumer using Pulsar's C# client.
 
 == Prerequisites
 
diff --git a/modules/developing/pages/clients/golang-produce-consume.adoc b/modules/developing/pages/clients/golang-produce-consume.adoc
@@ -1,4 +1,5 @@
 = Producing and consuming messages using the Golang pulsar client on Astra Streaming
+:navtitle: Golang
 :description: This is a guide to create a simple producer and consumer using Pulsar's golang client.
 :page-tag: astra-streaming,dev,develop,pulsar,go
 
diff --git a/modules/developing/pages/clients/index.adoc b/modules/developing/pages/clients/index.adoc
@@ -1,4 +1,5 @@
-= Producing and consuming messages on Astra Streaming with pulsar clients
+= Producing and consuming messages on Astra Streaming with Pulsar clients
+:navtitle: Pulsar clients
 :description: Use any of the Pulsar Clients to interact with your Astra Streaming topics.
 
 {product_name} is powered by http://pulsar.apache.org/[Apache Pulsar].
diff --git a/modules/developing/pages/clients/java-produce-consume.adoc b/modules/developing/pages/clients/java-produce-consume.adoc
@@ -1,4 +1,5 @@
 = Producing and consuming messages using the Java pulsar client with Astra Streaming
+:navtitle: Java
 :description: This is a guide to create a simple producer and consumer using Pulsar's java client.
 :page-tag: astra-streaming,dev,develop,pulsar,java
 
diff --git a/modules/developing/pages/clients/nodejs-produce-consume.adoc b/modules/developing/pages/clients/nodejs-produce-consume.adoc
@@ -1,4 +1,5 @@
 = Producing and consuming messages using the Node.js Pulsar client on Astra Streaming
+:navtitle: Node.js
 :description: This is a guide to create a simple producer and consumer using Pulsar's Node.js client.
 :page-tag: astra-streaming,connect,dev,develop,nodejs,pulsar
 
diff --git a/modules/developing/pages/clients/python-produce-consume.adoc b/modules/developing/pages/clients/python-produce-consume.adoc
@@ -1,4 +1,5 @@
 = Producing and consuming messages using the python pulsar client on Astra Streaming
+:navtitle: Python
 :description: This is a guide to create a simple producer and consumer using Pulsar's python client.
 :page-tag: astra-streaming,dev,develop,python,pulsar
 
diff --git a/modules/developing/pages/clients/spring-produce-consume.adoc b/modules/developing/pages/clients/spring-produce-consume.adoc
@@ -1,4 +1,5 @@
 = Producing and consuming messages using the Java pulsar client with Astra Streaming and Spring
+:navtitle: Spring
 :description: This is a guide to create a simple producer and consumer using Pulsar's java client with Spring.
 :page-tag: astra-streaming,dev,develop,pulsar,java
 
diff --git a/modules/developing/pages/produce-consume-astra-portal.adoc b/modules/developing/pages/produce-consume-astra-portal.adoc
@@ -1,4 +1,5 @@
 = Producing and consuming messages using the Astra Portal
+:navtitle: Astra Portal
 :description: Use this guide to create and consume a topic message using the Astra Streaming Portal.
 
 This guide assumes you have completed the xref:getting-started:index.adoc[Astra Streaming quickstart].
diff --git a/modules/developing/pages/produce-consume-pulsar-client.adoc b/modules/developing/pages/produce-consume-pulsar-client.adoc
@@ -1,4 +1,5 @@
 = Producing and consuming messages with the Pulsar Client on Astra Streaming
+:navtitle: Pulsar CLI
 :description: Use this guide to interact with your Astra Streaming tenant via the pulsar-client cli.
 
 This guide assumes you have completed the xref:getting-started:index.adoc[Astra Streaming quickstart] and you have xref:developing:configure-pulsar-env.adoc[set up your Pulsar binaries] to work with your tenant.
diff --git a/modules/getting-started/nav.adoc b/modules/getting-started/nav.adoc
@@ -1 +1 @@
-* xref:index.adoc[Get started]
+* xref:index.adoc[]
diff --git a/modules/operations/nav.adoc b/modules/operations/nav.adoc
@@ -1,18 +1,18 @@
-* Operations
-** xref:astream-georeplication.adoc[]
-** xref:astream-limits.adoc[]
-** xref:astream-pricing.adoc[]
-** xref:astream-regions.adoc[]
-** Monitoring streaming tentants
-*** xref:monitoring/index.adoc[Monitoring overview]
-*** xref:astream-scrape-metrics.adoc[]
-*** xref:monitoring/integration.adoc[]
-*** xref:monitoring/new-relic.adoc[]
-*** Grafana dashboards
-**** xref:monitoring/metrics.adoc[]
-**** xref:monitoring/overview-dashboard.adoc[]
-**** xref:monitoring/namespace-dashboard.adoc[]
-**** xref:monitoring/topic-dashboard.adoc[]
-** xref:astream-token-gen.adoc[]
-** xref:private-connectivity.adoc[]
-** xref:onboarding-faq.adoc[]
+.Operations
+* xref:astream-georeplication.adoc[]
+* xref:astream-limits.adoc[]
+* xref:astream-pricing.adoc[]
+* xref:astream-regions.adoc[]
+* Monitoring streaming tenants
+** xref:monitoring/index.adoc[]
+** xref:astream-scrape-metrics.adoc[]
+** xref:monitoring/integration.adoc[]
+** xref:monitoring/new-relic.adoc[]
+** Grafana dashboards
+*** xref:monitoring/metrics.adoc[]
+*** xref:monitoring/overview-dashboard.adoc[]
+*** xref:monitoring/namespace-dashboard.adoc[]
+*** xref:monitoring/topic-dashboard.adoc[]
+* xref:astream-token-gen.adoc[]
+* xref:private-connectivity.adoc[]
+* xref:onboarding-faq.adoc[]
diff --git a/modules/operations/pages/monitoring/index.adoc b/modules/operations/pages/monitoring/index.adoc
@@ -1,4 +1,5 @@
 = Monitoring Streaming Tenants
+:navtitle: Monitoring overview
 
 Because Astra Streaming is a software-as-a-service product, not all Apache Pulsar metrics (https://pulsar.apache.org/docs/reference-metrics/[Pulsar Metrics Reference]) are exposed for external integration purposes. At a high level, Astra Streaming only exposes metrics that are related to namespaces. Other metrics that are not directly namespace related are not exposed externally, such as the Bookkeeper ledger and journal metrics and Zookeeper metrics.
 
diff --git a/modules/ragstack/nav.adoc b/modules/ragstack/nav.adoc
@@ -1,3 +1,3 @@
-* RAGStack
-** xref:index.adoc[]
-** xref:quickstart.adoc[]
+.RAGStack
+* xref:index.adoc[]
+* xref:quickstart.adoc[]

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= {product_name} FAQs`
	`2`	`+:navtitle: FAQs`
`2`	`3`	`:page-tag: astra-streaming,dev,admin,planner,plan,pulsar`
`3`	`4`
`4`	`5`	`== How do I sign up for the {product_name}?`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= Exclusive subscriptions in Pulsar`
	`2`	`+:navtitle: Exclusive`
`2`	`3`	`:page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar`
`3`	`4`
`4`	`5`	`Subscriptions in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= Failover subscriptions in Pulsar`
	`2`	`+:navtitle: Failover`
`2`	`3`	`:page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar`
`3`	`4`
`4`	`5`	`Subscriptions in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= Key_Shared subscriptions in Pulsar`
	`2`	`+:navtitle: Key_Shared`
`2`	`3`	`:page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar`
`3`	`4`
`4`	`5`	`Subscriptions in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= Shared subscriptions in Pulsar`
	`2`	`+:navtitle: Shared`
`2`	`3`	`:page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar`
`3`	`4`
`4`	`5`	`Subscriptions in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= Subscriptions in Pulsar`
	`2`	`+:navtitle: Pulsar subscriptions overview`
`2`	`3`	`:page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar`
`3`	`4`
`4`	`5`	`Subscriptions in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +`