[Fiware-miwi] Review and fixes for Release 3.2 (January) Guides

[Marti Christof (mach)]

Hi everybody

Last week/weekend and today I finally found time to finish checking and verifying the R3.2 Software, User&Programmer Guides and Install&Admin Guides.
I tried to fix as many issues I could myself. Sadly there are still some fixes/extensions from your side required.

The updated status can be found here: https://docs.google.com/spreadsheet/ccc?key=0Auieh_fs3EUxdFVvY19ab1lFRDRUaTBrUXlpYzBVRlE&usp=docslist_api#gid=17
All entries marked „Review OK“ or „Ready for 2nd review“ are OK and need no enhancements.
Those requiring  fixes are yellow and I added some comments below.
(Miguels and Manuels original review comments<https://docs.google.com/spreadsheet/ccc?key=0AqLSWp0KXaaDdGZ0ekFhREgyMFdoT1owZ1BYdFlnbGc&usp=docslist_api#gid=2> are also linked from the Dashboard)

Software:

  *   All Package naming issues fixed.
  *   Still missing DaaS package (at least I can not find it)

User & Programmer Guides:

  *   Structure is OK for all GEis.
  *   Content is updated/enhanced and most GEi are ready for 2nd review.
  *   Cloud Renderer Guide is rejected and will be rejected again if not updated.
I guess main reason is, that it is very difficult to understand how it has to be used without digging into the WebClient example source code. You mention the WebClient JavaScript library. What about a code example on how to use it?

Installation & Admin Guides:
Miguel stopped reviewing them, because the structure was not OK for most of them.
I fixed quite a lot of structural issues.
Here it is important, that the document structure has to follow exactly the template https://forge.fi-ware.org/plugins/mediawiki/wiki/fi-ware-private/index.php/Template_GE_-_Installation_and_Administration_Guide
You are not supposed to remove given sections or change the given section titles. You can add subsections to them.
If a section is not applicable, you can write N/A (e.g. if you are not using a database). The template also gives some hints about the content of the sections.

  *   TOC OK means the Structure was ok. Maybe I did some minor edits
  *   TOC fixed means I fixed the structure and maybe moved some content.
  *   TOC fix still needed means that it was not so simple for me to split the content into the required sections.

Anyways, please check your Installation & Admin Guide by

  *   checking if the content is still correct. (You can check my changes/diffs in the history tab).
  *   Enhancing the content of HW/SW requirements (minimal, optimal and concrete minimal version numbers for OS/Software)
  *   Enhancing the Sanity Check and Diagnosis Procedures (check content hints on template page)

I am still working on the Unit Testing Plans and will send an update later this evening.

Reminder: tomorrow April 9th EOB is the internal deadline for the updated R3.3 Guides and UTPs  (dashboard<https://docs.google.com/spreadsheet/ccc?key=0Auieh_fs3EUxdFVvY19ab1lFRDRUaTBrUXlpYzBVRlE&usp=docslist_api#gid=24>)  They should also be updated to include the fixes from R3.2.

Best regards
Christof
----
InIT Cloud Computing Lab - ICCLab
Institut of Applied Information Technology - InIT
Zurich University of Applied Sciences - ZHAW
School of Engineering
Phone: +41 58 934 70 63
Skype: christof-marti
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fiware.org/private/fiware-miwi/attachments/20140408/2c6d8628/attachment.html>