You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tomee.apache.org by "David Blevins (JIRA)" <ji...@apache.org> on 2018/12/17 07:11:00 UTC
[jira] [Updated] (TOMEE-2369) Examples Missing README Files

     [ https://issues.apache.org/jira/browse/TOMEE-2369?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

David Blevins updated TOMEE-2369:
---------------------------------
    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/]

 

Poor 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]

Good example README, shows code and there's some minimal explanation:
 - [http://tomee.apache.org/tomee-8.0/examples/schedule-expression.html]

Great example README, shows code and there's an explanation in each section:
 *  [http://tomee.apache.org/tomee-8.0/examples/simple-singleton.html] 

Fantastic example README, tons of code, each section uses searchable key words:
 * [http://tomee.apache.org/tomee-8.0/examples/simple-webservice.html]

 

  was:
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/]

 

Poor 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

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

- [http://tomee.apache.org/tomee-8.0/examples/schedule-expression.html]

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

 - http://tomee.apache.org/tomee-8.0/examples/simple-singleton.html

 

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

  - http://tomee.apache.org/tomee-8.0/examples/simple-webservice.html

 


> Examples Missing README Files
> -----------------------------
>
>                 Key: TOMEE-2369
>                 URL: https://issues.apache.org/jira/browse/TOMEE-2369
>             Project: TomEE
>          Issue Type: Documentation
>            Reporter: David Blevins
>            Priority: Major
>
> 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/]
>  
> Poor 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]
> Good example README, shows code and there's some minimal explanation:
>  - [http://tomee.apache.org/tomee-8.0/examples/schedule-expression.html]
> Great example README, shows code and there's an explanation in each section:
>  *  [http://tomee.apache.org/tomee-8.0/examples/simple-singleton.html] 
> Fantastic example README, tons of code, each section uses searchable key words:
>  * [http://tomee.apache.org/tomee-8.0/examples/simple-webservice.html]
>  



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)