Quarkus BuildItems Documentation

[mcruzdev]

This is a sub-issue from #37290. This issue aims to manage all effort to document our BuildItem classes.

Basically, we have some classes (listed below) without documentation, it implies that on our documentation we have some BuildItems without a description, see the image below.

If you want to contribute with this issue, please comment what BuildItem you will get to document.

Waiting a great contributor

• io.quarkus.deployment.builditem.ApplicationArchivesBuildItem
• io.quarkus.deployment.BooleanSupplierFactoryBuildItem
• io.quarkus.deployment.builditem.BytecodeTransformerBuildItem
• io.quarkus.deployment.builditem.ConsoleCommandBuildItem
• io.quarkus.deployment.builditem.ConsoleFormatterBannerBuildItem
• io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem
• io.quarkus.deployment.cmd.DeployCommandActionResultBuildItem
• io.quarkus.deployment.cmd.DeployCommandDeclarationResultBuildItem
• io.quarkus.deployment.builditem.JniBuildItem

In progress

• io.quarkus.deployment.builditem.ContextHandlerBuildItem
• io.quarkus.deployment.builditem.DockerStatusBuildItem
• io.quarkus.deployment.builditem.ExtensionSslNativeSupportBuildItem
• io.quarkus.deployment.builditem.GeneratedClassBuildItem
• io.quarkus.deployment.builditem.GeneratedResourceBuildItem
• io.quarkus.deployment.builditem.JavaLibraryPathAdditionalPathBuildItem
• io.quarkus.deployment.builditem.LogCategoryMinLevelDefaultsBuildItem
• io.quarkus.deployment.builditem.MainBytecodeRecorderBuildItem
• io.quarkus.deployment.builditem.MainClassBuildItem
• io.quarkus.deployment.builditem.NativeImageEnableAllCharsetsBuildItem
• io.quarkus.deployment.builditem.QuarkusApplicationClassBuildItem
• io.quarkus.deployment.builditem.QuarkusBuildCloseablesBuildItem
• io.quarkus.deployment.builditem.ShutdownListenerBuildItem
• io.quarkus.deployment.builditem.SslNativeConfigBuildItem
• io.quarkus.deployment.builditem.StaticBytecodeRecorderBuildItem
• io.quarkus.deployment.builditem.ThreadFactoryBuildItem
• io.quarkus.deployment.builditem.nativeimage.NativeImageConfigBuildItem
• io.quarkus.deployment.builditem.nativeimage.ReflectiveFieldBuildItem
• io.quarkus.deployment.builditem.nativeimage.ReflectiveMethodBuildItem
• io.quarkus.deployment.builditem.nativeimage.UnsafeAccessedFieldBuildItem
• io.quarkus.deployment.cmd.RunCommandActionBuildItem
• io.quarkus.deployment.cmd.RunCommandActionResultBuildItem
• io.quarkus.deployment.dev.devservices.DevServiceDescriptionBuildItem
• io.quarkus.deployment.dev.testing.TestListenerBuildItem
• io.quarkus.deployment.logging.LogStreamBuildItem
• io.quarkus.deployment.metrics.MetricsCapabilityBuildItem
• io.quarkus.deployment.pkg.builditem.CompiledJavaVersionBuildItem
• io.quarkus.deployment.pkg.builditem.JarBuildItem
• io.quarkus.deployment.pkg.builditem.NativeImageBuildItem
• io.quarkus.deployment.builditem.ConfigPropertiesBuildItem @dionesouzabr
• io.quarkus.deployment.builditem.ConfigClassBuildItem @jghagemann
• io.quarkus.deployment.builditem.ApplicationClassNameBuildItem
• io.quarkus.deployment.builditem.BytecodeRecorderObjectLoaderBuildItem
• io.quarkus.deployment.builditem.ConfigMappingBuildItem @mcruzdev
• io.quarkus.deployment.pkg.builditem.DeploymentResultBuildItem @mcruzdev
• io.quarkus.deployment.cmd.DeployCommandActionBuildItem @matheusandre1

Done

• io.quarkus.deployment.builditem.ApplicationInfoBuildItem
• io.quarkus.deployment.builditem.AppModelProviderBuildItem @joseiedo
• io.quarkus.deployment.builditem.ArchiveRootBuildItem @ayagmar
• io.quarkus.deployment.builditem.AdditionalClassLoaderResourcesBuildItem @omatheusmesmo

cc: @holly-cummins @gsmet

[omatheusmesmo]

I would like to work on AdditionalClassLoaderResourcesBuildItem

[joseiedo]

I will work on
io.quarkus.deployment.builditem.AppModelProviderBuildItem

Is there a documentation pattern to follow? Or I can write what I find useful and we improve until everyone agrees?

[mcruzdev]

I will work on io.quarkus.deployment.builditem.AppModelProviderBuildItem

Is there a documentation pattern to follow? Or I can write what I find useful and we improve until everyone agrees?

Hi @joseiedo, you could see some BuildItems already documented to get an example and yes we can improve together on pull request review.

[ayagmar]

Hello @mcruzdev , PR created to handle a few of these build Items

[dionesouzabr]

I want to help document ConfigPropertiesBuildItem.

[jghagemann]

Hello @mcruzdev . I'd like to help with:

io.quarkus.deployment.builditem.ConfigClassBuildItem
io.quarkus.deployment.builditem.ApplicationClassNameBuildItem
io.quarkus.deployment.builditem.BytecodeRecorderObjectLoaderBuildItem