[occi-wg] Current work on documentation

[Thijs Metsch]

Hi,

Thanks for the remarks. I will create a README file and put it in the
repository. 

There is also a Makefile for Linux based systems called Makefile.linux

Please when updating the files also upload a new version of the PDF. It
is linked from occi-wg.org - so people will always get the current
version :-)

Cheers,

-Thijs


On Thu, 2009-07-16 at 05:21 +0200, Sam Johnston wrote:
> Thanks Thijs.
> 
> Here's a few potential gotchas:
> 
>  - occi-book.xml is the master (which transparently pulls in articles
> using xinclude)
> - occi-book.html should be a recent rendering but may lag a little.
>  - the walkthrough will always lag behind the API.
>  - the API will always lag behind current thinking (but hopefully not
> by much - if in doubt ask on the list)
>  - Makefile was made for mac. If it doesn't work for you then get a
> mac. Or set the XML variable.
> - For those who do use a mac XMLmind does what it says on the tin.
>  - The DocBook guide (tdg5) is a must have.
>  - The PDF transforms weren't working for me after splitting the
> document (which was formerly occi.xml) but apparently work for Thijs.
> Expect XIncludes aren't perfect but no expert on them.
> 
> Sam on iPhone
> 
> On Wednesday, July 15, 2009, Thijs Metsch <Thijs.Metsch at sun.com> wrote:
> >
> > Hi guys,
> >
> > This is the current version of the document which I created from the
> > source on gridforge.
> >
> > It currently contains all the information we are about the write up.
> > Later on it will be slitted in the two documents described below.
> >
> > All the best,
> >
> > -Thijs
> >
> >
> > On Wed, 2009-07-15 at 16:49 +0200, Thijs Metsch wrote:
> >> Hi guys,
> >>
> >> I just wanted to give a short update on process of documentation. These
> >> are the things we are currently working on. We have two documents which
> >> will be released by OGF27.
> >>
> >> Those document will be called:
> >>
> >> - Open Cloud Computing Interface Specification
> >>
> >> - Open Cloud Computing Interface - Usecases and requirements for a Cloud
> >> interface
> >>
> >> The first document is the writeup of the OCCI API while the second
> >> documents sums up the requirements and use cases we have. The first
> >> document will be structured like this - so this is how we present OCCI:
> >>
> >> * Introduction
> >> * OCCI Walkthrough
> >>   * Overview
> >>   * Getting started
> >>   * Operations
> >>   * Collections
> >> * OCCI core specification
> >>   * Basics
> >>   * Extensions
> >>   * Examples
> >> * Infrastructure
> >>   * Nouns
> >>      * Compute
> >>      * Storage
> >>      * Network
> >> * OCCI Registries
> >>
> >> It is important that we get this right - so to say that we can give this
> >> document to a implementor and he can implement it easily while just
> >> reading this document!
> >>
> >> Andy, Andre, Sam and me are working on this documents right now - but
> >> feel free to join or comment to us and the mailing-list.
> >>
> >> If you want to look at the current working copy of the document the
> >> sources can be found in the gridforge:
> >>
> >> http://forge.ogf.org/sf/scm/do/viewRepositorySource/projects.occi-wg/scm.Open_Cloud_Computing_Interface
> >>
> >> We are writing this up using docbook. The main article is called
> >> occi-book.xml which includes all the further articles. With the help of
> >> the Makefile you can create html and pdf versions of all the content.
> >>
> >> Sam and Andy will also send an update on the changes made to the version
> >> of in Wiki!
> >>
> >> All the best,
> >>
> >> -Thijs
> >>
> > --
> > Thijs Metsch                        Tel: +49 (0)941 3075-122 (x60122)
> > http://blogs.sun.com/intheclouds
> > Software Engineer Grid Computing
> > Sun Microsystems GmbH
> > Dr.-Leo-Ritter-Str. 7               mailto:thijs.metsch at sun.com
> > D-93049 Regensburg                  http://www.sun.com
> >
> _______________________________________________
> occi-wg mailing list
> occi-wg at ogf.org
> http://www.ogf.org/mailman/listinfo/occi-wg
-- 
Thijs Metsch                        Tel: +49 (0)941 3075-122 (x60122)
http://blogs.sun.com/intheclouds
Software Engineer Grid Computing
Sun Microsystems GmbH
Dr.-Leo-Ritter-Str. 7               mailto:thijs.metsch at sun.com
D-93049 Regensburg                  http://www.sun.com