Re: [Xen-users] Push for Better Documentation

[Nico Kadel-Garcia <nkadel@xxxxxxxxx>]

Artur Linhart - Linux communication wrote:
> I would propose not to create a new or user-specific pages, but use and
> improve existing structures on the xensource website, especially wiki.
>
> I personally miss following information:
> 1. all possible tags and keys in the configuration file for the DomU - I
> think there are a lot of "hidden functions" which cannot be used because
> nobody knows them - maybe if they are not implemented fully, they should be
> listed with the corresponding comment what can be expected there ( - for
> example like the "rate" property of the vif interface definition which has
> been communicated here some days ago)
>   
Amen. A consistent list, updated with each major software list, would be 
majorly useful.
> 2. manual pages should be installed together with xen open source - I do not
> if I missed something somewhere, but after installing xen the command "man
> xm" or silmilar commands return no available manual pages - can this one be
> obtained somwhere?
>   
The XenSource RPM's do not include them. They use a Latex->HTML->manage 
format, which just makes me twitch to see in use. But if you look in the 
Makefile, you'll see the traces of it.
> 3. More philosophy-related documents - there are some of them, but it is
> mainly some basic documentation - are there any documentations which could
> be taken from the development side? I think there must be such documents,
> but are not on the xen site...
>
> But I think, crucial point is to establish the cooperation with the people
> who develop xen to get the information how it behaves, which functionality
> is really there in which state (concretely, not only as a list of the
> features for some release) etc.
>
> Is there some authority, which leads the development? I think this authority
> should also be responsible (or delegate to somebody the responsibility) for
> the proper documentation to the users. 
> To develop functionality does not help, if nobody knows how to use it...
>         With best regards
>
>                 Artur.
>
> P.S. I do not have a lot of time, but would also like to help in this area
> if this will be possible.
>
> -----Original Message-----
> From: xen-users-bounces@xxxxxxxxxxxxxxxxxxx
> [mailto:xen-users-bounces@xxxxxxxxxxxxxxxxxxx] On Behalf Of Dylan Martin
> Sent: Tuesday, July 10, 2007 3:16 AM
> To: Lev Lafayette
> Cc: Tom Horsley; Christian Horn; xen-users@xxxxxxxxxxxxxxxxxxx
> Subject: Re: [Xen-users] Push for Better Documentation
>
>   
> > I'm happy to work on this as well. I've recently compiled a fair few
> > notes on Xen and have given introductory presentations on the subject.
> >
> > Plus, I'm a social sciences graduate. Which means I'm used to writing
> > 1500+ coherent* words in a single sitting ;-)
> >
> > Shall we start with what constitutes "official" documentation? Are we
> > going to adopt a manual or wiki approach?
> >
> > All the best,
> >
> > * Which also means I'm not terribly fond of the postmodernists.
> >     
> Awesome!  
>
> I was thinking we should overhaul the existing wiki, rather than
> trying to make a competing resource. 
>
> I'm working on FAQ 2.0.  Right now I'm researching what the actual
> frequently asked questions are.  Once I get something started, I'll
> post it on the wiki as faq2 or something like that.  Then, if people
> like it, I'll replace the current faq with my new faq.  
>
> Does that sound like a good system?  What documentation would you like
> to work on?
>
> Again, Awesome!
>
> -Dylan
>
> P.S. I am also a social science graduate, but I can't write more than
> 5 coherent words at all...
>
>
>
>  
>
> _______________________________________________
> Xen-users mailing list
> Xen-users@xxxxxxxxxxxxxxxxxxx
> http://lists.xensource.com/xen-users
>
> __________ Informace od NOD32 2388 (20070710) __________
>
> Tato zprava byla proverena antivirovym systemem NOD32.
> http://www.nod32.cz
>
>
>
> _______________________________________________
> Xen-users mailing list
> Xen-users@xxxxxxxxxxxxxxxxxxx
> http://lists.xensource.com/xen-users
>
>   
_______________________________________________
Xen-users mailing list
Xen-users@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-users