Documentation: We're looking for contributions

Hi,

We are focusing on writing documentation for Iliad.
The process is in two steps:

- Write the documentation with texinfo (in the doc/ directory on github)
- add comments for undocumented classes and methods of the API.

Now, we are looking for contributors. If you want to help but don't know
texinfo, no problem, even txt files are good. Also, just re-reading and
checking what we write is a big help too :)

Anyone interested?

Thanks,
Nico
--
Nicolas Petton
Objectfusion S.A.R.L.
Applications Web, Design
http://www.objectfusion.fr

This is great news! Although I won't be able to find time for writing
from scratch I might do some checking :)

Some suggestions:

 - Writing a table of contents and a summary of what you are going to
mention under each chapter in 1-2 sentences beforehand makes things a
lot easier and organized. You know "when" you are going to mention
about some subject and be able to write current subject, accordingly.
It also makes you see the big picture.

 - Defining the target audience beforehand is also important. Are your
audience expected to know what "web programming" is? What "dynamic web
programming" is? What "web frameworks" are? Any prior web framework
knowledge like Seaside, RoR, Django? Etc...

On Oct 18, 11:19 am, Nicolas Petton <[hidden email]> wrote:

Le lundi 18 octobre 2010 à 01:52 -0700, ZuLuuuuuu a écrit :
> This is great news! Although I won't be able to find time for writing
> from scratch I might do some checking :)
Cool, thanks!

>
> Some suggestions:
>
>  - Writing a table of contents and a summary of what you are going to
> mention under each chapter in 1-2 sentences beforehand makes things a
> lot easier and organized. You know "when" you are going to mention
> about some subject and be able to write current subject, accordingly.
> It also makes you see the big picture.
Good idea, I'm going to do that!

>
>  - Defining the target audience beforehand is also important. Are your
> audience expected to know what "web programming" is? What "dynamic web
> programming" is? What "web frameworks" are? Any prior web framework
> knowledge like Seaside, RoR, Django? Etc...

I expect the audience to know Smalltalk and a bit of web development,
otherwise I won't ever be able to finish the doc.

Thanks,
Nico
--
Nicolas Petton
Objectfusion S.A.R.L.
Applications Web, Design
http://www.objectfusion.fr

I volunteer for writing some doc (again, but i'll find the time to do that this time !).

What i'll also do is, when porting from gst to Squeak/Pharo, is a summary of what does change between two releases (unless its already done but i think not).

-Steven Costiou-

Thanks guys!

You can either fork the iliad repository and write texi files, then send
me a pull request:

http://github.com/NicolasPetton/iliad

The documentation is in the doc/ directory.

Or you can just send .texi (or any other format, .odt, .txt, ...) files
here on the mailing-list (or privately), I'll put them in the doc
myself.

Cheers,
Nico
--
Nicolas Petton
Objectfusion S.A.R.L.
Applications Web, Design
http://www.objectfusion.fr

An early draft of the documentatio is available at
http://doc.iliadproject.org

Cheers,
Nicolas

On Mon, 18 Oct 2010 17:34:23 +0200
Nicolas Petton <[hidden email]> wrote:

> An early draft of the documentatio is available at
> http://doc.iliadproject.org

How do I know that the installation was successful?

        1.4 Testing the Installation

        Open http://localhost:8888/... in your browser. You should
        see something similar to the following screenshot.

s.

Le lundi 18 octobre 2010 à 19:00 +0200, Stefan Schmiedl a écrit :
Thanks, I'll add it :)

Cheers,
Nico