Hi,
In case you don't have a Google account and wish to perform the conversion of your specifications to a Word docx, please don't hesitate to let me know. I can provide you with a generic user account and password we have just configured for the review process.
Cheers,
-- Juanjo
-------------
Product Development and Innovation (PDI) - Telefonica Digital
website: www.tid.es<http://www.tid.es>
email: jhierro at tid.es<mailto:jhierro at tid.es>
twitter: twitter.com/JuanjoHierro
FI-WARE (European Future Internet Core Platform) Chief Architect
You can follow FI-WARE at:
website: http://www.fi-ware.eu
facebook: http://www.facebook.com/pages/FI-WARE/251366491587242
twitter: http://twitter.com/FIware
linkedIn: http://www.linkedin.com/groups/FIWARE-4239932
On 12/10/12 06:00, Juanjo Hierro wrote:
Hi,
You may have received an email from your WPL or WPA regarding instructions about how we are going to tackle the third and final peer review of the FI-WARE GE Open Specifications that we have to resubmit by November 2nd at the latest (see attachment)
IMPORTANT NOTE: We rather NEED that you to carry out a peer-review that focuses on how suitable the contents are. We are afraid that some of the peer-reviews carry out so far were mostly "editorial", i.e., polishing the English, highlighting issues regarding the structure, etc. We need that people review the document from the perspective of a developer or a potential implementer of the spec and point out what you don't understand, what you miss, etc.
The intend of this message is twofold. First, make sure it arrives without further delays in your inbox. Second, add a number of enhancements to the process described in the original email that hopefully will allow to make it faster and more efficient.
The enhancements have to do with trying to carry out the peer-review using docx files rather than reading the wiki and providing a list of change requests in a separate form. This would allow to drop out the part of the revision form that I sent earlier which had to do with providing detailed editorial comments. Please find attached the revised form.
The following is a description of the whole process with the suggested enhancements. If you hadn't read the original email, you just need to read this. For every FI-WARE GE Open Specification (as listed in http://forge.fi-ware.eu/plugins/mediawiki/wiki/fiware/index.php/Summary_of_FI-WARE_Open_Specifications), we will have to carry out the following steps.
1. Generate docx-version of each of the FI-WARE GE Open Specifications to ease the review. There are multiple ways for doing so and it is up to each Chapter to select its preferred one, but here you are a simple set of steps you can follow to generate a docx version (I have used this personally and have found it rather straightforward):
* Create a document in Google docs (I hope you have an account, otherwise agree with your WPL on how to get access to one or come back to us :-)
* Go to the wiki page of the deliverable. Don't forget to access it in "read" mode (i.e., not logged in FusionForge) because that would avoid copying the "edits"
* Copy and Paste directly from the Wiki page into the Google Docs. Notes:
* You have to split this in several steps, because Google docs gets blocked if you try to copy&paste too many pages with too many figures.
* Don't forget to add the API specs. Typically, you have to first copy&paste what is in the first-level FI-WARE GE Open Specification wiki page, then navigate to each API specification wiki page and copy and paste the contents.
* Once the document is generated, you can save it as a Word docx in your local PC.
* Run a quick check through the docx file fixing some easy-to-solve questions such as adjusting size of figures, doing some pagination which could easy reading, etc. Please, don't try to make it perfect, we just need a version on which you may apply changes and track those changes with the standard MS Word change control tools.
2. Upload the generated file in either SVN or the docman of the "FI-WARE Private" project in FusionForge (whatever tool you prefer)
3. Add the link to the docx file in SVN or docman to the column "Doc to review" corresponding to the FI-WARE GE in the following shared spreadsheet in Google that we will use as cockpit for the following-up the whole process: https://docs.google.com/spreadsheet/ccc?key=0AqGGeaQGro3fdDZhTEVmYTlHenkyR0FHMTg3LUVpSWc
4. Sent an email to the WPL of the reviewing chapter so that they know that the docx associated to the FI-WARE GE Open Specification is available for review. Please, don't wait until the rest of docs associated to other FI-WARE Open Specifications in your same chapter are uploaded. Leaders of reviewing chapters are also asked to check when there are new documents to review from time to time.
5. Carry out the review you have been assigned. Reviewers would be required to generate two files, that they should upload again to SVN or docman (whatever you prefer) and link from the Google cockpit. If you are a reviewer, please don't wait until you have both. Please upload each as soon as it is available and inform the leader of the chapter being reviewed that you have done so:
* A commented docx for the deliverable which would include all comments under change control. A link to this file should be provided in the "Commented doc" column of the cockpit.
* the simple FI-WARE Peer-review form attached. A link to this file should be provided in the "Simple peer-review form" column of the cockpit.
6. Process comments. This would be carried out typically by the owner of the FI-WARE GE Open Specifications. This would imply:
* generate a temporary draft by means of accepting/rejecting changes from the commented docx of your specifications
* consider general comments in the FI-WARE Peer-review form linked to your FI-WARE GE Open Specifications and introduce changes that you would consider may address them
7. You will generate a new docx by means of implementing step 6 you should upload to the SVN or docman of "FI-WARE Private" and will provide a link to it in column "Revised doc" of the cockpit
8. You will have to update the contents of the public wiki with the contents of the document associated to the revised version
It's up to each Chapter Leader to decide how to organize:
* Steps 1-4. Some of the Chapter Leaders may prefer to perform these steps by themselves but others may decide to distribute the task associated to each FI-WARE GE Open Specification in his chapter
* Step 5. Chapter Leaders will organize the assigned peer-review involving members of his chapter. How he does this is up to him and members of the chapter. They are asked to fill the column title "Assigned reviewer" to communicate who has been assigned the task to review a given doc. Note that you can start the review of an Open Specification as soon as the file is available (i.e., there is a link available in column "Doc to review" of the Peer-Review cockpit.
* Steps 6-8. I can imagine that the owner of a FI-WARE GE Open Specification will carry out these steps. However, the Chapter Leader may decide to carry out the update of the wiki, or distribute the task and assign it also to owners of each FI-WARE GE Open Specification
VERY IMPORTANT:
* PLEASE try to make steps 1-4 as soon as possible. Our experience is that this could be performed in maximum one hour per GE specification, probably much less. The sooner you make docx for review available on the cockpit, the sooner someone will review it.
* Step 8 is quite important because we plan to submit the final deliverables based on docx documents that will be generated once again from the wiki. Therefore, if you don't update the wiki, the resubmitted deliverable will go without your changes. SAP is working in a number of tools and processes that will help to produce the docx documents that will be finally submitted and I would like to thank them for the work they are doing in this respect.
Milestones for the peer-review are the following:
* deadline for sending peer-review reports with comments: October 23rd EOB
* deadline for implementing peer-review comments: October 30th EOB
Assignment of peer-reviewers is as follows:
Chapter to be reviewed
Reviewing chapter
Data
IoT
Cloud
Apps
Apps
Security
IoT
I2ND
I2ND
Cloud
Security
Data
Hope it works. Please try to make this final push. We face a critical milestone in the project that has to do with delivering a complete and rich set of FI-WARE Open Specifications. How they will be judged by reviewers will play a relevant role in our next, critical, review.
Don't hesitate to ask any question or doubt.
Last but not least, I would like to thank SAP for the support in defining this process and the work they are doing developing the tools that will try to automate the final generation of deliverables as much as possible.
Best regards,
-- Juanjo
-------------
Product Development and Innovation (PDI) - Telefonica Digital
website: www.tid.es<http://www.tid.es>
email: jhierro at tid.es<mailto:jhierro at tid.es>
twitter: twitter.com/JuanjoHierro
FI-WARE (European Future Internet Core Platform) Chief Architect
You can follow FI-WARE at:
website: http://www.fi-ware.eu
facebook: http://www.facebook.com/pages/FI-WARE/251366491587242
twitter: http://twitter.com/FIware
linkedIn: http://www.linkedin.com/groups/FIWARE-4239932
-------- Original Message --------
Subject: [Fiware-wpa] LIGTHS, CAMERA, ACTION!: Peer review of FI-WARE Open Specifications
Date: Thu, 11 Oct 2012 08:59:09 +0200
From: Juanjo Hierro <jhierro at tid.es><mailto:jhierro at tid.es>
To: fiware-wpl at lists.fi-ware.eu<mailto:fiware-wpl at lists.fi-ware.eu> <fiware-wpl at lists.fi-ware.eu><mailto:fiware-wpl at lists.fi-ware.eu>, fiware-wpa at lists.fi-ware.eu<mailto:fiware-wpa at lists.fi-ware.eu> <fiware-wpa at lists.fi-ware.eu><mailto:fiware-wpa at lists.fi-ware.eu>
Hi all,
Re-structuring of the wiki is almost done and complete FI-WARE GE Open Specifications can now be easily accessed from:
http://forge.fi-ware.eu/plugins/mediawiki/wiki/fiware/index.php/Summary_of_FI-WARE_Open_Specifications
Thanks to all of you for the great job !
Only the IoT chapter has not done the job. Unfortunately, I'm afraid this was because Thierry was sick and probably the request didn't arrive at the IoT Chapter team. I will take care of this personally and, hopefully, the whole chapter will be fixed by EOB today. The pages of some few FI-WARE GE Open Specifications need to revised because they seem to have found some issue adapting to the proposed template. We will contact you directly for those cases.
We should start now the last and third peer review of the Open Specifications. Following is the proposal on assignment of the third peer-reviews:
Chapter to be reviewed
Reviewing chapter
Data
IoT
Cloud
Apps
Apps
Security
IoT
I2ND
I2ND
Cloud
Security
Data
I have tried to avoid repeating any previous peer review (you can find the tables summarizing assignment in previous peer-reviews at the end of this message, just fyi).
The calendar I propose to follow is this:
* deadline for sending peer-review reports with comments: October 23rd EOB
* deadline for implementing peer-review comments: October 30th EOB
Don't forget to use the attached template for comments. Since we have now re-structure the wiki, we have adapted it so that you have to carry out first a peer-review of the Chapter Architecture and then of each of the FI-WARE GE Open Specifications, once again listed at:
http://forge.fi-ware.eu/plugins/mediawiki/wiki/fiware/index.php/Summary_of_FI-WARE_Open_Specifications
Our target goal is to have all FI-WARE GE Open Specifications submitted by the end of the week starting October 29th, i.e., deadline would be November 2nd. Deliverables for the chapters do not have to be submitted on exactly the same date, so we will submit deliverables corresponding to the chapters along that week.
Please foward to your teams.
Cheers,
-- Juanjo
====== Appendix: tables with assignments in previous reviews
First peer review:
Chapter to be reviewed
Reviewing chapter
Data
Security
Cloud
Data
Apps
Cloud
IoT
Apps
I2ND
IoT
Security
I2ND
Second peer review:
Chapter to be reviewed
Reviewing chapter
Data
Cloud
Cloud
I2ND
Apps
IoT
IoT
Data
I2ND
Security
Security
Apps
________________________________
Este mensaje se dirige exclusivamente a su destinatario. Puede consultar nuestra política de envío y recepción de correo electrónico en el enlace situado más abajo.
This message is intended exclusively for its addressee. We only send and receive email on the basis of the terms set out at:
http://www.tid.es/ES/PAGINAS/disclaimer.aspx
________________________________
Este mensaje se dirige exclusivamente a su destinatario. Puede consultar nuestra política de envío y recepción de correo electrónico en el enlace situado más abajo.
This message is intended exclusively for its addressee. We only send and receive email on the basis of the terms set out at:
http://www.tid.es/ES/PAGINAS/disclaimer.aspx
_______________________________________________
Fiware-wpa mailing list
Fiware-wpa at lists.fi-ware.eu<mailto:Fiware-wpa at lists.fi-ware.eu>
http://lists.fi-ware.eu/listinfo/fiware-wpa
________________________________
Este mensaje se dirige exclusivamente a su destinatario. Puede consultar nuestra política de envío y recepción de correo electrónico en el enlace situado más abajo.
This message is intended exclusively for its addressee. We only send and receive email on the basis of the terms set out at:
http://www.tid.es/ES/PAGINAS/disclaimer.aspx
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fiware.org/private/fiware-wpa/attachments/20121012/716fe87b/attachment.html>
You can get more information about our cookies and privacy policies clicking on the following links: Privacy policy Cookies policy