Skip to content

docs: add onboarding guide to gh-pages#131

Merged
novatechflow merged 1 commit intoKafScale:gh-pagesfrom
kamir:gh-pages-onboarding-guide
Mar 3, 2026
Merged

docs: add onboarding guide to gh-pages#131
novatechflow merged 1 commit intoKafScale:gh-pagesfrom
kamir:gh-pages-onboarding-guide

Conversation

@kamir
Copy link
Collaborator

@kamir kamir commented Mar 3, 2026

Summary

  • Add _docs/onboarding-guide.md — single-page guide covering the E10–E50 progressive tutorial path and 101 developer guide
  • Update _docs/index.md with one new bullet in the "Get started" section

Companion to PR #130 (code examples targeting main).

Content sections

  • Overview, prerequisites, and learning path table
  • E10: Java Kafka Client — produce/consume basics, KafScale-specific config
  • E20: Spring Boot — REST API, profiles, Docker deployment
  • E30: Apache Flink — stateful streaming, 3 deployment modes
  • E40: Apache Spark — structured streaming, DataFrame API, checkpoints
  • E50: JavaScript — Node.js client, web UI, agent integration
  • Common configuration — deployment profiles table, env vars
  • Developer guide overview (101 chapters)
  • Next steps — links to quickstart, user-guide, architecture

Verification

  • Front matter matches conventions (layout: doc, nav_order: 4, permalink: /onboarding-guide/)
  • Apache 2.0 HTML comment license header present
  • index.md has exactly one new bullet added
  • Internal links resolve (/quickstart/, /user-guide/, /architecture/)
  • GitHub source links point to correct main branch paths

Test plan

  • Verify page renders correctly on gh-pages (Jekyll build)
  • Confirm navigation order is correct (after User Guide, before Installation)
  • Check all internal and external links resolve

🤖 Generated with Claude Code

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>
@novatechflow novatechflow merged commit 6ba0d78 into KafScale:gh-pages Mar 3, 2026
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