Create a complete documentation plan for your development projects.
This project is a maven archetype to easily create a asciidoc template for development projects.
An example is available on github pages.
To use this archetype on your project (if the archetype is in your repo) :
mvn archetype:generate -DarchetypeGroupId="com.trebuac" ^
-DarchetypeArtifactId="documentation-archetype" ^
-DarchetypeVersion="0.0.0.0-SNAPSHOT" ^(1)
-Dproject="DummyProject" ^(2)
-DgroupId="com.trebuac" ^(2)
-DartifactId="documentation" ^(2)
-Dversion="0.0.0.0-SNAPSHOT"(2)
-
Change the archetype version with the one installed in your repo
-
Define the different properties of your project
Note: The ^
is used to copy/paste the multiline cmd into a windows terminal. Use `
for powershell terminal.
Tip
|
If the archetype is not installed in your local or distant maven repository, clone this repo and mvn clean install .
|
archetype-root/
├── pom.xml
└── src
├── main
│ └── resources (1)
│ ├── archetype-resources
│ │ ├── pom.xml
│ │ ├── readme.adoc
│ │ └── src
│ └── META-INF
│ └── maven
│ └── archetype-metadata.xml (2)
└── test
-
Location of all sources (pom.xml, adoc files,… )
-
Definition of the archetype (files to copy and to filter)
Update template files (adoc, pom.xml) contained in src/main/resources
Launch mvn verify
on the archetype base directory and visualize the result in your target file
.\target\test-classes\projects\nominalTestCase\project\myProjectArtifactId
Note
|
The sub project is generated thanks to archetype integration tests and the goal.txt file in src/test/resources defining the maven goals to launch after the build. See maven documentation.
|