Bacula-users

[Bacula-users] Documentation

2009-11-04 12:33:30
Subject: [Bacula-users] Documentation
From: Kern Sibbald <kern AT sibbald DOT com>
To: Martin Simmons <martin AT lispworks DOT com>, "bacula-users" <bacula-users AT lists.sourceforge DOT net>
Date: Wed, 4 Nov 2009 18:28:36 +0100
Hello,

I have made a first cut at reorganizing the Development version of the manual 
back into fewer pieces.  Previously we had:

# Concepts and Overview Guide 
# Installation and Configuration Guide 
# Console and Operators Guide 
# Problem Resolution Guide 
# Catalog Database Guide
# Utility Programs 
# Developers' Guide

After the rearrangement, we have:

# Bacula Main Reference Guide  PDF  /HTML
# Console and Operators Guide PDF /HTML
# Problem Resolution Guide PDF /HTML
# Utility Programs PDF /HTML
# Developers' Guide PDF /HTML
# Miscellaneous Guide PDF /HTML

This is a sort of first cut.  The Console manual is currently missing some of 
the GUI stuff that I would like to put into it.

Apart from that, there are fewer manuals because I combined the
Concepts, Installation, and Catalog manuals.  The new Miscellaneous Guide is 
basically either old stuff or features that will probably go away.

It would be possible to combine the Console, Problem, and Utility manuals into 
the new Main manual, but at this point, I am a bit undecided.  Also, long 
term, if we keep the Problem manual, it would be good to clean it up and move 
some of the problem stuff out of the Main manual.

You can see them under "Manuals for Version 3.1.x (currently under 
development)  on the web site at:

http://www.bacula.org/en?page=Documentation

Note: until I am sure what we want, I don't plan to re-organize any of the 
translations, but in the end they should be all organized the same way.

What do you think?

Best regards, 

Kern


On Wednesday 21 October 2009 23:58:03 Martin Simmons wrote:
> >>>>> On Wed, 21 Oct 2009 21:53:50 +0200, Kern Sibbald said:
> >
> > On Wednesday 21 October 2009 20:46:00 Bob Hetzel wrote:
> > > I added --libdir=/usr/lib64 to my CFLAGS and that seems to have solved
> > > it. Perhaps something about that should be added to the manual about
> > > that.
> >
> > It has been documented since release 3.0.0 in the New Features chapter of
> > the manual.
> >
> > http://www.bacula.org/3.0.x-manuals/en/concepts/concepts/New_Features.htm
> >l#SECTION00350000000000000000
>
> LOL, that's exactly where I would look for it too :-)
>
> While I'm moaning about the documentation, I'd like to request that you
> please undo the splitting of the old User's Manual into multiple books. 
> I've given up looking in the 3.x manuals for anything because it drives me
> mad:
>
> - The split points make little sense.  Choosing the right manual is
> guesswork.
>
> - Cross-manual links in the 3.0.x HTML are broken.
>
> - Cross-manual links in the 3.1.x HTML are not HTML links at all.  They use
>   words, which are often different from the titles in the supposed
> destination of the link (this was a problem in 2.x, but at least the HTML
> did its job).
>
> - It is unlikely to ever work usefully in the PDF.
>
> The latest example was bootstrap file use in bextract.
>
> __Martin



------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day 
trial. Simplify your report design, integration and deployment - and focus on 
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Bacula-users mailing list
Bacula-users AT lists.sourceforge DOT net
https://lists.sourceforge.net/lists/listinfo/bacula-users

<Prev in Thread] Current Thread [Next in Thread>