Proposed road map for ubuntu-docs

[Doug Smythies]

On 2017.04.29 15:48 Gunnar wrote:
> On 2017-04-29 04:27, Jeremy Bicha wrote:
>> ... this is my initial thinking (or proposal I guess):

...[snip]...

> One disadvantage with having two branches/packages is that we won't be 
> able to use yelp-check before committing to ubuntu-docs to identify 
> broken internal links, orphans etc. OTOH, the reduced number of pages to 
> pay attention to will probably make this manageable. (And it will be 
> possible to run yelp-check without this limitation afterwards, i.e. when 
> both packages have been installed.)

Yes, I think we could run yelp-check on the help.ubuntu.com version.
I'm sure we can figure out something.

> One thing which remains to be dealt with is how to build the HTML for 
> help.ubuntu.com. The .page files will be split into three source 
> packages/branches:
> - gnome-user-docs
> - gnome-getting-started-docs
> - ubuntu-docs
> 
> We need a convenient method to do that. 

Agreed.

> Maybe a separate tiny branch 
> with script + template which bases the build on the installed stuff in 
> /usr/share/help/<lang>/gnome-help ?

It would my preference to not need the "installed stuff".
Why not? 
1.) Because I almost always build/compile on a server without that stuff.
2.) We will want to be able to build/compile sometimes on a machine running
    a different version of Ubuntu than the docs html version being built.

I'll try to help with creating some build environment, with the disclaimer
that the requirements might end up beyond my abilities.

>> One more optional idea:
>> What do you think about converting the ubuntu-docs from bzr to git?
>> Since the Ubuntu Docs team should be submitting many changes to
>> GNOME directly now, I am thinking it would be easier for new
>> contributors to only need to learn one version control system instead
>> of two. Would switching to git be a problem for the existing team?
>
> Well, speaking for me it would be a learning curve. ;) But it sounds as 
> the right thing to do for the reason you mention.

I use both bzr and git, but am not a super user of either.
I much prefer git, but yes there is a learning curve.

... Doug