Help with integrating Gnome docs into Ubuntu

[Jim Kissel]

Matthew East wrote:
> Daniel/Seb,
> 
> Looks like the Gnome team doesn't have any ideas about the below email -
> did you guys have any thoughts?

Matt,

Did you miss this on the gnome-doc-list?
<http://mail.gnome.org/archives/gnome-doc-list/2007-July/msg00003.html>
Hi,


A related issue with distro specific documentation is the location of 
items on menus. Each distro will in most cases customize where items 
appear on menus. And because of this customization vanilla gnome 
documentation does not contain the correct distro specific location for 
these items resulting in the distro having to manually fork the 
documentation, replace the menu location and ship the forked 
documentation. Thus making it difficult to pass back upstream changes 
made to documentation.

I proposed a patch that would help alleviate at least this portion of 
forking by utilizing xml2po in gnome-doc-utils, at build time for 
documentation to automatically replace the menu path within the 
documentation depending

on what the .desktop file contains.

Patch can be seen here :

    http://bugzilla.gnome.org/show_bug.cgi?id=336185

cheers

Matt


> 
> Matt
> 
> * Matthew East:
>> Hi there,
>>
>> To: Gnome doc lists
>> Cc: Ubuntu Gnome maintainers, Ubuntu doc list
>>
>> I'm looking for some advice.
>>
>> In Ubuntu, during the last release we incorporated the Gnome user guide
>> into the structure of our documentation. This has the advantage that we
>> don't have to worry about recreating the wheel and can use the excellent
>> material from upstream.
>>
>> The basic problem we are having though is that Ubuntu customises quite a
>> lot of Gnome, and as a result the Gnome documentation is wrong, and we
>> need to correct it. An example is the layout of the System menu, which
>> in Ubuntu does not contain the screenshot/lockscreen buttons, but which
>> are part of vanilla Gnome and therefore documented in the Gnome user guide.
>>
>> The two possible ways of correcting these are:
>>
>> 1. Creating patches on the Gnome documentation in the Ubuntu packages of
>> gnome-user-docs.
>> 2. Creating a separate tree with a copy of the Gnome documentation (to
>> be updated from time to time) and shipping it separately in a new
>> package, or with the Ubuntu-specific documentation.
>>
>> Both of these strike me as being quite difficult to maintain. I've never
>> tried to maintain patches on documentation before but I bet it's pretty
>> difficult.
>>
>> Read more about the problem here:
>> https://lists.ubuntu.com/archives/ubuntu-doc/2007-June/008624.html
>>
>> I'd very much appreciate your advice.
>>
>> Thanks!
>>
>> Matt
>>
>>
>> ------------------------------------------------------------------------
>>
>> _______________________________________________
>> gnome-doc-list mailing list
>> gnome-doc-list at gnome.org
>> http://mail.gnome.org/mailman/listinfo/gnome-doc-list
> 

-- 
Simple effective migration to Open Source based computing

Jim Kissel
Open Source Migrations Limited
w: http://www.osml.eu
e: jim.kissel at osml.eu
p: +44(0) 8703 301044
m: +44(0) 7976 411 679