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 (909 forks)batch import
component:schema-registrydocsgood first issuepriority:high

Repository metrics

Stars
 (3,526 stars)
PR merge metrics
 (Avg merge 10d 2h) (27 merged PRs in 30d)

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

Research direction
Find the README.md file in the repository, locate the sections mentioning AvroProducer and AvroConsumer, and update the text to mark them as legacy with a note linking to the package documentation.
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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90