This is an informal list of suggested improvements to the Tapestry 5 site documentation – things to work on soon. Most of these have come from users on the Tapestry Users mailing list.
{float:right|background=#eee}
{contentbylabel:title=Related Articles|showLabels=false|showSpace=false|labels=plans}
{float}
These are merely suggestions from Tapestry users. Some might be bad ideas. Consider carefully which of these ought to be done and how, and start a discussion on the dev mailing list about any change that could be controversial.
||Completed||Priority||Locked||CreatedDate||CompletedDate||Assignee||Name||
|F|H|F| | | |Need more cross-linking between the wiki pages, especially between FAQ pages, User Guide pages, Cheat Sheet pages and Cookbook pages that cover the same topic.|
|F|M|F| | | |[Component Cheat Sheet] should have, for each of the listed annotations, a link to the corresponding API page.|
|F|M|F| | | |Some pages don't link to all of their child pages|
|F|M|F| | | |Move some of the best MoinMoin wiki content into Confluence?|
|F|M|F|1290869296693| | |Need an article on clustering & high availability, then link to it from the clustering sections of [Persistent Page Data], [IoC - serialization], [Persistent State], [HTTPS], and other pages that mention clustering|
|F|M|F|1290869418470| | |Need a "Support" page that lists support options. This is where the mailing lists should be mentioned., as well as Howard's trainig, etc|
|F|M|F|1290872794706| | |The links to "Tapestry Home" in the breadcrums on pages like [Tutorial] link to the "Home" page but should link to the index.html page|
|F|M|F|1290872892940| | |Make it more obvious how to contribute to documentation improvements|
|T|M|F|1290873286462|1291053687265|javier@anatomicsoft.com|in the "create your first tapestry project" tutorial, don't make the user choose an archetype or a tapestry version. Write the instructions for the latest stable version. It's better to have that be out of date when a new version comes out (because it still will work) than have the user decide at this stage. Same for the groupId, artifactId, version and package. It's a test project the user is creating, those values are not going to matter. Give the defaults so people can copy and paste the command and have the project created, built and run.|
|T|M|F|1290873334655|1291036593723|javier@anatomicsoft.com|After the test project has been created, give the user some pointers on where to find things (pages go in src/main/java/com/example/pages, page templates go in webapp). Although there is a link to the tutorial, if this first experience is too frustrating, people might not even bother to go there.|
|F|M|F|1290873345788| | |add something to the archetype with commented out code that the user can uncomment and see something cool happen. It has to be a few lines only, to be easily understandable, and clearly link components in the template with their methods in the page class.|
|F|M|F|1290873360243| | |the tapestry tutorial starts unnecessarily verbose about topics not really related to me getting code running and out the door. Strip it to the essentials. If you want to mention Struts and the Servlet API compared to the tapestry way, mention them in a separate chapter so they are easy to find / skip as needed.|
|F|M|F|1290873372769| | |there is no table of contents for the tutorial and no indication of how long it takes to complete|
|F|M|F|1290873390989| | |There are too many callouts, warnings and decorations in the tutorial. It is very distracting visually and that makes it hard to follow. It's impossible to scan the pages to get a feel for what you've got ahead of you.|
|F|M|F|1290873483266| | |Add a page about testing your Tapestry app (not just testing of pages)|
|F|M|F|1290873573643| | |On the ComponentCheetSheet, add a sentance or two more on each annotation would be great.|
|T|M|F|1290873630472|1418608629709|bobharner|The tutorial Setting up your environment should be improved. Alternatives should be described on how to run T5 apps in the Eclipse or other IDEs, but not in the text as that would make it too long. I think there should be links for alternative setups - like how to run the T5 app from a main class and even start VisualVM for early debugging and optimizing (each alternative has pros and cons). There is no mention of m2eclipse plugin. Of course one can use JDK 6 also - only 1.5 is there. There is a sentence: "You should not have to download this directly". Why are then download links on the download page and no mention of maven at the same time. It is confusing for newbs.|
|F|M|F|1290873682697| | |Add a link to JIRA in the About page|
|F|M|F|1290954416064| | |Resolve the TODO at the bottom of [Component Classes] ("May want a more complex check; what if user uses prop: in the template and there's a conflict?")|