WARNING - OLD ARCHIVES

This is an archived copy of the Xen.org mailing list, which we have preserved to ensure that existing links to archives are not broken. The live archive, which contains the latest emails, can be found at http://lists.xen.org/
   
 
 
Xen 
 
Home Products Support Community News
 
   
 

xen-users

Re: [Xen-devel] Xen document day (Oct 12 or 26)

On Thu, 2011-09-22 at 18:40 +0100, Konrad Rzeszutek Wilk wrote:
> On Thu, Sep 22, 2011 at 05:32:46PM +0100, George Dunlap wrote:
> > Another thing that needs to be done is to write man pages for xl, and
> > update the man pages for xm to indicate that it is deprecated.
> 
> So:
> 
>  1). PDF/section
>  2). Wiki
>  3). man page for xl/xm
>  4). HOWTO, docs in xen.hg/docs
>  5). Convert said HOWTO, docs in Markdown.

Another thing which came up which I'd like to do was setting up doxygen
(or something similar, recommendations greatfully received) for
xen/include/public to allow us to document the hypercall interface
inline, with the intention of replacing interface.tex with something we
might actually maintain.

> 
> Who wants to do what? I created a sign up sheet:
> 
> https://docs.google.com/spreadsheet/ccc?key=0Aj5ukWh4htwMdEFLVWpjRmx3VXdETDExNlByamd4Rmc&hl=en_US
> 
> in case folks want to get an idea of who is doing what and not
> step on each toes.

We should have a specific IRC channel on the day too (e.g.
#xen-documentathon on freenode).

> 
> > 
> > We also discussed the idea of moving some of the documentation and the
> > HOWTOs into the xen.hg/docs folder, preferrably in a nice language
> > like Markdown, so that we can enforce changes in documentation with
> > changes code.  I propose using Markdown, if no one has a better idea.
> 
> Which pretty much looks like writting normal text files per
> http://en.wikipedia.org/wiki/Markdown description.
> > :-)
> > 
> >  -George
> > 
> > On Thu, Sep 22, 2011 at 2:06 PM, Konrad Rzeszutek Wilk
> > <konrad.wilk@xxxxxxxxxx> wrote:
> > > Part of what we brainstormed at Xen Hackathon was what we could do make 
> > > Xen easier.
> > >
> > > And the one thing that seemed to surface up was making the docs better - 
> > > either
> > > be the Wiki or the three .pdfs that get created/shipped with Xen.
> > >
> > > One thought was to come up with a Documention Day - where volunteers 
> > > would try to
> > > fix up some portion of the documentation that they feel they have
> > > a good grasp of knowledge off and are willing to change (and also look
> > > to be incorrect)
> > >
> > > What do you guys think of Oct 12th or Oct 26 as a day for this?
> > >
> > > And then the next question - what page/pdf section interests you?
> > >
> > > http://bits.xensource.com/Xen/docs/user.pdf
> > > http://www.rites.uic.edu/~solworth/xenInterfaceManual.pdf [the one on 
> > > Xen.org is an older version]
> > >
> > > Or Wiki pages:
> > > http://wiki.xensource.com/xenwiki/
> > >
> > > http://wiki.xensource.com/xenwiki/XenDom0Kernels
> > > http://wiki.xensource.com/xenwiki/XenSerialConsole
> > > http://wiki.xensource.com/xenwiki/XenParavirtOps
> > > http://wiki.xensource.com/xenwiki/XenCommonProblems
> > >
> > > http://wiki.xensource.com/xenwiki/Consulting
> > > http://wiki.xensource.com/xenwiki/Consultants
> > > http://wiki.xensource.com/xenwiki/VpsHostingWithXen
> > >
> > > http://wiki.xen.org/xenwiki/XenPCIpassthrough
> > > http://wiki.xen.org/xenwiki/VTdHowTo
> > >
> > > _______________________________________________
> > > Xen-devel mailing list
> > > Xen-devel@xxxxxxxxxxxxxxxxxxx
> > > http://lists.xensource.com/xen-devel
> > >
> > 
> > _______________________________________________
> > Xen-devel mailing list
> > Xen-devel@xxxxxxxxxxxxxxxxxxx
> > http://lists.xensource.com/xen-devel
> 
> _______________________________________________
> Xen-devel mailing list
> Xen-devel@xxxxxxxxxxxxxxxxxxx
> http://lists.xensource.com/xen-devel



_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-devel