[icedtea-web] RFC: Replace PDF with editable HTML documentation

[Xerxes Rånby]

On 2011-03-29 14:49, Dr Andrew John Hughes wrote:
> The plugin/docs directory in IcedTea-Web includes an uneditable PDF
> file npplugin_liveconnect_design.pdf which prevents developers from
> changing the document and breaks the packaging guidelines for some
> distributions.  The attached patch replaces the PDF with an editable
> HTML version, while also fixing a number of minor issues (duplication
> of one slide, minor grammar issues).
>
> I did notice that the PDF (and thus this HTML version) are incomplete.
> Deepak, do you plan to complete this documentation?
>
> Patches for 1.0 and HEAD are attached.  They are identical, bar the
> addition of a NEWS entry in the 1.0 version, as I expect this to
> appear in 1.0.2.  As there are a number of other fixes on the 1.0
> branch, I think we are due for another 1.0.x release and the current
> 1.0.1 release can not be packaged due to this PDF file.
>
> HEAD ChangeLog:
>
> 2010-03-29  Andrew John Hughes  <ahughes at redhat.com>
>
> 	* plugin/docs/npplugin_liveconnect_design.html:
> 	Replace binary PDF documentation with editable HTML.
> 	* plugin/docs/npplugin_liveconnect_design.pdf: Removed.
>
> 1.0 ChangeLog:
>
> 2010-03-29  Andrew John Hughes  <ahughes at redhat.com>
>
> 	* NEWS: Updated.
> 	* plugin/docs/npplugin_liveconnect_design.html:
> 	Replace binary PDF documentation with editable HTML.
> 	* plugin/docs/npplugin_liveconnect_design.pdf: Removed.
>
> Ok to push to both branches?
I think this are a great change!

By keeping the documentation in HTML format enabled us to:
*    Quickly update the documentation on the main Icedtea website to stay correct after each release by simply copying in the docs archive into the website.
*    Review documentation changes in form of patches. It will developers, me included, to sharpen my English while making the IcedTea-web documentation up to date.

I am in favour for this push and I encourage creation of similar documentation patched for the IcedTea project as well.

Cheers
Xerxes