[Swift-devel] Swift Documentation Platform

[Michael Wilde]

----- Original Message -----
> Building this list is a good start. Where should we store it?

Same web as the ReleasePlan:

  https://sites.google.com/site/swiftdevel/release-plans

which is where we should move:

  https://sites.google.com/site/swiftparallelscripting/swift-docs-todos
> 
> You could also add the other CoG and Karajan docs.
> 
> As of Wednesday we decided we are giving up on Google Sites for user
> documentation, but we are going to continue with the swift-devel site
> for
> internal (but publically-readable) notes.

This sounds good. If any pages there need to be private to the group, they can.

Maybe one more sites/ web: swftgroup for internal group matters unrelated to swift.

> We're thinking of putting at least a month into asciidoc. Once we have
> that in place, we should be able to easily paste things into there
> from
> any source.

With a few guidelines, we can try editing a few of the doc items in transit from the cookbook into asciidoc.  We dont need the whole doc toolchain working: just enough to generate eg an html page or pdf.

Is that something we can do soon? We'd need to start and maintain a content writing guide and some references to asciidoc.

Then we need a way to separate the "core web" from "per release" documents.

- Mike


- Mike



> 
> Justin
> 
> On Fri, 1 Apr 2011, Ketan Maheshwari wrote:
> 
> > Hi,
> >
> > While we close in on a decision, I am writing this as an observation
> > to
> > the ongoing discussion about Swift Documentation Platform. And some
> > thoughts in the end.
> >
> > As of now we have a Main, existing Swift Documentation page:
> >
> > [1] http://www.ci.uchicago.edu/swift/docs/index.php
> >
> > In addition, we have pages on CI wiki related to Swift
> > documentations:
> >
> >
> > [2] http://www.ci.uchicago.edu/wiki/bin/view/SWFT/WebHome
> >
> > The above link contains many useful but semi-complete/unrounded
> > pages on
> > cookbooks, tutorials and may technical notes.
> >
> >
> > We have a page on cog wiki dedicated to Coasters:
> >
> > [3] http://wiki.cogkit.org/wiki/Coasters
> >
> > The pictures are very neat but slightly outdated and needs update.
> > More
> > pictures would also be required in my opinion to explain several of
> > the
> > relatively new coasters concepts.
> >
> >
> > We have google sites whose contents overlap with [1] , likely that
> > it is
> > completely redundant to [1]
> >
> > [4] https://sites.google.com/site/swiftguide/home
> >
> >
> > A wealth of information about Swift techniques, examples, issues,
> > notes
> > and ideas are living on the following: [5]
> > https://bugzilla.mcs.anl.gov/swift/
> >
> > [6] mail.ci.uchicago.edu/pipermail/swift-user
> >
> > [7] http://mail.ci.uchicago.edu/pipermail/swift-devel/
> >
> > [8] Mike's Swift Notes (As an attached doc)
> 
> --
> Justin M Wozniak
> _______________________________________________
> 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