Doc: Modules

Work in progress

This wiki attempts to describe how we can document the different modules. What information to put where and how arquillian.org can aggregate the data.

• module github code repository:

The short overview of the module should be placed in the README.x file in the code repository.

• README.md:

A brief 'why statement'. Explain why this module exist, what problem it tries to solve.

A short list of the most important goals / features of the module.

README.me will be the main text for the arquillian.org/module overview page.

• module github wiki repository:

The github wiki can be used for manual reference documentation. The wiki allow for version tagging and any markup can be used.

The wiki should contain only usage information not provided by automation.

• module github code repository automated:

  • git repository - location, history, contributors, versions
  • pom.xml - group / artifact
  • test run debug output - spi events and integration's
  • LoadableExtension - provided services
  • Container|ExtensionConfiguration - read javadoc