Web sites for docteam

[Sean Wheller]

On Thursday 02 June 2005 15:39, Henrik Nilsen Omma wrote:
> Sean Wheller wrote:
> >
> >You have been volunteered to resolve the following infrastructure
> > requirement to be run on host: 82.211.81.159 (the machine where our svn
> > is currently situated.)
> >
> >:-)
> >
> >  
>
> Right, I'll speak with James about what the is best way of implementing
> this. I think help.ubuntu.com should be integrated with the main site,
> so that there is no doubt that is is official Ubuntu documentation, so
> it will have to have the headers and tabs used here:
> http://www.ubuntu.com/.

Not sure you will need to integrate it. What we will be developing is a full 
web-based application. With multiple books available. Trying to run it under 
another web-app will just complicate it and fear losing screen real-estate to 
functions that are not a part of the help system.

The same application will be installed and deployed with the distro. Hmmm, 
actually perhaps this will make help.ubuntu.com rather redundant. The 
difference is that on help.ubuntu you will have all documents in all 
languages and google based search, whereas on the distro we will only install 
key docs and eachlang will be in a separate lang pack (well that's what I am 
asked to believe). Example of a doc that will not be packaged is the 
Installation Guide. No need once you have the product installed. Maybe it is 
just good to have them all there. Not sure.

>
> >Please note that as translations arrive they will be added to svn and also
> >moved to docteam.ubuntu and/or help.ubuntu.
>
> So, what should the URL structure look like?
> help.ubuntu.com/en/breezy/topic ? I think the URL structure on the
> docteam.ubuntu site should mirror that on help.ubuntu exactly for
> simplicity, but there should be a notice saying 'work in progress' and
> no fancy headers.

Basically all we need is that there is a default 
http://help.ubuntu.com/index.html. The folders etc. we will build and link to 
from the index.html. But I think we will have the release name as the root 
for each document set. The same will happen with docteam.ubuntu.com but as 
you say we will have notification that this is WIP. See attached PNG for idea 
of help app layout.

Neither of these sites are editable via the web. Editing process will look as 
follows:
						

author		author						<-
   |			|							reviewer
  V			V								|
wiki -> port -> docbook -> svn -> auto night build -> docteam.ubuntu.com 
											|
											V
									       Release Date Build
											|
											V
								scp docteam.ubuntu.com help.ubuntu.com

The base files will be X/HTML. What I planned is to use the basic file set 
used in a Windows CHM. Just this time we will not be compiling them into a 
CHM and we will be using CSS and jscript in the backend for look and 
interactive functionality.

Thoughts, ideas etc. all welcome.

-- 
Sean Wheller
Technical Author
sean at inwords.co.za
084-854-9408
http://www.inwords.co.za
Registered Linux User #375355
-------------- next part --------------
A non-text attachment was scrubbed...
Name: ubuntu-help-scratch.png
Type: image/png
Size: 28330 bytes
Desc: not available
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20050602/c4c3333b/attachment.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20050602/c4c3333b/attachment.pgp>