Add Clarifying Documentation for Kafka Sample
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
- Ships a Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
firefly-iii/firefly-iii#13259 · 3 comments ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
molgenis/molgenis-emx2#7059 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
[DOCS/SMU] Correct the 1 GiB window bullet and the coverage-target sentence in the SMU datasheetOpenDOCS SMU
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
tenstorrent/tt-oca-harness#3931 ·
Maintainers usually reply within 1 day
-
[Sync EN] Document the getLastErrors() return value change in the PHP 8.2 migration guide (#6107)Opensync-en
Difficulty 1/5 Under an hour Newbie friendliness 78/100
Maintainers usually reply within 1 day