Skip to content

Title: Missing prerequisites for running Kafka in Kafka tutorial sequence #5191

@wei123-web

Description

@wei123-web

Description:
The Kafka tutorial sequence assumes that a Kafka broker and local environment are already configured, but the documentation does not provide setup instructions or clearly list prerequisites.
As a result, new users cannot fully run the examples even when following the tutorial step-by-step.

Locations:

  • "Create AsyncAPI document for applications consuming from Kafka"
  • [https://www.asyncapi.com/docs/tutorials/kafka]
  • "Describe Kafka message payload using Avro Schema"
  • "Managing schemas using Schema Registry"
  • "Kafka bindings"

Observed behavior:
The tutorials reference Kafka brokers and configurations but do not explain:

  • how to run Kafka locally
  • required tools or environment setup
  • how Kafka connects to the Schema Registry container

Expected behavior:
Each tutorial in the Kafka sequence should include or link to a prerequisites section explaining:

  • minimal Kafka local setup (e.g., Docker)
  • required software and versions
  • how services connect together
  • required ports and configuration

Suggested improvement:
Add a shared “Prerequisites” section for the Kafka tutorial flow that includes:

  • local Kafka setup instructions
  • architecture overview
  • environment requirements

Impact:
This gap makes the tutorial difficult to follow for beginners and blocks successful completion of the examples.

Note: I would be happy to contribute a PR implementing these improvements once the issue is reviewed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    To Be Triaged

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions