[Swift-devel] Re: Check tutorial/guide edits in and let student(s) know?
Michael Wilde
wilde at mcs.anl.gov
Tue Jun 1 09:39:09 CDT 2010
David, also to note: there is a procedure to push the content to the web server immediately; it would be good to test if that works for you, for future changes.
Also, before I forget: we now (as of about 6 months or so?) have both a development trunk and a stable branch in SVN. We need to decide which of these the online doc content lives in. At some point, we may need a separate doc version for both, and/or for each release. So would be good to plan for the directory structure for that.
- Mike
----- "David Kelly" <dk0966 at cs.ship.edu> wrote:
> Hello Mike,
>
> I checked in the changes to the tutorial and documentation through SVN
> this morning. From what I understand, everything should be updated on
> the site by tomorrow. I will send out an email to the other students
> to let them know.
>
> David
>
>
> On Sat, May 29, 2010 at 11:39 AM, Michael Wilde < wilde at mcs.anl.gov >
> wrote:
>
>
> David, since the current online tutorial is already broken, and yours
> is likely a big improvement, you should go ahead and check it in and
> make sure it gets posted to the live guides. (might need to add you to
> some unix group for that to work)
>
> Then work with the other summer students and the student that posted
> to the list on Friday, to get some feedback as to whether the tutorial
> is now error-free.
>
> Another thing that occurs: as the set of posted examples/tutorials
> grows, can we create a "recipe index" that indexes the examples by a
> categorized outline of commonly needed techniques and FAQs?
>
> Lastly: We may want to separate out examples (mainly for enhancing the
> user guide) from tutorials, where the latter would be mainly formatted
> as exercises that one could actually walk through, as opposed to
> examples that one simple reads, copies and tries.
>
> The latter (tutorials) are much more work and harder to test, and thus
> we could simply enhance the tutorials that already exist while we
> focus more on writing a larger set of tested and annotated examples.
>
> - Mike
--
Michael Wilde
Computation Institute, University of Chicago
Mathematics and Computer Science Division
Argonne National Laboratory
More information about the Swift-devel
mailing list