[Spice-devel] [PATCH v2 0/4] Protocol file syntax documentation

[Pavel Grunt]

On Fri, 2016-09-30 at 07:02 -0400, Frediano Ziglio wrote:
> > 
> > Hi Frediano!
> > 
> > Thank you for looking into it
> > 
> > imho it is confusing to document spice-protocol which is defined
> > in
> > spice-common in spice server git repository.
> > 
> > ^ that sentence is strange
> > 
> 
> 
> All protocol files (spice.proto and python code) are in spice-
> common,
> not in spice-protocol. I think that between spice-server, spice-
> common
> and spice-protocol spice-common is the best place...
Sorry I was not sure for which repo is this patchset, since I saw
spice_manual in the diff I though it is server. Also current
documentation of the protocol and spice is in the server repo:
 * Spice_for_newbies.odt
 * Spice_protocol.odt
 * spice_style.txt
 * Spice_user_manual.odt
 * Vd_interfaces.odt

> 
> > I know the documentation files are in the spice server git repo,
> > imo
> > it is wrong.
> > 
> > I would put this kind of information on our website, so it is easy
> > to
> > give the reference to a "rendered" document in case somebody asks
> > on
> > irc or by an email.
> > 
> 
> 
> ... but I agree this documentation could be moved to some other
> place. I would like however to have the history a repository (and we
> are using git for the website) so website is also fine.
> At the end is just a single file.
> 
> Where's the website git repository?
Currently it is there:
https://cgit.freedesktop.org/~pgrunt/spice-space/tree/content/pages

> Where can I store the document file?
> I expect to use the same format (markdown).
The website uses rst and asciidoc, it can handle markdown as well

I am doing some clean up (separating text file from configuration
files and) and I will move it under our gitlab instance

Pavel
> 
> > Of course any documentation is better than no documentation.
> > 
> > Pavel
> > 
> 
> 
> Sure
> 
> Frediano
>