quarkusio/quarkus

Document how to create a multi-module Maven project

Open

#2,003 opened on Apr 11, 2019

View on GitHub
 (14 comments) (12 reactions) (0 assignees)Java (12,967 stars) (2,464 forks)batch import
area/documentationgood first issuepinned

Description

Now that we have support for multi-modules Maven project, we should properly document them:

  • the empty beans.xml trick;
  • using quarkus:dev in a multi-module environment

Contributor guide

Tech stack
java
Domain
documentation
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.
half day
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
Basic knowledge of MavenFamiliarity with Quarkus
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate how multi module support is implemented in the Quarkus codebase. Look at existing documentation in the 'maven' or 'build' sections of the main repository. Check any comments in the issue for guidance on the empty `beans.xml` trick and how to run `quarkus:dev` in a multi module environment. Provide clear steps and examples based on the implementation details.