Bug 95258

Summary: Convert documentation to asciidoc
Product: Spice Reporter: Pavel Grunt <pavelgrunt>
Component: serverAssignee: Spice Bug List <spice-bugs>
Status: RESOLVED MOVED QA Contact:
Severity: normal    
Priority: medium CC: fziglio
Version: unspecified   
Hardware: Other   
OS: All   
URL: http://www.spice-space.org/documentation.html
Whiteboard:
i915 platform: i915 features:
Attachments: asciidoctor files
Converting Spice_for_newbies
Converting Spice_protocol
C

Description Pavel Grunt 2016-05-04 12:21:14 UTC
Currently the documentation is in odt format:
Spice_for_newbies.odt
Spice_protocol.odt
Spice_style.odt
Spice_user_manual.odt
Vd_interfaces.odt

It would be useful to convert it to asciidoc, so it can be easily included on our website.
Comment 1 Frediano Ziglio 2016-05-10 16:08:54 UTC
started converting Spice_style.odt, see https://lists.freedesktop.org/archives/spice-devel/2016-May/028916.html
Comment 2 Frediano Ziglio 2016-05-10 16:09:26 UTC
started converting Spice_style.odt, see https://lists.freedesktop.org/archives/spice-devel/2016-May/028916.html
Comment 3 Thiago Mendes 2017-07-06 22:36:36 UTC
Created attachment 132486 [details] [review]
asciidoctor files

Starting to convert the odt files to adoc
3 docs are already done
Spice_for_newbies.odt -> Spice_for_newbies.adoc
Spice_protocol.odt -> Spice_protocol.adoc
Vd_interfaces -> Vd_interfaces.adoc
Comment 4 Pavel Grunt 2017-07-07 06:42:54 UTC
Hi Thiago,
we don't use bugzilla to review the patches, please send them to the mailing list ( https://www.spice-space.org/developers.html#like-to-send-a-patch )

Regarding your patch - I'd suggest splitting it for each odt file. Makefile can be updated to generated documentation from adoc files (like it is done for the spice style document)

Have you used a script to convert the files? I noticed some strange characters in the converted files.

Thanks for the interest!
Comment 5 Thiago Mendes 2017-07-07 13:56:26 UTC
(In reply to Pavel Grunt from comment #4)
> Hi Thiago,
> we don't use bugzilla to review the patches, please send them to the mailing
> list ( https://www.spice-space.org/developers.html#like-to-send-a-patch )
> 
> Regarding your patch - I'd suggest splitting it for each odt file. Makefile
> can be updated to generated documentation from adoc files (like it is done
> for the spice style document)
> 
> Have you used a script to convert the files? I noticed some strange
> characters in the converted files.
> 
> Thanks for the interest!

No scripts. What I did: I export to a txt file using the LibreOffice and after that I started working on each document to convert it to the asciidoc format using their website documentation as a guide. Could you tell me more about the strange characters?...so I could have a look :).

There are 5 images from the "Spice for newbies" in this patch. 

Gonna fix the strange characters, put every document in a different patch and send it and follow the "https://www.spice-space.org/developers.html#like-to-send-a-patch" instructions. Thanks for telling me about this. :)
Comment 6 Pavel Grunt 2017-07-07 14:17:32 UTC
Comment on attachment 132486 [details] [review]
asciidoctor files

Review of attachment 132486 [details] [review]:
-----------------------------------------------------------------

::: docs/Spice_for_newbies.adoc
@@ +1,1 @@
> += Spice for Newbies: Red Hat, Inc

^ strange character

@@ +3,5 @@
> +:revdate: 01.01.2009
> +:revremark: Draft 1
> +:imagesdir: ./images/newbies
> +
> +Copyright © 2009 Red Hat, Inc. + 

another ^

@@ +74,5 @@
> +ChannelFactory is the base class for all channel factories. Each channel registers its specific factory for enabling RedClient to create channels by channel type.
> ++
> +.. Screens and Windows
> ++
> +* ScreenLayer â screen layer is attached to specific screen, providing operations on rectangle areas (set, clear, update, invalidate, etc.). Layers are z-ordered (e.g., cursor is above display).

another --^

::: docs/Vd_interfaces.adoc
@@ +3,5 @@
> +:revdate: 01.01.2009
> +:revremark: Draft 1
> +:imagesdir: ./images/newbies
> +
> +Copyright © 2009 Red Hat, Inc. +·

another weird character  --^
Comment 7 Thiago Mendes 2017-07-08 20:14:39 UTC
(In reply to Pavel Grunt from comment #6)
> Comment on attachment 132486 [details] [review] [review]
> asciidoctor files
> 
> Review of attachment 132486 [details] [review] [review]:
> -----------------------------------------------------------------
> 
> ::: docs/Spice_for_newbies.adoc
> @@ +1,1 @@
> > += Spice for Newbies: Red Hat, Inc
> 
> ^ strange character
> 
> @@ +3,5 @@
> > +:revdate: 01.01.2009
> > +:revremark: Draft 1
> > +:imagesdir: ./images/newbies
> > +
> > +Copyright © 2009 Red Hat, Inc. + 
> 
> another ^
> 
> @@ +74,5 @@
> > +ChannelFactory is the base class for all channel factories. Each channel registers its specific factory for enabling RedClient to create channels by channel type.
> > ++
> > +.. Screens and Windows
> > ++
> > +* ScreenLayer â screen layer is attached to specific screen, providing operations on rectangle areas (set, clear, update, invalidate, etc.). Layers are z-ordered (e.g., cursor is above display).
> 
> another --^
> 
> ::: docs/Vd_interfaces.adoc
> @@ +3,5 @@
> > +:revdate: 01.01.2009
> > +:revremark: Draft 1
> > +:imagesdir: ./images/newbies
> > +
> > +Copyright © 2009 Red Hat, Inc. +·
> 
> another weird character  --^

--> This one: = Spice for Newbies: Red Hat, Inc
Can't find it here.

--> This one: Copyright © 2009 Red Hat, Inc. + 

It was me, not a script. I was using the unicode-value: http://asciidoctor.org/docs/asciidoc-writers-guide/#replacements but I can replace it with a (C)

--> This one: * ScreenLayer â screen layer is attached to specific screen, providing operations on rectangle areas (set, clear, update, invalidate, etc.). Layers are z-ordered (e.g., cursor is above display).

No idea. Gonna fix it. Thanks for showing me :)
Comment 8 Thiago Mendes 2017-07-09 00:32:56 UTC
(In reply to Pavel Grunt from comment #4)
> Hi Thiago,
> we don't use bugzilla to review the patches, please send them to the mailing
> list ( https://www.spice-space.org/developers.html#like-to-send-a-patch )
> 
> Regarding your patch - I'd suggest splitting it for each odt file. Makefile
> can be updated to generated documentation from adoc files (like it is done
> for the spice style document)
> 
> Have you used a script to convert the files? I noticed some strange
> characters in the converted files.
> 
> Thanks for the interest!

Pavel. I have a question about the patchs. I made 3 patchs to send by email. One per asciidoc file but the first one still a bit big because of the image files. Wondering if it is ok sending it this way.

Again: thanks for helping!(In reply to Pavel Grunt from comment #4)
> Hi Thiago,
> we don't use bugzilla to review the patches, please send them to the mailing
> list ( https://www.spice-space.org/developers.html#like-to-send-a-patch )
> 
> Regarding your patch - I'd suggest splitting it for each odt file. Makefile
> can be updated to generated documentation from adoc files (like it is done
> for the spice style document)
> 
> Have you used a script to convert the files? I noticed some strange
> characters in the converted files.
> 
> Thanks for the interest!

Pavel. I have a question about the patchs. I made 3 patchs to send by email. One per asciidoc file but the first one still a bit big because of the image files. Wondering if it is ok sending it this way.

Again: thanks for helping!
Comment 9 Pavel Grunt 2017-07-10 09:09:48 UTC
(In reply to Thiago Mendes from comment #7)
> (In reply to Pavel Grunt from comment #6)
> 
> --> This one: = Spice for Newbies: Red Hat, Inc
> Can't find it here.
> 
> --> This one: Copyright © 2009 Red Hat, Inc. + 
> 
> It was me, not a script. I was using the unicode-value:
> http://asciidoctor.org/docs/asciidoc-writers-guide/#replacements but I can
> replace it with a (C)
> 

yeah, that should work, see: http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#text-replacement

(In reply to Thiago Mendes from comment #8)
> (In reply to Pavel Grunt from comment #4)
> > Hi Thiago,
> > we don't use bugzilla to review the patches, please send them to the mailing
> > list ( https://www.spice-space.org/developers.html#like-to-send-a-patch )
> >
> > [...] 
> 
> Pavel. I have a question about the patchs. I made 3 patchs to send by email.
> One per asciidoc file but the first one still a bit big because of the image
> files. Wondering if it is ok sending it this way.
> 
It should be ok
Comment 10 Thiago Mendes 2017-07-11 15:59:21 UTC
 Thanks again Pavel

 Just to update you:

 I have all the files here. 

 I'm facing some problems with the command "git send-email" and archlinux but I'm a bit busy this week and the next few weeks to check and fix it so I'll leave it for latter.

 As soon as I have time I will check why I'm getting errors from Perl when I try to use the git send-email, fix it and finally send the patch I have here.

 Sorry about that. I hope to be able to send it soon.

 Cheers,
Thiago
Comment 11 Pavel Grunt 2017-07-12 09:04:39 UTC
Hi Thiago,

no problems. Do you have a git branch with your patches somewhere? I can take a look there. Or you can attach the updated patches here and send them to the MailingList later.
Comment 12 Thiago Mendes 2017-07-12 16:24:16 UTC
(In reply to Pavel Grunt from comment #11)
> Hi Thiago,
> 
> no problems. Do you have a git branch with your patches somewhere? I can
> take a look there. Or you can attach the updated patches here and send them
> to the MailingList later.

I have it in my linux only. I'll attach the files here. Sorry about that. Gonna work on fix git send-email as soon as possible so I can work on trying to fix some issue here and send the patch in the right way!!

Thanks again Pavel!
Comment 13 Thiago Mendes 2017-07-12 16:25:02 UTC
Created attachment 132639 [details] [review]
Converting Spice_for_newbies

This files contains a few image files too.
Comment 14 Thiago Mendes 2017-07-12 16:25:43 UTC
Created attachment 132640 [details] [review]
Converting Spice_protocol
Comment 15 Thiago Mendes 2017-07-12 16:25:58 UTC
Created attachment 132641 [details] [review]
C
Comment 16 Thiago Mendes 2017-07-12 16:26:42 UTC
(In reply to Thiago Mendes from comment #15)
> Created attachment 132641 [details] [review] [review]
> C

Converting Vd_interfaces (patch)
Comment 17 GitLab Migration User 2018-06-03 10:15:04 UTC
-- GitLab Migration Automatic Message --

This bug has been migrated to freedesktop.org's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.freedesktop.org/spice/spice-server/issues/10.

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.