[MERGE][0.90] Doc organised into directories

Ian Clatworthy ian.clatworthy at internode.on.net
Tue Aug 14 05:18:13 BST 2007


Ian Clatworthy wrote:

> Latest patch attached. This now includes:
> 
> * an improved Mini Tutorial (hooray!)
> * Sabin's Quick Start Summary (svg)
> * the improved main index mentioned above
> * a link from the developer index back to the main one
> * updated Release Notes.

This version fixes the known outstanding issues (see below):

1. A tree of docs is generated for the Windows installer, not
   just a single directory
2. "pretty" docs can be generated and the template applies to
   all docs in the tree, not just a few.

To generate the pretty docs, a variable now needs to be set on the make
command line, e.g.

  make PRETTY=1 docs

or

  make PRETTY=1 html-docs

The latter copies just the stuff required to be uploaded into
a directory (called html_docs).

In addition, the Makefile is now better organised and, IMO at least,
much easier to comprehend.

> Once again, See http://people.ubuntu.com/~ianc/doc/index.html and
> navigate around to see the result. This is rapidly approaching a doc set
> we can be proud of (vs competitive systems) I feel.

As well as the vanilla version (unchanged since the last email), see
http://people.ubuntu.com/~ianc/pretty_docs/index.html for the pretty
version.

>>> I know Aaron was unhappy to have the pretty-docs function broken - it is
>>> nice to have the documents more cleanly integrated with the rest of the
>>> site.  It's true that we don't currently use this because kid is not
>>> installed on that machine, but it would be kind of a shame to break it.
>> Sure. I'll look at this either later tonight or first thing Tuesday.
> 
> This bit is still not done, sorry. Given it's not currently used, I feel
> we could merge without it. I want to fix it but I want to fix it
> properly, e.g. make it the template for all doc files, not just the ones
> in the (new) User Guide.
> 
> My bigger concern right now is the impact on the Windows installer? If
> someone can take a look over (my) night please and let me know what's
> required if anything, I'll fix it first thing my Tuesday morning. Well
> first thing after I wake up at least. :-)

Done and Done.

Ian C.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: doc-new-layout-3.patch
Type: text/x-patch
Size: 142942 bytes
Desc: not available
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20070814/a17f4860/attachment-0001.bin 


More information about the bazaar mailing list