| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/xdoc/common/documentation.xml at 17 Jun 2025 |
| | Rendered using Apache Maven Fluido Skin 2.1.0 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> |
| <title>The Turbine Documentation Effort – Apache Turbine</title> |
| <link rel="stylesheet" href="../css/apache-maven-fluido-2.1.0.min.css" /> |
| <link rel="stylesheet" href="../css/site.css" /> |
| <link rel="stylesheet" href="../css/print.css" media="print" /> |
| <script src="../js/apache-maven-fluido-2.1.0.min.js"></script> |
| <style>.github-fork-ribbon:before { background-color: orange; }</style> |
| </head> |
| <body> |
| <a class="github-fork-ribbon right-top" href="https://github.com/apache/turbine-site" data-ribbon="Fork me on GitHub">Fork me on GitHub</a> |
| <div class="container-fluid container-fluid-top"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h1><a href=".././"><img src="../images/turbine-project.png" alt="Apache Turbine" /></a></h1></div></div> |
| <div class="pull-right"><div id="bannerRight"><h1><a href=".././"><img src="../images/logo.gif" /></a></h1></div></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 01 Apr 2025<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 7.0</li> |
| <li class="pull-right"><span class="divider">|</span> |
| <a href="../fulcrum/">Fulcrum</a></li> |
| <li class="pull-right"><span class="divider">|</span> |
| <a href=".././">Turbine</a></li> |
| <li class="pull-right"><span class="divider">|</span> |
| <a href="https://www.apache.org/">Apache</a></li> |
| <li class="pull-right"><span class="divider">|</span> |
| <a href="../fulcrum/">Fulcrum</a></li> |
| <li class="pull-right"><a href="https://www.apache.org">Apache</a></li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">General Information</li> |
| <li><a href="../index.html">Overview</a></li> |
| <li><a href="../turbine-concepts.html">Turbine Concepts</a></li> |
| <li><a href="../fsd.html">Specification</a></li> |
| <li><a href="../further-reading/index.html">Further Reading</a></li> |
| <li><a href="../news.html">News and Status</a></li> |
| <li><a href="../common/powered.html">Sites Using Turbine</a></li> |
| <li><a href="../common/related.html">Sites Related to Turbine</a></li> |
| <li><a href="../common/license.html">License</a></li> |
| <li><a href="../download.html">Download</a></li> |
| <li><a href="../examples.html">Example Apps</a></li> |
| <li class="nav-header">Shortcuts to Turbine Documentation</li> |
| <li><a href="https://blogs.apache.org/turbine/">Turbine Blog</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/TURBINE/">Turbine Wiki Home</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/TURBINE/Turbine2+FAQ">Frequently Asked Questions (FAQ)</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/TURBINE/Turbine2+Tutorial">Tutorial</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/TURBINE/Turbine2+UsersGuide">User's Guide</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/TURBINE/Turbine5">Development</a></li> |
| <li class="nav-header">Events</li> |
| <li><a href="https://www.apache.org/events/current-event.html" target="_blank"><img class="imageLink" src="https://www.apache.org/events/current-event-125x125.png" /> Apache Conferences</a></li> |
| <li class="nav-header">Turbine Releases</li> |
| <li><a href="../turbine/index.html">Overview</a></li> |
| <li><a href="../turbine/turbine-2-3-3/index.html">Turbine 2.3.3</a></li> |
| <li><a href="../turbine/turbine-4-0/index.html">Turbine 4.0 (M2)</a></li> |
| <li><a href="../turbine/turbine-5-0/index.html">Turbine 5.0</a></li> |
| <li><a href="../turbine/turbine-5-1/index.html">Turbine 5.1</a></li> |
| <li><a href="../turbine/turbine-6-0/index.html">Turbine 6.0</a></li> |
| <li><a href="../turbine/turbine-7-0/index.html">Turbine 7.0</a></li> |
| <li class="nav-header">Turbine Development</li> |
| <li><a href="../turbine/index.html">Current Turbine Development Tree</a></li> |
| <li class="nav-header">Turbine Sub Projects</li> |
| <li><a href="../fulcrum/index.html">Fulcrum</a></li> |
| <li class="nav-header">Turbine + Fulcrum Parent POM</li> |
| <li><a href="../turbine-parent/index.html">Turbine Parent</a></li> |
| <li class="nav-header">Closed projects</li> |
| <li><a href="../stratum/index.html">Stratum</a></li> |
| <li><a href="../tdk/index.html">TDK</a></li> |
| <li><a href="../meta/index.html">META</a></li> |
| <li class="nav-header">Community</li> |
| <li><a href="../who-we-are.html">Who we are</a></li> |
| <li><a href="../contact.html">Contact us</a></li> |
| <li><a href="../how-to-help.html">How to help</a></li> |
| <li><a href="../how-it-works.html">How it works</a></li> |
| <li><a href="../board-reports.html">Board reports</a></li> |
| <li class="nav-header">General Development Information</li> |
| <li><a href="../common/code-standards.html">Coding Specification</a></li> |
| <li><a href="../common/developer-links.html">Developer Links</a></li> |
| <li class="active"><a>Improving Documentation</a></li> |
| <li class="nav-header">ASF</li> |
| <li><a href="https://apache.org/">Main</a></li> |
| <li><a href="https://www.apache.org/licenses/">License</a></li> |
| <li><a href="https://apache.org/foundation/sponsorship">Sponsorship</a></li> |
| <li><a href="https://www.apache.org/foundation/sponsors">Thanks</a></li> |
| <li><a href="https://www.apache.org/foundation/policies/conduct">Conduct</a></li> |
| <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</a></li> |
| <li><a href="https://www.apache.org/security/">Security</a></li> |
| <li class="nav-header">Project Documentation</li> |
| <li><a href="../project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li> |
| <li><a href="../project-reports.html"><span class="icon-chevron-right"></span>Project Reports</a></li> |
| <li class="nav-header">Apache</li> |
| <li><a href="https://www.apache.org/">Apache Website</a></li> |
| <li><a href="https://www.apache.org/licenses/">License</a></li> |
| <li><a href="https://www.apache.org/foundation/how-it-works.html">How the ASF works</a></li> |
| <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| <li><a href="https://www.apache.org/security/">Security</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <form id="search-form" action="https://www.google.com/search" method="get" > |
| <input value="https://turbine.apache.org/" name="sitesearch" type="hidden" /> |
| <input class="search-query" name="q" id="query" type="text" placeholder="Search with Google..." /> |
| </form> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10"> |
| |
| |
| |
| |
| <section><a id="The_Turbine_Documentation_Effort"></a> |
| <h1>The Turbine Documentation Effort</h1> |
| |
| <section><a id="Documentation_Roadmap"></a> |
| <h2>Documentation Roadmap</h2> |
| |
| <p> |
| We are working very hard to improve Turbine's documentation. Our weakest |
| area is introductory material for new users. Currently, the best resource |
| is the turbine-user mailing list. Although almost every question has |
| clear answers found in the list archives, it is time-consuming to find them. |
| </p> |
| |
| |
| <p> |
| Below is the list of documentation items we are working on listed in order |
| of priority from greatest to lowest. We need help with them all! |
| </p> |
| |
| |
| <ul> |
| |
| <li> |
| <b>Improve the presentation of our current documentation</b> |
| </li> |
| |
| <li> |
| <b>Turbine 2.3 Release Changes</b> |
| |
| <ul> |
| |
| <li>Describe how Turbine uses Avalon (there is a basic service |
| document, but furtehr details on creating services would be |
| welcome).</li> |
| </ul> |
| </li> |
| |
| <li> |
| <b>Quick Start Tutorial</b> |
| |
| <ul> |
| |
| <li>Based on a simple sample application</li> |
| |
| <li>Should most likely involve META</li> |
| |
| <li>Currently in the wiki at <a href="https://cwiki.apache.org/confluence/display/TURBINE/Turbine2+Tutorial" class="externalLink">Turbine2/Tutorial</a></li> |
| |
| <li>When stable, move it to xdoc and prepare a release</li> |
| </ul> |
| </li> |
| |
| <li> |
| <b>Complete User's Guide</b> |
| |
| <ul> |
| |
| <li>Currently in the wiki at <a href="https://cwiki.apache.org/confluence/display/TURBINE/Turbine2+UsersGuide" class="externalLink">Turbine2/UsersGuide</a></li> |
| |
| <li>Eventually in Xdoc, Forrest, or some other format</li> |
| </ul> |
| </li> |
| |
| <li> |
| <b>Turbine Architecture Diagram</b> |
| |
| <ul> |
| |
| <li>High level diagram of Services, Layouts, Navigations, TurbineServlet, Action, Screens, etc</li> |
| |
| <li>Should be a picture showing distinct layers</li> |
| </ul> |
| </li> |
| |
| <li> |
| <b>Clear Road Map of the Turbine Project</b> |
| |
| <ul> |
| |
| <li>Future Features and Enhancements</li> |
| |
| <li>The future of Fulcrum</li> |
| |
| <li>Currently in the wiki at <a href="https://cwiki.apache.org/confluence/display/TURBINE/Turbine2+Development" class="externalLink">Turbine2/Development</a></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| |
| <section><a id="Our_Documentation_Has_Three_States"></a> |
| <h2>Our Documentation Has Three States</h2> |
| |
| <ol style="list-style-type: decimal;"> |
| |
| <li> |
| <strong>Infancy:</strong> A document becomes nascent in the Wiki |
| as an empty or sparsely populated page. At this point, people continue to |
| add and revise the content until it becomes mostly stable and unchanging. |
| </li> |
| |
| <li> |
| <strong>Stability:</strong> Once the document has reached a stable point, it is converted into the xdoc |
| format and injected into the site or core modules at the subversion repository. |
| </li> |
| |
| <li> |
| <strong>Maturity:</strong> As changes to the Turbine Framework are made, the documentation |
| is updated and improved via xdoc patches from the <a href="http://issues.apache.org/jira/browse/TRB" class="externalLink">bug tracker</a>. |
| </li> |
| </ol> |
| </section> |
| |
| <section><a id="How_You_Can_Help"></a> |
| <h2>How You Can Help</h2> |
| |
| <p> |
| Now that you know what we are working on, you need to know the best ways to help. |
| Content is farmed and stabilized on the <a href="wiki.html">Turbine Wiki</a> |
| until it is stable enough to become official documentation. Additionally |
| questions are answered and re-answered on the turbine-user mailing list. |
| You can help the Turbine Documentation effort by: |
| </p> |
| |
| <ul> |
| |
| <li> |
| <strong>Editing The Wiki Content:</strong> Mature and stabilize the information on the <a href="wiki.html">Wiki</a>. |
| </li> |
| |
| <li> |
| <strong>Filtering The Mailing List:</strong> When you see something float |
| by on the mailing list that should become part of the official, |
| please convert it into the appropriate xdoc format and submit it as an |
| issue in our <a href="http://issues.apache.org/jira/browse/TRB" class="externalLink">issue tracking system</a>. |
| </li> |
| |
| <li> |
| <strong>Creating Xdoc Patches:</strong> If you find a typo, mistake or |
| overlooked information in the official documentation, please create |
| an issue in our <a href="http://issues.apache.org/jira/browse/TRB" class="externalLink">issue bug tracking system</a>. |
| </li> |
| </ul> |
| </section> |
| |
| <section><a id="Getting_The_Documentation_Source_And_Making_A_Patch"></a> |
| <h2>Getting The Documentation Source And Making A Patch</h2> |
| |
| <ol style="list-style-type: decimal;"> |
| |
| <li> |
| |
| <p> |
| <strong>Get The Source:</strong> |
| Check out the latest source from the Turbine GIT module. You can learn |
| about the Turbine repositories on the <a href="../download.html">download page</a>. |
| The Turbine documentation resides in the turbine-site tree: |
| </p> |
| |
| <pre class="prettyprint"><code>sgit clone https://github.com/apache/turbine-site</code></pre> |
| </li> |
| |
| <li> |
| |
| <p> |
| <strong>Build The Site:</strong> |
| The documentation is built using <a href="http://maven.apache.org/" class="externalLink">Maven</a>, |
| with the following command: |
| </p> |
| |
| <pre class="prettyprint"><code>mvn site</code></pre> |
| |
| |
| <p> |
| Afterwards, you should get something like: |
| </p> |
| |
| <pre class="prettyprint"><code>BUILD SUCCESSFUL |
| Total time: 20 seconds</code></pre> |
| |
| |
| <p> |
| You will find the built HTML in <code>$PATH_TO_MODULE/target/site</code>. |
| </p> |
| </li> |
| |
| |
| <li> |
| <strong>Make Your Changes:</strong> |
| The docs are written using the Anakia Xdoc format, which you can learn about |
| <a href="http://maven.apache.org/doxia/references/xdoc-format.html" class="externalLink">here</a>. |
| The source files are found in the <code>$PATH_TO_MODULE/xdocs</code> directory, |
| each xml file corresponding to the generated html file. |
| Menu information is found in the <code>src/site/site.xml</code> files. |
| </li> |
| |
| |
| <li> |
| <strong>Make A Patch:</strong> |
| |
| <pre class="prettyprint"><code>git diff > name_of_patch.patch</code></pre> |
| </li> |
| |
| |
| <li> |
| <strong>Submit Your Changes:</strong> |
| If you have a patch, log in to our <a href="http://issues.apache.org//jira/browse/TRB" class="externalLink">issue tracker</a> |
| and create a new issue.A project committer will |
| approve the patch and apply it, or let you know if something |
| should be changed. |
| </li> |
| |
| |
| <li><strong>Thank you for helping out!</strong></li> |
| </ol> |
| </section> |
| </section> |
| |
| |
| </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>© 2000–2025 |
| <a href="https://turbine.apache.org/">Apache Software Foundation</a> |
| </p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
