confluentinc/confluent-kafka-python

Update README.md to reflect the legacy status of AvroProducer and AvroConsumer

Open

#910 opened on Jul 7, 2020

View on GitHub
 (4 comments) (11 reactions) (0 assignees)Python (3,526 stars) (909 forks)batch import
component:schema-registrydocsgood first issuepriority:high

Description

Package documentation marks AvroProducer and AvroConsumer as legacy. But, README.md still prominently advertises these legacy classes. This may be confusing for new users. Please update README.md.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Locate the README.md file in the repository root. Find the section referencing AvroProducer and AvroConsumer. Update the description to mark these classes as legacy, aligning with the package documentation at https://docs.confluent.io/current/clients/confluent kafka python/index.html#avroproducer legacy.