On Sun, Feb 22, 2009 at 12:12 AM, a.fowler <[email protected]> wrote: > > TG2 beta docs run-through issues > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > As I said most of your comments (sadly) come at at bad timing cause I was working on upgrading them. But here it goes.
> TG2 General: > ~~~~~~~~~~~~~ > > 1) Really need an updated version of the TG "flowchart" image that > shows how the various components fit together. (Perhaps reformatted to > more clearly show the request life-cycle, with TG, Pylons, and Paste > clearly delineated.) Although it's not very clear, see: > http://dev.catalyst.perl.org/attachment/wiki/WikiStart/catalyst-flow.png > mark pointed out the new doc for this. > 2) Quickstart generated code needs more detailed in-code > documentation. This is greatly needed to get new users up to speed.. > I made an explanation below we really want it to do less! > 3) What is the TG2 "API"?... other than @expose and returning the dict > () from a controller, how can/should I interact with the TurgoGears > stack from my code? > This is a common mistake people do between api and framework. you CALL a library, you work with a framework. as you said asp and php tend to use the 'calling' more, but others like 'java' and 'python' framework work more in the 'invoke' mode (the framework 'calls' your objects). So the proper answer here is you don't, you simply make your code look like what TG is expecting and it will call you. HINT: a controller subclass and @expose to indicate it's a "over the web callable" > 4) Need a TG2 specific tutorial that covers basic genshi template > building "from scratch". Those coming from a ASP/PHP background will > be very lost when trying to look at the quickstart'ed template files. > There is nothing TG specific about this. Remember part of the goals of TG is to reuse components, the genshi docs are great so why reinvent them? They have a whole website dedicated to it! http://genshi.edgewall.org/ > > TG2 Install: > ~~~~~~~~~~~~ > 1) Need an introduction "what we will do" summery for three common use > cases. (Win/Mac/Ubuntu) > done > 2) Why upgrade warning for virtualenv install? It's certainly a new > install, as this is a tutorial. (Perhaps re-word.) > huh? you mean the warning here http://www.turbogears.org/2.0/docs/main/DownloadInstall.html#install-turbogears-2 1- this is not supposed to be a new install it's for all installs the fact that it's new for you the first time doesn't means it's new for everyone 2- the warning is there because I (yes I did it) was totally tired of replying the same question in the ML, irc, etc. 3- most people think that install will upgrade TGs dependencies when it will not so it's better to introduce the -U flag to everyone the sooner the better. 4- Due to the way easy_install works running those instructions in two different time frames will render two potentially different sets of dependencies (new releases) therefore the -U is needed on the old venv. > 3) When installing pysqlite, the user must have the sqlite3 dev files > installed, as well. (sqlite3-dev package on Ubuntu) > This is no longer needed as pysqlite site gives the instructions but you should be using the ubuntu package (instead of easy_install pysqlite) > 4) Suggest, as an option, ipython. Since paster shell can use it. > this was there some time ago and was deleted because people though it was required. Install docs should have the least optional components IMO. > 5) The "Installing the development version of Turbogears 2" section > should have a paragraph, besides just a link. > This was overhauled it's now inlined, it was dump to have install instructions for dev in another page. Now all install is in the same page. > 6) Should have a closing paragraph with links to "quickstart" and > "Wiki20" tutorials. > Already there but install links to quickstart and that to wiki20. > > TG2 Quick Start tutorial: > ~~~~~~~~~~~~~~~~~~~~ > I didn't work on this part so I'm not sure if it's covered So yea, thanks for the feedback even though I had most of it covered, in a couple of minutes we'll have the new version up :) --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "TurboGears" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/turbogears?hl=en -~----------~----~----~----~------~----~------~--~---
