Merge branch 'release/v0.5.6' into main

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

@@ -11,9 +11,11 @@
 (?i)proxying
 (?i)realtime
 (?i)subnet(s)?
+(?i)quickstart(s)?
 (?i)todo
 (?i)truststore
 (?i)yaml
+(?i)yaml
 acks
 Aiven
 Aklivity
@@ -37,6 +39,7 @@ declaratively
 docsearch
 etag
 fanout
+fas
 fontawesome
 gitea
 grpc
@@ -70,8 +73,6 @@ overprovisioned
 prometheus
 proto
 protobuf
-Quickstart
-quickstarts
 really 
 Redpanda
 repo(s)?

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

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

.github/workflows/build-deploy-docs.yml

@@ -54,10 +54,13 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          for row in $(jq -rc '.[]' deploy-versions.json); do
-            key=$(echo ${row} | jq -r '.key');
-            tag=$(echo ${row} | jq -r '.tag');
-            
+          for row in $(jq -rc '.[] | @base64' deploy-versions.json); do
+            _jq() {
+              echo ${row} | base64 --decode | jq -r ${1}
+            }
+            key=$(echo $(_jq '.key'));
+            tag=$(echo $(_jq '.tag'));
+
             git clone --depth 1 -b "$tag" $RepoUrl "$BuildDir/$key"
 
             cp versions.json "$BuildDir/$key/src/.vuepress/versions.json";
@@ -69,8 +72,11 @@ jobs:
           NODE_OPTIONS: "--max_old_space_size=4096"
         run: |
           wrkdir=$(pwd);
-          for row in $(jq -rc '.[]' deploy-versions.json); do
-            key=$(echo ${row} | jq -r '.key');
+          for row in $(jq -rc '.[] | @base64' deploy-versions.json); do
+            _jq() {
+              echo ${row} | base64 --decode | jq -r ${1}
+            }
+            key=$(echo $(_jq '.key'));
 
             export DIST_DIR="$wrkdir/$DistDir";
             export SITE_VERSION_KEY="$key";

.markdownlint.yaml

@@ -12,3 +12,5 @@ header-style:
   style: consistent
 link-fragments: false
 no-hard-tabs: false
+ul-style:
+  style: dash

.vale.ini

@@ -7,6 +7,9 @@ Vocab = Base
 
 Packages = write-good
 
+[*.{ts}]
+BasedOnStyles = Vale, docs
+
 [*.{md,mdx}]
 BasedOnStyles = Vale, write-good, docs
 

deploy-versions.json

@@ -1 +1 @@
-[{"text":"latest","key":"latest","tag":"v0.5.5"}]
+[{"text":"Latest","icon":"fas fa-home","key":"latest","tag":"v0.5.6"}]

package.json

@@ -1,6 +1,6 @@
 {
   "name": "zilla-docs",
-  "version": "0.5.5",
+  "version": "0.5.6",
   "description": "The official documentation for the aklivity/zilla open-source project",
   "keywords": [],
   "author": "aklivity.io",

src/.vuepress/navbar/en.ts

@@ -5,13 +5,14 @@ import versions from "../versions.json" assert { type: "json" };
 const versionLinks = <{ text: string; link: string }[]>(
   versions.map((o) => ({
     text: o.text,
+    icon: o.icon,
     link: o.key ? `${hostnameSEO}/${siteBase}/${o.key}` : o.link,
   }))
 );
 
 export const enNavbar = navbar([
-  { text: "Get Started", icon: "play", link: "/tutorials/quickstart/kafka-proxies.md" },
-  { text: "Reference", icon: "book", link: "/reference/config/overview.md" },
-  { text: "version", icon: "list-ol", children: versionLinks },
-  { text: "aklivity", icon: "globe", link: "https://www.aklivity.io/" },
+  { text: "Get Started", icon: "fas fa-play", link: "/tutorials/quickstart/kafka-proxies.md" },
+  { text: "Reference", icon: "fas fa-book", link: "/reference/config/overview.md" },
+  { text: "version", icon: "fas fa-list-ol", children: versionLinks },
+  { text: "aklivity", icon: "fas fa-globe", link: "https://www.aklivity.io/" },
 ]);

src/.vuepress/sidebar/en.ts

@@ -219,24 +219,25 @@ export const enSidebar = sidebar({
           ],
         },
         {
-          text: "Amazon MSK Pubic Proxy",
+          text: "Amazon MSK Public Proxy",
           collapsible: true,
-          icon: "plus",
+          icon: "aky-zilla-plus",
           prefix: "how-tos/amazon-msk/",
           link: "how-tos/amazon-msk/public-proxy.md",
           children: [
             {
               text: "Overview",
+              icon: "aky-zilla-plus",
               link: "public-proxy.md",
             },
             "development.md",
             "production.md",
-            "production-mutual-trust.md",
+            "production-mutual-tls.md",
           ],
         },
         {
           text: "Amazon MSK Private Proxy",
-          icon: "plus",
+          icon: "aky-zilla-plus",
           link: "how-tos/amazon-msk/private-proxy.md",
         },
       ],

src/.vuepress/styles/index.scss

@@ -5,8 +5,13 @@ html[data-theme=dark] #app {
     --border-color: #0e5c49;
     --tab-nav-bg-color: var(--code-tabs-nav-bg-color);
     --tab-nav-hover-color: var(--code-tabs-nav-hover-color);
-    --tab-bg-color: var(--code-bg-color);
+    --tab-bg-color: #161b25;
     --tab-nav-text-color: var(--code-tabs-nav-text-color);
+    --note-bg-color: var(--bg-color);
+    --info-bg-color: var(--bg-color);
+    --tip-bg-color: #001c00;
+    --warning-bg-color: #1d1500;
+    --danger-bg-color: #340c0d;
     .vp-footer img.logo {
         content: url("/assets/footer-logo-white.png");
     }
@@ -16,10 +21,10 @@ html[data-theme=dark] #app {
 html[data-theme=light] #app {
     --code-highlight-line-color: #79d4bd;
     --border-color: #55877a;
-    --code-bg-color: #f6f8fa;
+    --code-bg-color: #e6e8ea;
     --tab-nav-bg-color: var(--code-tabs-nav-bg-color);
     --tab-nav-hover-color: var(--code-tabs-nav-hover-color);
-    --tab-bg-color: var(--code-bg-color);
+    --tab-bg-color: #e6f0f9;
     --tab-nav-text-color: var(--code-tabs-nav-text-color);
     .vp-footer img.logo {
         content: url("/assets/footer-logo.png");
@@ -47,6 +52,10 @@ table.no-head {
     }
 }
 
+// remove extra list margins
+ul li p {
+    margin: 0px;
+}
 
 // Header
 // full width search
@@ -77,7 +86,14 @@ table.no-head {
     span.icon {
         order: 2;
         margin-left: auto;
-        color: var(--theme-color);
+    }
+}
+.vp-catalog-title {
+    display: flex !important;
+    flex-direction: row;
+    span.icon {
+        order: 2;
+        margin-left: .2em;
     }
 }
 // Zilla plus container styles
@@ -126,3 +142,14 @@ table.no-head {
         display: none;
     }
 }
+
+
+// === ICONS ===
+.aky-zilla-plus {
+    &::after {
+        content: url('data:image/svg+xml,<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 94 94"><defs><style>.cls-1{fill:url(%23linear-gradient);}</style><linearGradient id="linear-gradient" x1="0.5" y1="47.5" x2="94.5" y2="47.5" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="%235a7cd9"/><stop offset="0.28" stop-color="%234799c9"/><stop offset="0.76" stop-color="%2329c4b0"/><stop offset="1" stop-color="%231ed5a7"/></linearGradient></defs><title>zilla-plus-icon</title><g id="Rounded_Plus" data-name="Rounded Plus"><path class="cls-1" d="M94.5,35.83V59.17a4.23,4.23,0,0,1-4.23,4.23H63.4V90.27a4.23,4.23,0,0,1-4.23,4.23H35.83a4.23,4.23,0,0,1-4.23-4.23V63.4H4.73A4.23,4.23,0,0,1,.5,59.17V35.83A4.23,4.23,0,0,1,4.73,31.6H31.6V4.73A4.23,4.23,0,0,1,35.83.5H59.17A4.23,4.23,0,0,1,63.4,4.73V31.6H90.27A4.23,4.23,0,0,1,94.5,35.83Z" transform="translate(-0.5 -0.5)"/></g></svg>');
+        display: inline-block;
+        height: .8em;
+        width: .8em;
+    }
+}

src/.vuepress/theme.ts

@@ -7,7 +7,7 @@ export default hopeTheme({
   hostname: hostnameSEO,
   logo: "/logo.png",
   logoDark: "/logo-dark.png",
-  iconAssets: "fontawesome-with-brands",
+  iconAssets: ["fontawesome-with-brands"],
   favicon: "favicon.ico",
 
   repo: "aklivity/zilla",

src/.vuepress/versions.json

@@ -1,5 +1,5 @@
 [
-    { "text": "Roadmap", "icon": "bars-progress", "link": "https://github.com/orgs/aklivity/projects/4" },
-    { "text": "Changelog", "icon": "tag", "link": "https://github.com/aklivity/zilla/releases" },
-    { "text": "@next", "key": "next" }
+    { "text": "Roadmap", "icon": "fas fa-bars-progress", "link": "https://github.com/orgs/aklivity/projects/4" },
+    { "text": "Changelog", "icon": "fas fa-tag", "link": "https://github.com/aklivity/zilla/releases" },
+    { "text": "@next", "icon": "fas fa-circle-right", "key": "next" }
 ]

src/README.md

@@ -1,6 +1,6 @@
 ---
 home: true
-icon: home
+icon: fas fa-home
 title: Home
 heroImage: /zilla-rings.webp
 heroImageDark: /zilla-rings.webp
@@ -17,22 +17,22 @@ actions:
 features:
 
   - title: Get Started
-    icon: play
+    icon: fas fa-play
     details: Install Zilla, connect it to your Kafka Cluster, and define your first API endpoints.
     link: /how-tos/install.html
 
   - title: Todo App Example
-    icon: diagram-project
+    icon: fas fa-diagram-project
     details: Create a Todo application using a CQRS design pattern that's backed by Apache Kafka and Zilla.
     link: /tutorials/todo-app/build.html
 
   - title: Kafka Proxies
-    icon: arrows-left-right-to-line
+    icon: fas fa-arrows-left-right-to-line
     details: Define REST, SSE, gRPC and MQTT endpoints that map to Kafka topic streams.
     link: /concepts/kafka-proxies/rest-proxy.html
 
   - title: Reference
-    icon: book
+    icon: fas fa-book
     details: Learn about Zilla command and configuration properties.
     link: /reference/config/overview.html
 

src/concepts/config-intro.md

@@ -157,4 +157,4 @@ Each configured `metric` represents a stat Zilla collects and each configured `e
 
 Metrics are separated by protocol where the `stream` metrics relate to Zilla's internal message handler. The other protocols have common metrics you would expect to find.
 
-The configured exporters will determine how the collected metrics are exposed. By adding the [Prometheus](../reference/config/telemetry/exporter/exporter-prometheus.md) exporter Zilla will host the the `/metrics` endpoint that is needed to collect the prometheus formatted metrics.
+The configured exporters will determine how the collected metrics are exposed. By adding the [Prometheus](../reference/config/telemetry/exporter/exporter-prometheus.md) exporter Zilla will host the `/metrics` endpoint that is needed to collect the prometheus formatted metrics.

src/concepts/kafka-proxies/grpc-proxy.md

@@ -73,7 +73,7 @@ This maps the proto service method's request and response messages directly to K
 
 ### Message routing for RPC request and response types
 
-Let's look at some of the common service definitions and how Zilla can route their messages.
+Let's look at some common service definitions and how Zilla can route their messages.
 
 #### Simple RPC
 

src/concepts/kafka-proxies/mqtt-proxy.md

@@ -34,7 +34,7 @@ mqtt_kafka_proxy:
 
 The Zilla MQTT `server` supports the [MQTT v5.0 Specification].
 
-::: info Feature Coming Soon <HopeIcon icon="circle-right"/>
+::: info Feature Coming Soon <HopeIcon icon="fas fa-circle-right"/>
 [MQTT v3.1.1 Specification] support is currently on the [Zilla roadmap]. Star and watch the [Zilla repo] for new releases!
 :::
 
@@ -47,7 +47,7 @@ The Zilla MQTT `server` supports the [MQTT v5.0 Specification].
 
 The Zilla MQTT `server` supports the "At most once (QoS 0)" Quality of Service flag.
 
-::: info Feature Coming Soon <HopeIcon icon="circle-right"/>
+::: info Feature Coming Soon <HopeIcon icon="fas fa-circle-right"/>
 At least once (QoS 1) and Exactly once (QoS 2) delivery support is currently on the [Zilla roadmap]. Star and watch the [Zilla repo] for new releases!
 :::