quarkusio/quarkus

Document and expose documentation of BuildItems in an automated fashion

Open

#6,983 opened on Feb 4, 2020

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Java (12,967 stars) (2,464 forks)batch import
good first issuekind/enhancement

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

Tech stack
java
Domain
documentationdeveloper experiencebackend
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Javaannotation processingQuarkus extension development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
The issue requests documenting all public BuildItem classes with JavaDoc and creating an annotation processor to collect and generate a list per extension. The existing BuildItem classes are scattered across Quarkus extensions; look for them under 'extensions/' directories. There is no linked PR but comments suggest previous attempts stalled. Review existing annotation processors in Quarkus (e.g., for Arc) for patterns. The maintainer may need to clarify which BuildItems are 'public' and the expected output format.
Document and expose documentation of BuildItems in an automated fashion · quarkusio/quarkus#6983 | Good First Issue