apache/pinot

Add documentation for broker FailureDetector module

Open

#13,502 opened on Jun 27, 2024

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Java (1,234 forks)batch import
documentationgood first issuehelp wanted

Repository metrics

Stars
 (4,937 stars)
PR merge metrics
 (Avg merge 6d 7h) (186 merged PRs in 30d)

Description

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

Contributor guide

Research direction
Find the FailureDetector module code and its existing documentation. Review the pattern from other modules to write the documentation.
Tech stack
java
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJava
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75