apache/pinot

Add documentation for the forceCommit API

Open

#11.212 geöffnet am 28. Juli 2023

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

Repository-Metriken

Stars
 (4.937 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 5T 14h) (191 gemergte PRs in 30 T)

Beschreibung

It would be great to add user-facing documentation for:

  • ​/tables​/{tableName}​/forceCommit: Would be useful to know how it works and what happens when it fails
  • /tables/forceCommitStatus/{jobId}: Would be useful to know how status of the jobs changes/how they're cleaned up

Contributor Guide

Research-Richtung
Das Issue fordert Dokumentation für die forceCommit API Endpunkte. Beginnen Sie mit der Untersuchung der vorhandenen API Dokumentationsstruktur im Repository, wahrscheinlich im Verzeichnis 'docs' oder 'documentation'. Suchen Sie, wie andere ähnliche Endpunkte dokumentiert sind. Die Endpunkte sind /tables/{tableName}/forceCommit und /tables/forceCommitStatus/{jobId}. Erforschen Sie den Quellcode dieser Endpunkte, um das Verhalten, Fehlerfälle und Statusänderungen zu verstehen. Schreiben Sie dann eine klare Beschreibung im bestehenden Dokumentationsstil.
Tech Stack
javarest api
Domain
backendapi
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.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90