Skip to content

feat: add KafScale onboarding examples (E10-E50) and developer guide#130

Merged
novatechflow merged 2 commits intoKafScale:mainfrom
kamir:onboarding-examples
Mar 3, 2026
Merged

feat: add KafScale onboarding examples (E10-E50) and developer guide#130
novatechflow merged 2 commits intoKafScale:mainfrom
kamir:onboarding-examples

Conversation

@kamir
Copy link
Collaborator

@kamir kamir commented Mar 3, 2026

Summary

  • Add progressive onboarding tutorial collection (E10–E50) for new KafScale users
  • Include 8-chapter developer guide (101_kafscale-dev-guide) covering all examples
  • All files include Apache 2.0 license headers; build artifacts excluded

Examples added

Example Framework Description
E10 Pure Java Kafka client produce/consume basics, KafScale-specific config
E20 Spring Boot REST API with order service, profiles, Docker deployment
E30 Apache Flink Stateful streaming word count, 3 deployment modes
E40 Apache Spark Structured streaming word count, DataFrame API
E50 JavaScript/Node.js Web UI, agent integration, KafkaJS client
101 Markdown 8-chapter developer guide (intro → Spark)

Verification

  • python3 hack/check_license_headers.py passes
  • No build artifacts tracked (target/, node_modules/, .class, .jar)
  • git diff --stat upstream/main shows only examples/ files (70 files)
  • No LFS files (E60–E72) included

Test plan

  • Verify each Java example builds: cd examples/E{10,20,30,40}_*/ && mvn clean package
  • Verify E50 installs: cd examples/E50_JS-kafscale-demo/ && npm install
  • Review 101 guide chapters for accuracy and completeness
  • Confirm no regression in existing CI checks

🤖 Generated with Claude Code

Progressive tutorial collection for new KafScale users:
- E10: Pure Java Kafka client (produce/consume basics)
- E20: Spring Boot REST API with KafScale backend
- E30: Apache Flink streaming word count (3 deployment modes)
- E40: Apache Spark structured streaming word count
- E50: JavaScript/Node.js client with web UI and agent integration
- 101: 8-chapter developer guide covering all examples

All files include Apache 2.0 license headers.
Build artifacts (target/, node_modules/, dependency-reduced-pom.xml,
package-lock.json) excluded from tracking.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
kamir added a commit to kamir/kafscale that referenced this pull request Mar 3, 2026
Single-page guide covering the E10–E50 progressive tutorial path
and 101 developer guide. Adds entry to docs index page.

Companion to PR KafScale#130 (code examples on main).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@kamir kamir mentioned this pull request Mar 3, 2026
8 tasks
- Replace innerHTML with DOM construction to prevent XSS (app.js)
- Validate lane names against allowlist to prevent property injection
- Sanitize log output to prevent log injection from server messages
- Remove unused variables (app, response)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@novatechflow novatechflow merged commit a5b684a into KafScale:main Mar 3, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants