fixes and updates (#148)

* spelling updates

* add spell check for sidebar

.config/vale/styles/Vocab/Base/accept.txt

@@ -1,96 +1,108 @@
+(?i)amqp
+(?i)arn(s)?
+(?i)artifacthub
+(?i)cleartext
 (?i)config
+(?i)confluentinc
 (?i)datacenter
+(?i)declaratively
+(?i)docsearch
+(?i)fanout
+(?i)fontawesome
+(?i)hostname
+(?i)http
 (?i)http
 (?i)https
+(?i)idempotency
 (?i)jwt
+(?i)kafkacat
+(?i)Kerberos
 (?i)keystore
+(?i)keytool
 (?i)middleware
+(?i)MSK
+(?i)namespace
 (?i)otlp
-(?i)pkcs12
+(?i)overprovisioned
+(?i)param(s)?
 (?i)prometheus
 (?i)proxying
+(?i)quickstart(s)?
 (?i)realtime
+(?i)sharding
+(?i)sse
 (?i)subnet(s)?
-(?i)quickstart(s)?
 (?i)todo
+(?i)trustcacerts
 (?i)truststore
-(?i)yaml
+(?i)unencrypted
+(?i)vuepress
 (?i)yaml
 acks
 Aiven
 Aklivity
 alpn
-amqp
-APIs
-artifacthub
+API(s)?
 async
 Bidi
 bitnami
 BOMs
 CA(s)?
-cleartext
-CLIs
+CLI(s)?
+Conduktor
 config
-confluentinc
+const
 CQRS
 cspell
 datagram
-declaratively
-docsearch
+enSidebar
+enum
 etag
-fanout
 fas
-fontawesome
 gitea
-grpc
+gRPC
 grpcurl
 GSSAPI
 heroImage
 heroText
-hostname
-http
-idempotency
 inet
 inkey
 jceks
 jq
 jwt
 Kafka
-kafkacat
 kcat
-Kerberos
-keytool
+leader_only
 lycheeverse
-mqtt
-MSK
+MQTT
 mvnw
 netcat
 npm
 OAUTHBEARER
 oneOf
 oneway
-overprovisioned
-prometheus
+pkcs12
 proto
 protobuf
 really
+receive_only
 Redpanda
+remote_server
 repo(s)?
-repos?
 routeguide
 sasl
+send_and_receive
+send_only
 shortTitle
 simlinks
-sse
-SSE
+stdout
 tcp
 tls
-Todo
-trustcacerts
+unix
 UUID(s)
 VPC(s)?
 VSCode
-vuepress
+WebSocket
 ws
 yaml
 Zilla

.config/vale/styles/Vocab/Base/reject.txt

@@ -1,2 +1,3 @@
-zilla[^\.\-]
 (?i)pubic
+bellow
+zilla[^\.\-]

.vale.ini

@@ -7,18 +7,14 @@ Vocab = Base
 
 Packages = write-good
 
-[*.{ts}]
+
+[*]
 BasedOnStyles = Vale, docs
 
 [*.{md,mdx}]
 BasedOnStyles = Vale, write-good, docs
 
-# Exclude ( ... ), ` ... `
-TokenIgnores = (\(+[^\n)]+\)+), \
-(\x60+[^\n\x60]+\x60+)
 
-# Exclude Code blocks
-BlockIgnores = (\x60\x60\x60+[^\x60\x60\x60]+\x60\x60\x60+)
 
 # TODO enable these and fix
 write-good.E-Prime=No

README.md

@@ -60,6 +60,10 @@ pnpm dev
   vale src
   ```
 
+  ```sh
+  vale --ignore-syntax src/.vuepress/sidebar/en.ts
+  ```
+
 - Link checking
 
   Install [Lychee](https://github.com/lycheeverse/lychee) then run:

src/concepts/config-intro.md

@@ -94,7 +94,7 @@ A corresponding `routes[].when` object with a matching `GET` method and `locatio
 
 ### Route Exit
 
-A route exists to direct a data stream to a desired exit point. This is the next binding needed to parse the the stream data. Bindings like [tcp](../reference/config/bindings/binding-tcp.md) are frequently used to route incoming streams to different exit points. Once a valid exit point is determined messages can flow to the correct `exit` destination.
+A route exists to direct a data stream to a desired exit point. This is the next binding needed to parse the stream data. Bindings like [tcp](../reference/config/bindings/binding-tcp.md) are frequently used to route incoming streams to different exit points. Once a valid exit point is determined messages can flow to the correct `exit` destination.
 
 ### Guarded Routes
 

src/how-tos/amazon-msk/secure-public-access/development.md

@@ -51,7 +51,7 @@ Check out the [Troubleshooting](../../../reference/troubleshooting/aws.md) guide
 
 An MSK cluster is needed for secure remote access via the internet. You can skip this step if you have already created an MSK cluster with equivalent configuration.
 
-Follow the [Create MSK Cluster](../../../reference/aws/create-msk-cluster.md) guide to setup the a new MSK cluster. We will use the bellow resource names to reference the AWS resources needed in this guide.
+Follow the [Create MSK Cluster](../../../reference/aws/create-msk-cluster.md) guide to setup the a new MSK cluster. We will use the below resource names to reference the AWS resources needed in this guide.
 
 - Cluster Name: `my-msk-cluster`
 - Access control methods: `Unauthenticated access`

src/how-tos/amazon-msk/secure-public-access/production-mutual-tls.md

@@ -66,7 +66,7 @@ Follow the [Create Certificate Authority (ACM)](../../../reference/aws/create-ce
 
 An MSK cluster is needed for secure remote access via the internet. You can skip this step if you have already created an MSK cluster with equivalent configuration.
 
-Follow the [Create MSK Cluster](../../../reference/aws/create-msk-cluster.md) guide to setup the a new MSK cluster. We will use the bellow resource names to reference the AWS resources needed in this guide.
+Follow the [Create MSK Cluster](../../../reference/aws/create-msk-cluster.md) guide to setup the a new MSK cluster. We will use the below resource names to reference the AWS resources needed in this guide.
 
 - Cluster Name: `my-msk-cluster`
 - Access control methods: `TLS client certificates`

src/how-tos/amazon-msk/secure-public-access/production.md

@@ -48,7 +48,7 @@ Check out the [Troubleshooting](../../../reference/troubleshooting/aws.md) guide
 
 An MSK cluster is needed for secure remote access via the internet. You can skip this step if you have already created an MSK cluster with equivalent configuration.
 
-Follow the [Create MSK Cluster](../../../reference/aws/create-msk-cluster.md) guide to setup the a new MSK cluster. We will use the bellow resource names to reference the AWS resources needed in this guide.
+Follow the [Create MSK Cluster](../../../reference/aws/create-msk-cluster.md) guide to setup the a new MSK cluster. We will use the below resource names to reference the AWS resources needed in this guide.
 
 - Cluster Name: `my-msk-cluster`
 - Access control methods: `SASL/SCRAM authentication`

src/how-tos/confluent-cloud/secure-public-access.md

@@ -45,7 +45,7 @@ Check out the [Troubleshooting](../../reference/troubleshooting/aws.md) guide if
 
 > This creates your Confluent Cloud cluster with AWS PrivateLink in preparation for secure access via the internet.
 
-An Confluent Cloud cluster deployed in AWS is needed for secure remote access via the internet. The [Confluent Cloud Quickstart](https://docs.confluent.io/cloud/current/get-started/index.html) will walk you through creating one. You can skip this step if you have already created an Confluent Cloud cluster with equivalent configuration. We will use the bellow resource names to reference the AWS resources needed in this guide.
+An Confluent Cloud cluster deployed in AWS is needed for secure remote access via the internet. The [Confluent Cloud Quickstart](https://docs.confluent.io/cloud/current/get-started/index.html) will walk you through creating one. You can skip this step if you have already created an Confluent Cloud cluster with equivalent configuration. We will use the below resource names to reference the AWS resources needed in this guide.
 
 - Cluster Name: `my-cc-cluster`
 - Cluster Type: `Enterprise`
@@ -57,13 +57,13 @@ Your Confluent Cloud Enterprise cluster will need a network connection. You will
   - Name: `zilla_plus_privatelink_service`
   - Save the `PrivateLink Service Id`
 
-Confluent Cloud Enterprise needs an AWS PrivateLink connection, for this we will [Create a VPC plus other VPC resources](https://docs.aws.amazon.com/vpc/latest/userguide/create-vpc.html#create-vpc-and-other-resources) with the bellow resource names.
+Confluent Cloud Enterprise needs an AWS PrivateLink connection, for this we will [Create a VPC plus other VPC resources](https://docs.aws.amazon.com/vpc/latest/userguide/create-vpc.html#create-vpc-and-other-resources) with the below resource names.
 
 - Name tag auto-generation: `my-cce-privatelink`
 - VPC endpoints: `none`
 - Create the VPC
 
-Now you will need to [Setup AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/create-interface-endpoint.html) with the bellow resource names.
+Now you will need to [Setup AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/create-interface-endpoint.html) with the below resource names.
 
 - Endpoint Name: `my-cce-privatelink-vpce`
 - Service Name: the `PrivateLink Service Id` value you saved earlier
@@ -75,7 +75,7 @@ Finish the `zilla_plus_privatelink_service` connection wizard with the `PrivateL
 
 ### Create the Route53 Hosted zone
 
-> This creates a Route53 Hosted zone to for a a generic DNS record can point to the Confluent Cloud with AWS PrivateLink used by the <ZillaPlus/> proxy.
+> This creates a Route53 Hosted zone to for a generic DNS record can point to the Confluent Cloud with AWS PrivateLink used by the <ZillaPlus/> proxy.
 
 Follow the [Create Hosted Zone](https://console.aws.amazon.com/route53/v2/hostedzones#CreateHostedZone) wizard with the following parameters and defaults.
 

src/how-tos/mqtt/mqtt.kafka.broker.md

@@ -113,7 +113,7 @@ You can check the [Kafka UI](http://localhost:8080/ui/clusters/local/all-topics)
 
 You can use your own Kafka or set up a local Kafka with [kafka.broker](https://github.com/aklivity/zilla-examples/releases/latest/download/kafka.broker.tar.gz) and follow the setup instructions in the `README.md`.
 
-Export these env variables or overwrite them with your remote Kafka if you skipped the local setup.
+Export these environment variables or overwrite them with your remote Kafka if you skipped the local setup.
 
 ```output:no-line-numbers
 export KAFKA_HOST=host.docker.internal
@@ -147,7 +147,7 @@ This will configure Zilla for accepting all of the `mqtt` traffic. The [tcp](../
 [More on binding-tcp](../../reference/config/bindings/binding-tcp.md)
 :::
 
-A [ws](../../reference/config/bindings/binding-tcp.md) binding is added to handle any MQTT over websocket using the `mqtt` protocol. The [mqtt](../../reference/config/bindings/binding-mqtt.md) binding then handles all of the MQTT message traffic that needs to go to Kafka.
+A [ws](../../reference/config/bindings/binding-tcp.md) binding is added to handle any MQTT over WebSocket using the `mqtt` protocol. The [mqtt](../../reference/config/bindings/binding-mqtt.md) binding then handles all of the MQTT message traffic that needs to go to Kafka.
 
 ```yaml{17,22}
 <!-- @include: ./mqtt_kafka_broker_zilla.yaml{21-44} -->
@@ -160,7 +160,7 @@ A [ws](../../reference/config/bindings/binding-tcp.md) binding is added to handl
 
 ### Service definition
 
-The service definition defines how the clients using this service will interact with Kafka through Zilla. The required set of Kafka topics are defined in the [options.topics](../../reference/config/bindings/binding-mqtt-kafka.md#options-topics) where Zilla manages any MQTT required features. A client identity can be determined by pulling the identifier out of the topic using th [options.clients](../../reference/config/bindings/binding-mqtt-kafka.md#options-clients) property.
+The service definition defines how the clients using this service will interact with Kafka through Zilla. The required set of Kafka topics are defined in the [options.topics](../../reference/config/bindings/binding-mqtt-kafka.md#options-topics) where Zilla manages any MQTT required features. A client identity can be determined by pulling the identifier out of the topic using the [options.clients](../../reference/config/bindings/binding-mqtt-kafka.md#options-clients) property.
 
 ```yaml{7-9,21}
 <!-- @include: ./mqtt_kafka_broker_zilla.yaml{46-68} -->