Styleguide issues

Matthew East mdke at ubuntu.com
Tue Jan 17 09:02:43 UTC 2006


On Mon, 2006-01-16 at 20:48 -0800, Jeff Schering wrote:
> Hi all
> 
> The styleguide lives in two places right now: the wiki (at
> https://wiki.ubuntu.com/StyleGuide) and in the docteam repos in
> Docbook format.
> 
> The way it is now, the most up-to-date version of the styleguide is in
> the repos and an outdated version is on the wiki. The reason that the
> wiki version is outdated is because it must be updated manually
> everytime the repos changes.
> 
> I think it would make more sense if the wiki version was kept as the
> most up-to-date and current document, with the repos Docbook version
> being periodically updated to be a snapshot of the wiki version. (We
> still need the Docbook version for building html and pdf files.)

I think it would make more sense to keep the wiki page as a spec, and
work directly in the docbook version. Then simply link to the html from
the wiki.

That has the major advantage that you don't have to keep two documents
up to date, instead of one. It also means that the document will be
stable rather than open to all to edit.

Matt
-- 
mdke at ubuntu.com
gnupg pub 1024D/0E6B06FF
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20060117/b801e79b/attachment.pgp>


More information about the ubuntu-doc mailing list