Re: [boost] location for PDF docs?

Subject: Re: [boost] location for PDF docs?
From: Paul A Bristow (pbristow_at_[hidden])
Date: 2008-11-04 04:53:30

>-----Original Message-----
>From: boost-bounces_at_[hidden] 
>[mailto:boost-bounces_at_[hidden]] On Behalf Of Eric Niebler
>Sent: 03 November 2008 19:19
>To: boost_at_[hidden]
>Subject: Re: [boost] location for PDF docs?

>I can think of two logical places to put the PDFs:
>   - A dedicated location under www.boost.org/doc
>   - Alongside the release tarballs on sourceforge.
>
>The problem with both of these locations is that average boost 
>developers do not have upload access. We can make it part of 
>the release 
>procedure that developers can optionally provide the release manager 
>with PDFs, but this is one more thing for developers to forget to do, 
>and more work for the release manager.
>
>Maybe both locations should have a link to documentation in alternate 
>formats,

Since we don't have an automatic indexing system for Quickbook (or other) documentation (A GSoC project?), the PDF version has a
distinct advantage in that one can use the PDF reader 'find' button.  As an author, I've found this lifesaving ;-)

 and the docs can actually be hosted someplace else. A logical 
>place would be http://boost.sf.net/doc -- any boost developer 
>can upload a file there.

The latter sounds a good place to me.  It is certainly a big hurdle for those new to Boost to download all of Boost just to access
the docs.

Might this also help by being better indexed by Google? (Thus helping potential users to see what's on offer).

(FWIW I note that googling "student t distribution Boost" gets us top of the page, student t distribution C++ doesn't do quite as
well).

We also want to reduce the hassle and time delay in getting documentation changes visible.  While we want to maintain tight control
on source code, making it easier to make documentation corrections and elucidations is good.

Paul

---
Paul A Bristow
Prizet Farmhouse, Kendal, Cumbria UK LA8 8AB
[phone] & SMS, Mobile [phone] & SMS
pbristow_at_[hidden]