sloecode-dev team mailing list archive

[Christopher <veebers@xxxxxxxxx>]

On 24/02/11 08:45, Thomi Richards wrote:
> Hi,
>
> On 23 February 2011 22:35, Christopher<veebers@xxxxxxxxx>  wrote:
> > WRT the documentation (points 4&  5), how many clients are we looking at
> > providing help documentation for?
> Well, We have several project groups using the system at the moment. I
> think the thing to remember with the documentation is that there are
> 10 types of programmers: those that know how to use bazaar (and don't
> need the documentation), and those that don't, and need simple
> documentation.
Sorry I meant how many (and which) _bzr_ clients will we be targeting to 
get docos written for?
> > For example it could read something like:
> > * Blurb about Sloecode
> I think this should just go on the front page.
True, makes sense.
> > * Blurb about bzr
> > * Description/Introduction to bzr (well, VCS) way of life
> > * Outline of _our_ intended work-flow for those new to DVCS
> > -- Snip -
> Yes, although I think we need our documentation to be more targeted.
> Understandably, the official bzr documentation tries to cover all
> options and eventualities. I think we can get away with hiding most of
> the detail, especially since people who already know bzr won't be
> reading it.
I agree, it should really be narrow in focus, probably enough to get 
people going for 99% of simple cases (i.e. generalized work flows)
> > Totally agree with showing the repo details, should brainstorm what would be
> > good to have and prioritise that as well.
> I have an experimental branch that adds a branch log for all
> repositories. I think it's at lp:~thomir/sloecode/revision-info
> (that's from memory - look at LP if it's wrong). Right now it shows
> the last 10 revisions for every branch. I'm working on it to produce
> HTML (at the moment it's text output wrapped inside<pre>  tags...
> yuck!). Once it's done I'll merge it into trunk. I'm introducing
> adapter/facade classes around the bzrlib Repository&  Branch classes
> so we can get useful information out of bzrlib without having to pass
> these objects into template code.
Sweet, sounds good, keen to have shufti at that.
> Anyway, thanks for your input. I'm excited that we have something that
> works and is useful...
>
>
> Cheers,
No worries, good to see you excited :)
Chris