The Bugsquad documentation , from Wiki to PDF

[Bruno Girin]

2010/1/25 Mathieu Comandon <strycore at gmail.com>:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> Hello Bug Squad team
>
> I wanted to get more involved with the Bug Squad but I've always found
> it hard to get anything from the Wiki. I always get to the point where
> I have more than 10 open tabs on Firefox and I rarely finish reading
> any page. There's always an hyperlink getting in the way, begging to
> be clicked, promising new hidden knowledge.
>
> On my agenda I had planned to read every single page from the Bug
> Squad knowledge base, but it still didn't help. So I started making a
> flat document out of all this documentation. I like books or PDFs more
> than Wikis, especially if there's a lot to learn. Books have a start
> and an end, you can continue where you left when you stopped reading,
> you're not reading 10 pages at the same time and you know how many
> pages are left before you finish.

That's a great idea! A PDF can also be downloaded locally so that you
have the info at your fingertips even when no connected to the net.

>
> I try putting pages in a coherent order and I avoid making forward
> references. Besides reorganizing the pages, I also format the pages so
> that they look good in Open Office, remove hyperlinks when they are
> not necessary or put them as footnotes. I intend to add every page
> from https://wiki.ubuntu.com/CategoryBugSquad in this document (except
> IRC logs). There might be a few pages that are not related to bug
> management if necessary (i.e. from CategoryUbuntuDevelopment ).

If you are re-organising or re-wording part of it, it would make sense
to feed it back to the wiki. In particular, I like your diagrams on
page 7.

>
> This is also a very good way for me to learn about dealing with bugs
> in Ubuntu. Bug Triage won't have any secrets for me when I finish this ;)
> When it's ready, it might be a good idea to make a  deb package out of
> it and include it in the repos.
>
> A sneak preview of the work done so far can be fetched here :
> http://strycore.com/ubuntu-bugs.pdf
>
> Hope you like the idea :)

This is a great idea! My only concern is how do we ensure that the PDF
and the wiki are in sync? It looks like a lot of manual work so it is
likely to get out of sync as soon as the wiki gets updated. Anyway,
that's a problem we can solve later.

On a related subject, would it make sense to also distribute that sort
of information as an Ubuntu Help Centre additional package?

Bruno