apache/pinot

Add a section to the documentation site to document plugin-specific details

Open

#8,775 opened on May 25, 2022

View on GitHub
 (1 comment) (2 reactions) (0 assignees)Java (1,234 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (4,937 stars)
PR merge metrics
 (Avg merge 6d 7h) (186 merged PRs in 30d)

Description

Not sure if this make sense but some plugins have particular features that should be documented somewhere in the docs rather than users having to search through the source code to find out about them. Some examples include configuration details for the Kinesis and Kafka stream ingestion, AVRO logical types switch, etc.

Contributor guide

Research direction
Identify plugins like Kinesis and Kafka that have undocumented features, then create a new documentation section describing configuration details, AVRO logical types switch, etc.
Tech stack
java
Domain
documentationbackenddata
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.
Half day
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
Basic understanding of Apache Pinot plugin architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85