quarkusio/quarkus

Document and expose documentation of BuildItems in an automated fashion

Open

#6,983 opened on Feb 4, 2020

View on GitHubContributor guide
 (8 comments) (0 reactions) (0 assignees)Java (2,464 forks)batch import
good first issuekind/enhancement

Repository metrics

Stars
 (12,967 stars)
PR merge metrics
 (Avg merge 6d 4h) (325 merged PRs in 30d)

Description

A big value of extensions is the BuildItem model. We need to document them so other extension writers can discover and use them. They are also part of the extension contract.

  1. document all "public" BuildItem with adequate JavaDoc
  2. build an anotation processor that will collect the BuildItems and generate a list of them per extension and a documentation (summary?).

Contributor guide

Research direction
Study existing BuildItem classes and their JavaDoc, then design an annotation processor to collect and generate a list of BuildItems per extension. Consider using javax.annotation.processing package or similar.
Tech stack
java
Domain
backenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaMaven or GradleAnnotation processing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65