public inbox for [email protected]  

help / color / mirror / Atom feed

From: Tom Lane <[email protected]>
To: Bruce Momjian <[email protected]>
Cc: Rafael Martinez <[email protected]>
Cc: [email protected]
Subject: Re: Documentation and explanatory diagrams
Date: Wed, 30 Jun 2010 19:16:23 -0400
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>

Bruce Momjian <[email protected]> writes:
> Rafael Martinez wrote:
>> I am sending you a proposal with 13 diagrams to include in the manual so
>> we can get an idea of how it will be. If it gets approved I will spend
>> more time creating and including other diagrams and improving the build
>> process for including figures into the manual.

> Great!

Where are the DIA sources for these?  It's impossible to evaluate how
maintainable these will be without seeing the source code.

>> If this proposal gets accepted we should work with:
>> - - Automatic generation of PNG files from DIA source under the build
>> process of the manual.

> I don't think we want to require dia to build the docs, so we are going
> to keep the dia and png files in CVS.

Yeah, probably, at least for the first go-round.

> Also, there are two images that need to be updated for every major
> release;  is that something we want to commit to doing?

-1 on that.  The timeline thing is *certainly* not worth the maintenance
effort, if indeed it even belongs in the docs at all (it looks more like
marketing material).  I think the lines-of-code diagram is not worth its
keep either.

One minor comment is that the page_layout diagram should say BLCKSZ not
8K, and the different-colored arrows in it don't really convey much ---
they need on-image labeling I think.

			regards, tom lane

view thread (114+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected]
  Subject: Re: Documentation and explanatory diagrams
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox