Missing internal documentation

[Matthew East]

On Tue, Apr 21, 2009 at 6:48 PM, Dougie Richardson
<dougierichardson at ubuntu.com> wrote:
> 2009/4/21 Matthew East <mdke at ubuntu.com>:
>> In fact, I think our processes are better documented now than they
>> ever have been, but having said that, given that we're on a bit of a
>> drive at the moment, please feel free to suggest things that you think
>> aren't documented, and if it is something that "only I understand",
>> then I'll do my best to take care of it.
>
> The wiki covers how to get, edit, validate and submit a patch. It
> doesn't cover the structure of the package, entities and their usage,
> the libs folder, XSL templates, building web pages or PDF.
>
> Granted I can find this out myself but if these were worth including
> in the package then they should be explained.

Building web pages and PDF was already covered, but I've updated the
pages, added a section on help.ubuntu.com and renamed the pages to
match the new "SystemDocumentation" naming convention:

  https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/BuildingDocumentation

I've added a paragraph to that page briefly explaining XSL templates.
I think a brief explanation is appropriate rather than a detailed one
because there are some very good and comprehensive guides to XSL
elsewhere on the internet, and I've included a link to one of those.

I've added a brief explanation of the layout of the branch to the
https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/Editing
page.

I've added a short explanation of entities here:
https://wiki.ubuntu.com/DocumentationTeam/DocbookTags

Feel free to review/amend these.

Also I'd encourage anyone who sees a gap in the internal documentation
for the team to post on this thread, or better still, propose some
wording that we can add.

-- 
Matthew East
http://www.mdke.org
gnupg pub 1024D/0E6B06FF