tag:blogger.com,1999:blog-4110180.post6782680780680751322..comments2023-06-20T05:31:24.545-07:00Comments on Tapestry Central: Tapestry Frequently Asked QuestionsAnonymoushttp://www.blogger.com/profile/04486596490758986709noreply@blogger.comBlogger4125tag:blogger.com,1999:blog-4110180.post-32621685880534684082010-08-19T08:54:38.290-07:002010-08-19T08:54:38.290-07:00@Lance: Tapestry has excellent JavaDoc, supplement...@Lance: Tapestry has excellent JavaDoc, supplemented by specialized annotations just to express details such as the configuration type. What's missing is a higher-order description of how the key services work together. I have documentation for that in my Workshop.<br /><br />I'm actually excited about the Confluence wiki for documentation, partly because it integrates with Griffy to create detailed charts and diagrams relatively seamlessly.<br /><br />Tapestry has about 120 services built in, and one of my clients' applications starts up with about 600 services (many of which are actually Quartz jobs).Anonymoushttps://www.blogger.com/profile/04486596490758986709noreply@blogger.comtag:blogger.com,1999:blog-4110180.post-54550426096772911682010-08-19T02:18:45.979-07:002010-08-19T02:18:45.979-07:00Tapestry is a very configurable beast with many wa...Tapestry is a very configurable beast with many ways to override the default behaviour. It would be great to have a list of all the services that can be overridden or contributed to and the type of configuration (mapped, ordered, unordered) required. Perhaps a build time task could grep the codebase for this information?Unknownhttps://www.blogger.com/profile/17970877454250397564noreply@blogger.comtag:blogger.com,1999:blog-4110180.post-47911282641366377922010-08-18T10:39:41.866-07:002010-08-18T10:39:41.866-07:00A FAQ can be one part of your documentation, but i...A FAQ can be one part of your documentation, but it shouldn't be the backbone of your docs.<br /><br />Think about learning a new language (a human language, not a computer one.) Generally speaking, handing you only a dictionary on day 1 isn't going to make you a fluent speaker. You may need a series of examples, from simple to more complex, and an understanding of the concepts (and culture) before you can start constructing meaningful sentences and talk about new things.<br /><br />At a minimum, Tapestry could use:<br />- A quick start tutorial or two, just to get new adopters up and running.<br />- A guide to the major concepts and usage patterns within Tapestry (with examples)<br />- Enough information on the major components that a relatively new user can put them to use. In some case, this may even require a component-speciifc guide if the component is complex enough.<br />- The Javadocs (which you do a lovely job on)<br /><br />...and then the FAQ to fill in gaps between the reference docs and the formal guides. A FAQ can document a common pitfall or question that doesn't fit naturally into the other documentation.<br /><br />...RichardAnonymousnoreply@blogger.comtag:blogger.com,1999:blog-4110180.post-69300230304624160052010-08-18T03:46:49.783-07:002010-08-18T03:46:49.783-07:00FAQ is definitely not the best way of documenting ...FAQ is definitely not the best way of documenting an open source project. Personally I always start reading User's Guide which "guides you" with the initial steps and beyond.<br /><br />Next, a cook book is something I always look for, as FAQ usually only suggests the solution, not solves it, many times assuming the reader understands every word in the Answer.<br /><br />As a long time Tapestry observer/user I very much miss good and accurate components documentation. That includes several use cases for every component and how to use them with best practices.<br /><br />What I really do not understand is why Tapestry does not include numerous components developed by the community and T5 core commiters? Why there is no some kind of plan which components should be included in next versions? There are only two new components and two mixins in T5.2 which was developed for 14 months. I know I could contribute, but I just do not understand why for example there is no Tree component included just for example. And there are tons of others wished for (http://www.questionpro.com/akira/ShowResults?id=1151880&mode=data).<br /><br />Isn't there a mojor rewrite going on for Tapestry official page?<br /><br />And I wish forward for the translated book!<br /><br />End of big T5 fan rant.Anonymoushttps://www.blogger.com/profile/05963508383930374887noreply@blogger.com