root/tags/OMERO.insight_3_Beta1/docgen/index.html
| Revision 2468, 2.1 kB (checked in by hsh, 4 years ago) | |
|---|---|
|
|
| Line | |
|---|---|
| 1 | <html> |
| 2 | <head> |
| 3 | <title>Shoola Documentation Site</title> |
| 4 | <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| 5 | </head> |
| 6 | <body bgcolor="#FFFFFF" text="#000000"> |
| 7 | <h3>Shoola Documentation Site</h3> |
| 8 | <div align="center"> |
| 9 | <p><b><font color="#FF9966">Under Construction</font></b></p> |
| 10 | </div> |
| 11 | <p>This site aims to provide a centralized place where documentation on Shoola can |
| 12 | be found. We provide documents at different levels and to different audiences. The |
| 13 | available documents can be grouped in two categories: technical and users documents. |
| 14 | In the first category fall documents that describe the software as a whole (like |
| 15 | the Software Architecture Document and the Build and Deployment Document), more |
| 16 | detailed design documents on each software component, API usage documents and tutorials, |
| 17 | and of course detailed documentation for each class (JavaDoc). The second category |
| 18 | encompasses all the information that is relevant to the end users, like help documents |
| 19 | and tutorials.</p> |
| 20 | <p>Documents currently available:</p> |
| 21 | <ul> |
| 22 | <li> <A href="userdocs/index.html">Shoola agent documentation</a></li> |
| 23 | <li>JavaDoc (<a href="javadoc/index.html" target="_top">html</a> | <a href="javadoc/overview-summary.html" target="_top">no-frames |
| 24 | html</a>). Programmers documentation.</li> |
| 25 | <li>Software Build and Deployment Document (<a href="sbdd/index-frames.htm" target="_top">html</a> |
| 26 | | <a href="sbdd/index.htm" target="_top">no-frames html</a> | <a href="sbdd/doc.pdf" target="_top">pdf</a>). |
| 27 | Describes the build system and how to build the various projects artifacts. Relevant |
| 28 | to system administrators that want to build and deploy Shoola from scratch. Also |
| 29 | an handy reference document to developers.</li> |
| 30 | <li>Asynchronous Data Views design document (<a href="components/data_services_views/index-frames.htm" target="_top">html</a> |
| 31 | | <a href="components/data_services_views/index.htm" target="_top">no-frames |
| 32 | html</a> | <a href="components/data_services_views/doc.pdf" target="_top">pdf</a>). |
| 33 | Details usage and design of the upcoming API that can be used to access the data |
| 34 | services asynchronously.</li> |
| 35 | </ul> |
| 36 | </body> |
| 37 | </html> |
Note: See TracBrowser
for help on using the browser.
