apache/pinot

Add documentation for broker FailureDetector module

Open

#13.502 geöffnet am 27. Juni 2024

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (1.234 Forks)batch import
documentationgood first issuehelp wanted

Repository-Metriken

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

Beschreibung

#8491 introduced the FailureDetector module. We want to add documentation for it

Contributor Guide

Research-Richtung
Beziehen Sie sich auf PR #8491, um das FailureDetector Modul zu verstehen. Untersuchen Sie die vorhandene Broker Dokumentation im Repository (wahrscheinlich im Verzeichnis 'docs/'), um herauszufinden, wo die neue Dokumentation hinzugefügt werden soll. Schreiben Sie eine klare Beschreibung des Zwecks des Moduls, seiner Konfiguration und seiner Funktionsweise.
Tech Stack
java
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitJava
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75