Où doit-on stocker la documentation du projet dans un projet maven typique ?

Question

Où doit-on stocker la documentation du projet (exigences, etc.) dans un projet maven typique.

Aucun des répertoires listés dans Introduction à la mise en page standard du répertoire La page est un candidat évident.

Answer 1

Malheureusement, il n'y a pas de convention. Si vous souhaitez que la documentation fasse partie du site généré, il faut évidemment /src/site est un bon endroit. Peut-être pouvez-vous même écrire la documentation dans le APT format ?

Mais il est plus probable que vous ayez un ensemble de doc , pdf y xls fichiers, graphiques, courriers électroniques, etc. Vous pouvez soit les placer sous /src/site ainsi que de mettre des hyperliens dans le site ou... définissez votre propre convention, malheureusement. Typiquement, j'ai vu /src/main/doc(s) , /src/doc(s) ou même /doc(s) .

Vous ne voulez pas placer votre documentation dans /src/main/resources o src/main/webapp car les fichiers feront alors partie de l'artefact construit (JAR/WAR), ce qui est rarement souhaité.

Answer 2

http://www.sonatype.com/books/mvnref-book/reference/site-generation-sect-dir-struct.html recommande la structure suivante

sample-project
+- src/
[..]
+- resources/
|  +- images/
|  |  +- banner-left.png
|  |  +- banner-right.png
|  |
|  +- architecture.html
|  +- jira-roadmap-export-2007-03-26.html
[..]

Answer 3

Selon le maven-javadoc-plugin :

El <javadocDirectory/> peut être utilisé pour inclure des ressources supplémentaires, comme du HTML ou des images, dans la javadoc générée. Vous pouvez ensuite créer des liens vers ces ressources dans vos commentaires de javadoc. Par défaut, toutes les ressources de javadoc sont dans le fichier ${basedir}/src/main/javadoc le répertoire. Notez que vous devez définir l'option docfilessubdirs pour les copier.