Add Clarifying Documentation for Kafka Sample

Open
#1 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
azure, helm, kafka, python
Domain
documentation

Research direction

Open the sample tutorial and locate its objective section and the instructions for installing the Kafka cluster with Helm. Read the surrounding explanations first; done means the objective no longer implies broker scaling with message volume and the Helm-installed components have their purposes explained.

Written by the indexing model from the issue text.

Description

Sometimes, at first glance users have have the impression that the tutorial is intended to scale the kafka brokers as more messages arrive. We need to clarify this in the objective section of the sample tutorial.

The instruction on installing the Kafka cluster via Helm could also be updated to explain the purpose of the different components of the Kafka cluster installed via Helm.

Dominant language
Dockerfile
Stars
7
Forks
2
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.