Bacula-users

Re: [Bacula-users] Documentation

2009-11-07 02:58:54
Subject: Re: [Bacula-users] Documentation
From: Kern Sibbald <kern AT sibbald DOT com>
To: Martin Simmons <martin AT lispworks DOT com>
Date: Sat, 7 Nov 2009 08:55:10 +0100
On Friday 06 November 2009 23:30:11 Martin Simmons wrote:
> Thanks, that's a great improvement already!  The Console and Problem
> manuals should probably be be added to the main manual, so they can xref
> cleanly.  I think the Utility manual is less important because it less
> dependent on the others and hopefully won't be needed as often.

I'm still thinking whether to integrate the Console and the Problem manuals.  
It is a question of making the main manual too big and thus harder to find 
things versus the need for references, which in those two cases is probably 
not very important.

>
> The items in the "New Features in..." chapters need to be merged into the
> correct places.

Unfortunately, I don't expect that will happen any time soon.  There is no one 
available to do the work, and we have a good deal of work just to get 
everything for 3.2.0 into the New Features section by the end of the year. 

One of the most difficult tasks in Open Source software is to convince code 
submitters to contribute the documentation. Sadly, it often falls on 
the "core" developers.  For those of you who have submitted code *and* the 
documentation and there are fortunately some out there, many thanks :-)

>
> To make the translations more maintainable, I would give them the same
> structure and filenames as the English manuals.  Translating the
> filenames/URLs doesn't make sense to me, because they are technical
> details, not part of the manual.

The current translations have exactly the same structure and filenames as the 
old manuals.  The goal will be to convert them over to what the definitive 
new combined English manual structure, but it is a good deal of work, so it 
may have to wait in the same indefinitely long queue as the New Features 
unless some more help is found -- I will look at it though before the final 
3.2.0 release.

Best regards,

Kern

>
> __Martin
>
> >>>>> On Wed, 4 Nov 2009 18:28:36 +0100, Kern Sibbald said:
> >
> > 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>