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 2011/05/31 01:29:47 UTC
[jira] [Updated] (OPENEJB-1566) Example page generator
[ https://issues.apache.org/jira/browse/OPENEJB-1566?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
David Blevins updated OPENEJB-1566:
-----------------------------------
Comment: was deleted
(was: See http://svn.apache.org/repos/asf/openejb/trunk/sandbox/tools/src/main/java/org/apache/openejb/tools/examples/GenerateIndex.java
/**
* Most the examples do not have any documentation.
*
* There are some wiki pages for some of the examples, but these
* are hard to create and maintain. The examples change frequently
* enough that we really should have documentation that goes with
* each version of the examples.
*
* If we put a README.md file in each example and use Markdown
* which is a really simple text format that has many tools
* capable of generating html, we could probably generate a
* web page for each example. Then we could generate a index
* for all the examples.
*
* We could then take this all and upload it to the website
*
* Something kind of like this:
* http://people.apache.org/~dblevins/simple-stateless.html
*
* But nicer looking, with breadcrumbs and links for navigating
* around to other examples
*
*
* IDEAS FOR AFTER SOMETHING IS WORKING
*
* Perhaps at some point some xref style processing of the source
* and links to the source
*
* Perhaps at some point use ASM to see what annotations and API
* classes were used and make an index that lists examples by
* which APIs are used
*
* Perhaps at some point use Swizzle stream to do a sort of SNIPPET
* thing like the Confluence plugin, so we wouldn't have to copy
* source into the example
*
* @version $Rev$ $Date$
*/
)
> Example page generator
> ----------------------
>
> Key: OPENEJB-1566
> URL: https://issues.apache.org/jira/browse/OPENEJB-1566
> Project: OpenEJB
> Issue Type: Improvement
> Components: documentation, examples, website
> Reporter: David Blevins
> Priority: Critical
> Labels: documentation, examples, markdown, website
>
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira