Re: [Boa Constr] I give up, where are the docs?

[Steve N. <yah...@yo...>]

On Thu, 10 Oct 2002 23:59:23 +0100 Andy Robinson wrote:

I made the same mistake, I read about Boa on different lists and the advice was to get the CVS version.  So I basically ignored everything else on the site expecting the relevant docs to be in /Docs CVS then got really confused as to which ones would be the most up to date.

This was also the first time I had ever tried something from CVS as I normally avoid extra problems caused by using bleeding edge but I had read Boa CVS should be ok and the most up to date thing to use.  If I had found the Docs quicker getting started might not have been so troublesome.

Thanks again Riaan for your replies to the list and helping to get things going for everyone with problems.  I know how time consuming this can be.

Steve.


> As a total boa newbie starting from Sourceforge, I guess the 
> mistakes I made may be repeated but are very easy to fix. 
> Here's the false trail I followed, and some small steps 
> which might help...
> 
> 1. I saw that the last download on SF was 9 months old. 
> So I got a CVS copy.
> 
> 2. I quickly found a 'docs' directory which was empty. There
> was 14-month olds stuff in the CVS attic but I presumed it
> was deleted for a reason.
> 
> 3. I looked again at SF which had three 0.1.0 downloads:
>    boa-constructor-0.1.0-alpha.docs.exe
> Sounded like a good place to get docs...  it contains Python, 
> wxPython and CVS docs but no Boa docs.
> 
> Now someone told me they were in the 'src' distro from January,
> and hey presto I have a manual - and a really nice one too!  
> well done!  
> 
> > I still see the bundled Python/wxPython/Zope help as optional
> > and the Boa app/tutorial help as part of the core.
> Yup, I'd go with that.  Just explain on the project web page
> thaty the 'docs' one is really "additional docs for other stuff
> but in wx-friendly format"
> 
> > 
> > I suppose what I'll do next time is to move the the core docs out
> > of the source distro as a seperate docs download. 
> > (unless some has a better suggestion!)
> 
> No, don't do that!   
> 
> > Moving the core docs back into CVS would probably also help a lot.
> 
> Yup :-)  Or at the very least insert a file 00readme.txt in the 'docs'
> directory telling people where they can get them.  This should be
> in every "distribution".  My naive expectation is that a 'source'
> distro is exactly like a CVS snapshot, only without CVS subdirectories
> and at a 'good' point in time.