apache / apache/pinot

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

Open
#8,775 1 comment 2 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
Java
Stars
6.1k
Forks
1.5k
Avg merge
1d 21h
Merged PRs (30d)
189

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

Open the contributing guide

Research direction

Start by reviewing the documentation site's existing plugin and ingestion sections, then compare the Kinesis and Kafka configuration details and AVRO logical-types switch mentioned in the issue. Done means plugin-specific behavior is documented in a discoverable section instead of requiring users to inspect source code.

Written by the indexing model from the issue text.

Assessment

Tech stack
kafka
Domain
documentation, stream-processing
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.