[TOMEE-2369] Examples Missing README Files

• Type: Documentation
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Labels: pull-request-available
• Assignee: Unassigned
• Reporter: David Blevins
• Created: 17/Dec/18 07:09
• Updated: 07/Mar/19 06:44

Description

If an example does not have a README.adoc or README.md file, it will not show up online at http://tomee.apache.org/tomee-8.0/examples/

 

Minimum example README, but better than nothing.  It at least shows code and follows the format:

• http://tomee.apache.org/tomee-8.0/examples/movies-complete.html
• https://github.com/apache/tomee/tree/master/examples/movies-complete

Good example README, shows code and there's some minimal explanation:

• http://tomee.apache.org/tomee-8.0/examples/schedule-expression.html
• https://github.com/apache/tomee/tree/master/examples/schedule-expression

Great example README, shows code and there's an explanation in each section:

• http://tomee.apache.org/tomee-8.0/examples/simple-singleton.html
• https://github.com/apache/tomee/tree/master/examples/simple-singleton 

Fantastic example README, tons of code, each section uses searchable key words:

• http://tomee.apache.org/tomee-8.0/examples/simple-webservice.html
• https://github.com/apache/tomee/tree/master/examples/simple-webservice

 

Issue Links

• links to: GitHub Pull Request #307

Sub-Tasks

• Add README.adoc to applicationcomposer-jaxws-cdi/: Resolved
• Add README.adoc to cdi-ejbcontext-jaas/: Open
• Add README.adoc to cdi-realm/: Resolved
• Add README.adoc to cdi-session-scope/: Resolved
• Add README.adoc to client-resource-lookup-preview/: Open
• Add README.adoc to concurrency-utils/: Resolved
• Add README.adoc to connector-ear/: Open
• Add README.adoc to cucumber-jvm/: Resolved
• Add README.adoc to datasource-definition/: Open
• Add README.adoc to deltaspike-configproperty/: Open
• Add README.adoc to deltaspike-exception-handling/: Open
• Add README.adoc to deltaspike-i18n/: Closed
• Add README.adoc to groovy-cdi/: Open
• Add README.adoc to groovy-jpa/: Resolved
• Add README.adoc to groovy-spock/: Resolved
• Add README.adoc to moviefun-rest/: Resolved
• Add README.adoc to mp-metrics-metered/: Resolved
• Add README.adoc to mp-opentracing-traced/: Resolved
• Add README.adoc to multi-jpa-provider-testing/: Resolved
• Add README.adoc to multiple-arquillian-adapters/: Open
• Add README.adoc to multiple-tomee-arquillian/: Resolved
• Add README.adoc to pojo-webservice/: Resolved
• Add README.adoc to projectstage-demo/: Closed
• Add README.adoc to rest-applicationcomposer-mockito/: Resolved
• Add README.adoc to rest-applicationcomposer/: Open
• Add README.adoc to rest-jaas/: Open
• Add README.adoc to scala-basic/: Open
• Add README.adoc to server-events/: Open
• Add README.adoc to simple-ear/: Open
• Add README.adoc to simple-remote-tomcatusers/: Resolved
• Add README.adoc to testing-security-4/: Resolved
• Add README.adoc to tomee-jersey-eclipselink/: Resolved
• Add README.adoc to webservice-ws-with-resources-config/: Resolved