[Spice-devel] RFC: Updating spice documentation for 0.6 release

[Frédéric Grelot]

Hi, 

I don't have so much time to work on it, but I would be happy to occasionnaly help documenting spice. I'm using it regularly for a winXP guest on F14 host, and my skills are mainly on linux administration (network, virt...).

I also think that the wiki is more accessible, especially for occasionnal contributers like me. Still, the pdf manual could stay there for "historical purposes", but it needs to be specified, so that people don't take those information for what they are not anymore

If that helps, and since I've been following the list for quite a long time now, I think I could for example feed the wiki with the questions/answer that are found here : when the docs will have a defined structure they could each go in there respective categories, otherwise it could be some starting point for a FAQ.

Regards, 

Frederic.

-- 
frederic at grelot.net
Tél : 05 61 62 42 14 / 06 82 23 46 17

----- Original Message -----
> I suggest we go for keeping the wiki updated. It's easier accessible,
> easier searchable, and
> easier indexable by search engines than pdf files.
> 
> I would use the wiki of Mikrotik
> (http://wiki.mikrotik.com/wiki/Category:Manual) as an example of
> structure. I find the information I need very easy in this wiki.
> 
> Any other suggestions?
> 
> 
> Rgds,
> Siggi
> 
> 
> 
> 
> On Fri, November 19, 2010 11:00, Hans de Goede wrote:
> > Hi All,
> >
> >
> > As Sigbjorn Lie pointed out in the
> > "How can I move the mouse between spice client and local desktop
> > without Shift+F12?"
> > Thread our documentation is currently a bit lacking / outdated.
> >
> >
> > Sigbjorn has indicated that he is willing to help out with
> > updating the documentation. Looking at for example:
> > http://spice-space.org/docs/spice_user_manual.pdf
> >
> >
> > Quite a bit of updating is needed. So this brings me to the
> > following
> > questions:
> >
> >
> > 1) What and where is the source of the pdf's we currently have?
> >
> >
> > 2) In which format do we want to have our documentation? Currently:
> > -We have some docs on the wiki
> > -We have some pdf's
> > Some info is available in both, ie building from source instructions
> > can be found in both:
> > http://spice-space.org/docs/spice_user_manual.pdf
> > http://spice-space.org/page/Building_Instructions
> >
> >
> > With the second one being more or less up2date and the pdf
> > containing
> > instructions which are pretty much useless for the 0.6 series.
> >
> >
> > All in all I think our documentation needs an overhaul, starting
> > with
> > defining a structure for the different documents and in which
> > format(s) we want to make the various
> > docs available.
> >
> > Note I'm not saying we should rewrite all the docs we currently
> > have,
> > but I think it would be a good idea to remove some things (like
> > build instructions) from the pdf
> > docs, and replace them with a pointer to the wiki, were they can be
> > kept up2date much easier.
> >
> > I would very much appreciate input from others on this.
> >
> >
> > Regards,
> >
> >
> > Hans
> > _______________________________________________
> > Spice-devel mailing list
> > Spice-devel at lists.freedesktop.org
> > http://lists.freedesktop.org/mailman/listinfo/spice-devel
> >
> >
> 
> 
> _______________________________________________
> Spice-devel mailing list
> Spice-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/spice-devel