From b4a0b2fcf03d1326e8525cec48a27ae9a91f1e5e Mon Sep 17 00:00:00 2001 From: 2pk03 Date: Sun, 18 Oct 2026 13:15:48 +0200 Subject: [PATCH] Docs: fix GitHub Pages build and add related links --- .github/workflows/docs.yml | 6 ++++++ .gitignore | 2 ++ docs/ARCHITECTURE.md | 2 ++ docs/DEPLOYMENT.md | 2 ++ docs/_config.yml | 6 +++++- docs/acceptance-protocol.md | 2 ++ docs/changelog.md | 2 +- docs/contributing.md | 2 +- docs/index.md | 28 +++++++++++++++++++--------- 9 files changed, 40 insertions(+), 12 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 2b41e40..0308497 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -29,6 +29,12 @@ jobs: - name: Setup Pages uses: actions/configure-pages@v6 + - name: Copy root docs into the Jekyll includes + run: | + mkdir -p docs/_includes + cp CHANGELOG.md docs/_includes/CHANGELOG.md + cp CONTRIBUTING.md docs/_includes/CONTRIBUTING.md + - name: Build with Jekyll uses: actions/jekyll-build-pages@v1 with: diff --git a/.gitignore b/.gitignore index 1b5403a..eb50b3f 100644 --- a/.gitignore +++ b/.gitignore @@ -32,3 +32,5 @@ analysis_report.html # GoReleaser dist/ +docs/_includes/CHANGELOG.md +docs/_includes/CONTRIBUTING.md diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 7ade579..d8c02ac 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -3,6 +3,7 @@ layout: default title: Architecture nav_order: 2 --- +{% raw %} # kshark Architecture Overview @@ -1212,3 +1213,4 @@ The layered testing approach ensures thorough validation of all connectivity com **Author:** kshark Development Team **Last Review:** 2026-03-26 **Next Review:** 2026-06-26 +{% endraw %} diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md index 9fcd456..6cddd10 100644 --- a/docs/DEPLOYMENT.md +++ b/docs/DEPLOYMENT.md @@ -3,6 +3,7 @@ layout: default title: Deployment nav_order: 4 --- +{% raw %} # kshark Deployment Guide @@ -1196,3 +1197,4 @@ This deployment guide provides comprehensive strategies for running kshark acros **Author:** kshark Development Team **Last Review:** 2025-11-13 **Next Review:** 2025-12-13 +{% endraw %} diff --git a/docs/_config.yml b/docs/_config.yml index e2bec38..4674be3 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -19,11 +19,13 @@ color_scheme: dark aux_links: "GitHub": - "https://github.com/scalytics/kshark-core" + "Scalytics open source": + - "https://www.scalytics.io/open-source" aux_links_new_tab: true # Footer -footer_content: "Copyright © 2024-2026 Scalytics GmbH. Licensed under Apache 2.0." +footer_content: "Copyright © 2024-2026 Scalytics GmbH. Licensed under Apache 2.0. Source on GitHub ยท Scalytics open source" # Back to top link back_to_top: true @@ -34,6 +36,8 @@ heading_anchors: true # Exclude from build exclude: + - Gemfile + - Gemfile.lock - .DS_Store - images/.DS_Store - SSRF_FIX_GUIDE.md diff --git a/docs/acceptance-protocol.md b/docs/acceptance-protocol.md index 423be51..361147a 100644 --- a/docs/acceptance-protocol.md +++ b/docs/acceptance-protocol.md @@ -3,6 +3,7 @@ layout: default title: Acceptance Protocol nav_order: 3.5 --- +{% raw %} # Post-Deployment Acceptance Protocol @@ -387,3 +388,4 @@ sha256sum report.json **Document Version:** 1.0 **Author:** kshark Development Team **Last Review:** 2026-03-27 +{% endraw %} diff --git a/docs/changelog.md b/docs/changelog.md index 50b01f8..23da413 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -4,5 +4,5 @@ title: Changelog nav_order: 9 --- -{% capture content %}{% include_relative ../CHANGELOG.md %}{% endcapture %} +{% capture content %}{% include CHANGELOG.md %}{% endcapture %} {{ content }} diff --git a/docs/contributing.md b/docs/contributing.md index 0654b74..1b7fe22 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -4,5 +4,5 @@ title: Contributing nav_order: 8 --- -{% capture content %}{% include_relative ../CONTRIBUTING.md %}{% endcapture %} +{% capture content %}{% include CONTRIBUTING.md %}{% endcapture %} {{ content }} diff --git a/docs/index.md b/docs/index.md index a471b18..e3c3ca6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,14 +17,14 @@ kshark acts like a network sniffer for Kafka, providing comprehensive health che | Document | Description | |----------|-------------| -| [Architecture]({% link ARCHITECTURE.md %}) | System architecture, components, and design patterns | -| [Features]({% link FEATURES.md %}) | Complete feature list and configuration reference | -| [Deployment]({% link DEPLOYMENT.md %}) | Docker, Kubernetes, and CI/CD deployment guides | -| [Security]({% link SECURITY.md %}) | Security audit, OWASP analysis, and hardening | -| [Release Notes]({% link RELEASE.md %}) | Release history and upgrade notes | -| [Connector Probe]({% link connector-probe.md %}) | Probing MongoDB, PostgreSQL, and DB2 targets | -| [Contributing]({% link contributing.md %}) | How to contribute to kshark | -| [Changelog]({% link changelog.md %}) | Detailed change log | +| [Architecture](ARCHITECTURE.md) | System architecture, components, and design patterns | +| [Features](FEATURES.md) | Complete feature list and configuration reference | +| [Deployment](DEPLOYMENT.md) | Docker, Kubernetes, and CI/CD deployment guides | +| [Security](SECURITY.md) | Security audit, OWASP analysis, and hardening | +| [Release Notes](RELEASE.md) | Release history and upgrade notes | +| [Connector Probe](connector-probe.md) | Probing MongoDB, PostgreSQL, and DB2 targets | +| [Contributing](contributing.md) | How to contribute to kshark | +| [Changelog](changelog.md) | Detailed change log | --- @@ -70,4 +70,14 @@ Diagnostics Traceroute, MTU discovery, network path analysis --- -Built with care for the Kafka community by [Scalytics](https://scalytics.io). +## Related projects + +kshark-core is also an example of how agents can use our tools to debug Kafka clusters: the JSON reports are built for scripts and AI agents to read. + +- [KafClaw](https://github.com/KafClaw/KafClaw): agent runtime in Go that connects AI agents through Kafka topics. It ships a `kafclaw kshark` command for Kafka diagnostics. +- [KafScale](https://kafscale.io/): Kafka-compatible streaming that keeps the log in S3. +- [kaf-mirror](https://github.com/scalytics/kaf-mirror): Kafka-to-Kafka replication with a web dashboard, REST API and CLI. + +Source code: [github.com/scalytics/kshark-core](https://github.com/scalytics/kshark-core). All Scalytics open source projects: [scalytics.io/open-source](https://www.scalytics.io/open-source). + +Built with care for the Kafka community by [Scalytics](https://www.scalytics.io).