Documentation website

[Matthew East]

On Sat, January 27, 2007 4:42 pm, Rich Johnson wrote:
> The only thing I do no like about the linking above is that when it is
> built
> for https://help.ubuntu.com the links will be broken.

As discussed on irc the other day, there isn't *any* solution where links
between different documents written in xml can be retained when built to
html, that I'm aware of, unless we do some trickery at build time.

I think the better solution here will be to focus on the system documents.
I don't necessarily see the point of reproducing material on the website
exactly as it appears on the user's system. The help website should
supplement the system documentation, rather than reproducing it.

Ultimately I think the best solution will be to turn
https://help.ubuntu.com/community into https://help.ubuntu.com and include
any extra information that isn't already there in the wiki. We can use the
docbook->moin utilities, fix any links, and adjust the document as
necessary to integrate it into the wiki. We can also include appropriate
instructions to tell the reader about the system documentation.

> We could just build
> out
> PDFs for the website?

No: the links in the PDFs would also have the same issue. Also, PDF is not
really an appropriate format for our topic based document - we'd have to
make lots of little PDFs, which would be a bit odd, to say the least. PDF
will work well for standalone guides, like the packaging guide, switching
from windows, and the server guide.

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