[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

Re: [libvirt] Docs team task: Update main docs.html page with index of all pages



On Tue, Jan 11, 2011 at 05:40:40PM +0100, Zdenek Styblik wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
> 
> Hello,
> 
> On 01/08/11 12:00, Justin Clift wrote:
> [...]
> > I'm thinking the very best thing you can do is get our "Docs" landing
> > page under control for the main site:
> > 
> >  http://libvirt.org/docs.html
> > 
> > It's very blank, relying on people to realise that everything is accessible
> > on the left hand menu bar instead. :(
> > 
> > What it should contain is an index to all of the main documentation
> > pieces, so people can click directly from there.
> > 
> > Some sort of menu structure will be needed (up to you, try things out).
> > 
> 
> Right. I've been clicking through libvirt.org (= killing time) and ...
> how about to make it ala 'site map'.
> 
> - --- SNIP ---
> Documentation
>   Compiling ~ how-to compile libvirt; all you wanted to know about
> libvirt compilation and installation
>   Deployment ~ deploying libvirt into production enviroment
>   Architecture ~ how's libvirt structured? API concepts? Right here!
>   XML Format ~ how's data stored within libvirt
>   Drivers ~ what is and what is not supported by libvirt
>   API reference ~ any serious libvirt integrator should read this one
>   Language bindings ~ how to bind libvirt with C/C++, PHP, Ruby and some
> others
>   Internals ~ how doest libvirt work under the hood
>   Development guide ~ do you want to contribute to libvirt? Then this is
> mandatory for you
>   Virsh commands ~ virsh command reference not only for command line
> junkies
> - --- SNIP ---

This sounds like just a subset of what's already present in

  http://libvirt.org/sitemap.html

It would be trivial to write some XSL to auto-generate docs.html
from the subset of the sitemap.html content that is relevant.

Daniel


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]