[Swift-devel] Website documentation

[Michael Wilde]

Yes, indeed. We also have a long list of changes we want to make in the user guide; some of these are in bugzilla; others are in private notes we need to turn into doc bugs. 


Ben's initial Users Guide has served us well, but now its time for some major (but incremental) revamping. 


Some of the material from the ParCo paper can go into the Users Guide. 


Also: 
- more thorough explanation of the basic data and execution model 
- more clear explanation of mapping (ParCo has some of that) with more examples and explanations of techniques 
- improved diagrams of the runtime environment 
- more explanation of runtime environment issues like retry and replication (beyond whats in the properties descriptions) 
- lots of clarification needed on Coasters and providers in general 
- section on script development and debugging 
- annotated examples (can start with ParCo examples; need some simpler ones too) 


In general - much work ahead of us here. 


- Mike 






----- Original Message -----


We need someone new to go through this... Perhaps we could ask Lorenzo to do this? 


Just skimming... 


I think the table is 2.11 should only have one operator in each row 


I'm unclear about the first table in 3.1. perhaps there should be some code or text before it? 











On May 4, 2011, at 3:58 PM, David Kelly wrote: 


Hello, 


I just finished the preliminary version of the user guide in asciidoc. It is at http://www.ci.uchicago.edu/~davidk/userguide.html . The asciidoc source is at http://www.ci.uchicago.edu/~davidk/userguide.txt . 


David 

_______________________________________________ 
Swift-devel mailing list 
Swift-devel at ci.uchicago.edu 
http://mail.ci.uchicago.edu/mailman/listinfo/swift-devel 





-- 








Daniel S. Katz 
University of Chicago 
(773) 834-7186 (voice) 
(773) 834-6818 (fax) 
d.katz at ieee.org or dsk at ci.uchicago.edu 
http://www.ci.uchicago.edu/~dsk/ 





_______________________________________________ 
Swift-devel mailing list 
Swift-devel at ci.uchicago.edu 
http://mail.ci.uchicago.edu/mailman/listinfo/swift-devel 



-- 
Michael Wilde 
Computation Institute, University of Chicago 
Mathematics and Computer Science Division 
Argonne National Laboratory 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mcs.anl.gov/pipermail/swift-devel/attachments/20110505/2b71366f/attachment.html>