apache/pinot

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

Open

#8.775 geöffnet am 25. Mai 2022

Auf GitHub ansehen
 (1 Kommentar) (2 Reaktionen) (0 zugewiesene Personen)Java (1.234 Forks)batch import
documentationgood first issue

Repository-Metriken

Stars
 (4.937 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 6T 7h) (186 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Identifizieren Sie Plugins wie Kinesis und Kafka, die undokumentierte Funktionen haben, und erstellen Sie einen neuen Dokumentationsabschnitt, der Konfigurationsdetails, AVRO Logiktyp Schalter usw. beschreibt.
Tech Stack
java
Domain
documentationbackenddata
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Basic understanding of Apache Pinot plugin architecture
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85