Help with integrating Gnome docs into Ubuntu

[Jim Kissel]

Matthew East wrote:
> Hi,
> 
> * Matthew East:
>> Hi all,
>>
>> * Shaun McCance:
>>> On Sun, 2007-07-15 at 03:31 +1200, Matthew Paul Thomas wrote:
>>>> On Jul 5, 2007, at 7:30 PM, Matthew East wrote:
>>>>> ...
>>>>> 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.
>>>>> ...
>>>> There is a third way: Use distributed version control.
>>>>
>>>> The GDP could have its own branch, Ubuntu could have its own branch, 
>>>> and any other distributor that used a customized Gnome could have its 
>>>> own branch. Ubuntu could merge any useful changes from the GDP, while 
>>>> ignoring those that weren't relevant to Ubuntu. The GDP could merge any 
>>>> useful changes from Ubuntu, while ignoring those that apply to 
>>>> Ubuntu-specific customizations. And if two or more distributors made 
>>>> the same customizations, they could merge corresponding documentation 
>>>> changes from each other.
>> This is an interesting idea. I'd very much like to find out how easy it
>> is to merge/reject different changes from a branch while maintaining a
>> patch.
> 
> ...
> 
>> Ok, let's give this a go. I've arranged an import from svn to bzr
>> through Launchpad's semi-automatic feature:
>>
>> https://code.launchpad.net/~vcs-imports/gnome-user-docs/trunk
>>
>> The next step would be to try to create an Ubuntu-customised branch, and
>> to try and merge any updates coming into upstream which don't conflict
>> with such changes on a regular basis. I don't know much about how bzr
>> works so hopefully mpt will help out with that.
> 
> Right, I've created a branch which can potentially be used for Ubuntu
> customisations.
> 
> It can be found here:
> 
> https://code.launchpad.net/~ubuntu-doc/gnome-user-docs/ubuntu-changes
> 
> If anyone wants to roll with the idea and play around, members of the
> "ubuntu-doc" team can checkout and commit, and of course, anyone else
> can create another branch or a patch.
> 
> As yet I don't have any idea:
> 
> 1. How to go about packaging gnome-user-docs in Ubuntu from the Ubuntu
> branch - I'm hoping Daniel will help with this when he is back from holiday.
> 2. How easy/difficult it will be to merge Gnome upstream changes into
> the Ubuntu branch.
> 
> So please bear with me - I'm totally new to bzr...

Well done!  Thanks for all the effort you have put into getting this 
problem resolved.  It looks like you have a Gnome documentation tree 
that is ready to accept changes.  Since I feel somewhat responsible for 
getting you to start this journey, I would like to talk over a couple of 
changes to get me started in the document team.  I  don't (yet) 
understand how to make a change and get it into the official Ubuntu 
documentation tree.  So here goes.....

0) The "Desktop User Guide"
https://help.ubuntu.com/7.04/user-guide/C/index.html
can't be easily accessed via the web.

I can't find an easy way to get to the index page.  You need to select 
one of the subjects on https://help.ubuntu.com/ which is the 7.04 index 
page, and then navigate downward until the footer navigation is 
displayed and then use the "Home" button to get to "Desktop User Guide".

This is not part of yelp so it's not part of the official Gnome 
documentation, but if find it confusing, beginners may do as well.  How 
do I go about submitting a change to fix this problem.

1) "Desktop Sessions" -> "Locking Your Screen"
https://help.ubuntu.com/7.04/user-guide/C/lock-screen.html
needs to be updated as "Lock Screen" is no longer on the "System" menu. 
  I feel that it needs to be changed to contain the information that can 
be found at:
https://help.ubuntu.com/7.04/keeping-safe/C/lock-screen.html

2) https://help.ubuntu.com/7.04/keeping-safe/C/lock-screen.html
then becomes somewhat redundant and the link from "Keeping Your Computer 
Safe"
https://help.ubuntu.com/7.04/keeping-safe/C/index.html
can be changed to point at the revised  gnome "Locking Your Screen" page.

These three changes will clean up the navigation in the web based help, 
update the yelp page to reflect the realities of the 7.04 System menu, 
and remove a redundant (IMOSHO) page from the web based documentation.

Comments, feedback, suggestions?


> 
> Matt
>