Documentation: Cruft Remover

[Matthew East]

Hi,

On Fri, Apr 17, 2009 at 2:15 PM, DB Cummings
<dbcummings3374 at prochristo.com> wrote:
> I see a need for document for the Cruft Remove package.  I would like to
> provide assistance with this if possible.

I think that's a good idea, it's not a completely straightforward
program to use and people will expect to see documentation.

The documentation should either be added directly to the
computer-janitor program, or the ubuntu-docs package. An example of
another program where we do the latter is the "Hardware Drivers"
program.

If computer-janitor is intended to be an upstream program so that it
will be released with other distributions, then I'd recommend the
former; if it's a program which will just be included in Ubuntu (or
other Ubuntu flavours) then I'd recommend the latter. Obviously the
document could also be reused by other Ubuntu flavours that ship the
program (I don't know whether Kubuntu includes it, for example).

If we adopt the latter course, then we'll need to decide where to
include the documentation within ubuntu-docs. In my opinion, the
appropriate place would be to add a section to the "Removing an
application" section in the "Adding, Removing and Updating
Applications" document.

In either case a help button can then be added to the computer-janitor
(-gtk) program to point at the documentation.

I'm copying in the maintainer for his comments too, as you will no
doubt need to work with him to ensure that what is produced is
accurate.

It would be helpful if you could file a bug on ubuntu-docs so that we
can track the work on this particular task.

-- 
Matthew East
http://www.mdke.org
gnupg pub 1024D/0E6B06FF