Page History

...

• to highlight some new feature introduced in a release (e.g. Bean Validation or Criteria API)
• to describe wiring between frameworks e.g. JSF and JPA, GWT and JPA
• to demonstrate operation within a container e.g. OSgiOSGi, Spring, Tomcat or JEE
• a combination of the above

...

State the availability of the sample. For example,

• Is the distribution available as a downloadable archieve? If packaged in an archieve, all source code, build instructions must be available in the distribution itself. A README.txt should be inside and outside the distribution.

• Is the sample to be checked out from code repository? In such cases, building the sample should be done with Ant or Maven. Prefer Ant to make the dependencies and steps more visible.

The steps in this section should be clear and concise for an user to follow them to build, deploy and run the samplessample.

Environment

Enumerate the software artifacts required to build, deploy and run the sample. The artifacts should be categorized into build time and run time dependencies.

...

The complete develop-build-run cycle of a sample will often bring out the special considerations. For example, reported common errors in deployment in a container and their remedies or certain undesirable usage patterns. The description of a sample should highlight these special considerations rather than making the exercise appear as a series of perfectly easy steps. The caveats can be further highlighted by linking them to relevant JIRA issues or forum discussions or external blogs etc. ...