[PATCH] UDG: Begins book->help pages conversion
Matthew East
mdke at ubuntu.com
Mon Aug 7 09:15:31 UTC 2006
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Hi,
* Matthew Paul Thomas:
> Matthew East wrote:
>> ...
>> If we are going to use ghelp: links to refer to other articles in the
>> help system, and start integrating some of the upstream manuals into the
>> body of the desktop guide, I think the answer is to retire books
>> entirely for now.
>>
>> Sorry to see it go of course, but there is not enough time before edgy
>> to work on both a good help system and a good set of books. Maybe in
>> future releases we can start to work on both.
>> ...
>
> So here's a patch to start the conversion of the Ubuntu Desktop Guide
> from a book into a categorized collection of help pages, by removing the
> preface. Here's where each part went.
I've applied the patch and done some changes of my own. The principal
one is removing the "About Ubuntu" section in Getting Started, this is
redundant with the About Ubuntu document on the front page of yelp.
> * "Contributing and Feedback": Now in its own "How you can help"
> section. Again, this is temporary, but I think it would be quite
> shippable if I got hit by a bus tomorrow and nobody made further
> changes.
I've changed this from a chapter to an appendix (because otherwise the
table of contents was numbered like this: 1, 2, 3, A, B, 4. But it got
me thinking more: do we actually want a chapter in the desktop section
about contributing and feedback? It should be part of the "contribute"
document on the front page of yelp, so maybe we can remove it. The case
for that becomes especially compelling if some kind of feedback
mechanism can be integrated with yelp.
Another thing, those appendices are pretty ugly, do we really need to
reproduce each licence in an appendix like that? How about if we shipped
them with the system as articles and linked to them from the "About this
document" page? I'll take a look to see if this is appropriate legally
speaking. What do people think?
> After this I'll go to work on rearranging the "Getting Started" and
> "Common Tasks" sections into more useful categories.
Do you want to list some ideas you have for useful categories in an
email so that we can discuss them before implementing?
Matt
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2.2 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org
iD8DBQFE1wSytSaF0w5rBv8RAjkVAJ9hVwkwICJDYAUa0gvNqkQJlTvd4gCePZtz
AR5SUJQjN+ZSYwXTR9R13RQ=
=uWEj
-----END PGP SIGNATURE-----
More information about the ubuntu-doc
mailing list