quarkusio/quarkus

Document and expose documentation of BuildItems in an automated fashion

Open

#6.983 aberto em 4 de fev. de 2020

Ver no GitHub
 (8 comments) (0 reactions) (0 assignees)Java (2.464 forks)batch import
good first issuekind/enhancement

Métricas do repositório

Stars
 (12.967 stars)
Métricas de merge de PR
 (Mesclagem média 6d 4h) (325 fundiu PRs em 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?).

Guia do colaborador

Direção de pesquisa
Estude as classes BuildItem existentes e seus JavaDocs, depois projete um processador de anotações para coletar e gerar uma lista de BuildItems por extensão. Considere usar o pacote javax.annotation.processing ou similar.
Pilha de tecnologia
java
Domain
backenddocumentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JavaMaven or GradleAnnotation processing
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65