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 (4,937 stars) (1,234 forks)batch import
documentationgood first issue

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

Tech stack
javakafka
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic understanding of Apache PinotFamiliarity with plugin configurationExperience writing documentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Review the existing documentation structure in the repository, specifically the docs directory. Look at the comment on the issue for any additional context or suggestions from maintainers. The task involves adding a new section to document plugin specific details such as Kinesis and Kafka stream ingestion configurations and AVRO logical types. Examine the source code of the plugins to extract configuration parameters and document them in a clear, organized manner.