Re: Documentation Status?

Hi Yak,

Welcome to bc team!

Yak Mandango wrote:
> What's the status of BinaryCloud's documentation?  Is it broken,
> partial, planned...? 

Docsite (docs.binarycloud.com) used to work with rc3, current cvs
version (the one that will become rc4) dropped phing; and new docsite
was not updated use latest cvs code :/ so it's broken.

> It seems that the project is in need of someone to
> document, but already has some.

Yes we need someone to help on this; yes we already have some doc
written (cookbooks on binarycloud.com and plain docs in each
package/docs dir) but nobody currently cares of updating docs.

> Is there API documentation that can be
> auto-generated with some tool?  How can I do that? 

Yes there was a tool to do it till rc3. Did you try to download rc3
tarball and build api with phing ? phpdoc makes it quite well.

> ...or is the best
> place to learn simply source?

You can examine latest cvs code of sure, and the matching tickets in the
trac/svn system (svn.binarycloud.com).

> I'd really like to use in my currently-developing web app., but my team
> and I are lost without doc's.  I've read that I should be able to write
> a shell script to build the docsite from legacy.  I've tried this and
> failed; I think I'd rather need the documentation to understand how to
> write the script.  I've been looking around for a few weeks on the
> website, in mailing lists, in HEAD from svn, and in an older SVN release
> (from mid-February).  I have found:
> 
>     * Public site
>           o Quickstart Guide (current?)
>           o Package Documentation (broken)
>           o API Documentation (broken)
>           o Cookbook (HowTos) (current?  legacy or...?)
>           o Draft & Proposals (current, and future)
>     * "Legacy" docsite (broken)
>     * Mid-February svn co docsite (broken?)
>     * HEAD docsite (broken)

And see Manual's ticket announcing a doc system change:
https://svn.binarycloud.com/trac/ticket/198
https://svn.binarycloud.com/trac/ticket/121
and the code committed into r3/trunk/tools/scripture/

Alex, maybe you have another idea for docs ?

> I'm sorry for posting this "newbie" mail to the dev list.  Is there
> somewhere else it could go, perhaps a "users" list?

No, you're right to do it, we have a unique common list atm.

-- 
Jean-Christophe Michel
_______________________________________________
dev mailing list
dev-PnctHDZWAvB/Cz2I37pSEPZ4XP/[email protected]
http://lists.binarycloud.com/mailman/listinfo/dev