[Fiware] Guidelines for Open Specs

[Miguel Carrillo]

Dear all,

The delivery of the 22nd is about to finish. For those who have availability I anticipate now the process for generating the deliverable and the schedule. I will send it to the general list for everyone's knowledge and quick transmission. Read carefully as this contains the basic info that you need.

We will try to simplify it this time  as we are a bit late: the edit will take place on the public wiki directly and we will have a single review.

We will use a new online cockpit to follow up the progress(usual procedure):

  *   https://docs.google.com/spreadsheet/ccc?key=0AmxBgS-lWT4vdHYxYTVOZ3FrNEprZXRBZk80TGRLMGc#gid=0

Rules to follow:

  *   We will have the same reviewers as in the last round of reviews of the Architecture
  *   The doc we are editing is composed of the pages linked from
     *   http://forge.fi-ware.eu/plugins/mediawiki/wiki/fiware/index.php/Summary_of_FI-WARE_Open_Specifications
     *   Yes, you need to create new pages for the new GEs in R2 that are not there yet
     *   Use the literally the same GE names as in the Architecture doc
  *   Do not use "_R2" in the name of the pre-existing pages. If there are changes in a given page delivered in R1, this is a normal evolution of the same GE and we do not keep different pages for different releases
  *   In general, same rules as on the previous occasion: include the architecture pages, use {{TOCright}}, create a table at the top right corner, etc. Go to old GEs from Release 1 on the wiki to see what I mean. Be careful with the "include", they are a bit tricky. These rules are the ones we followed for the resubmission last year, go here to see them:
     *   https://forge.fi-ware.eu/plugins/mediawiki/wiki/fi-ware-private/index.php/Where_and_how_to_publish_Open_Specifications
     *   In particular, we need to follow this template linked from there:
        *   https://forge.fi-ware.eu/plugins/mediawiki/wiki/fi-ware-private/index.php/Open_specification_resubmission_template
     *   As this is a bit crude, we have prepared an example on the private wiki  to better explain it:
        *   https://forge.fi-ware.eu/plugins/mediawiki/wiki/fi-ware-private/index.php/FIWARE.OpenSpecification.ExChapter.ExGE

  *   Part of the work is creating the API Open Specs.
     *   WPLs/WPAs, please make sure that they are properly linked from the Architecture and also from:
        *   http://wiki.fi-ware.eu/Summary_of_FI-WARE_API_Open_Specifications
     *   Please ensure that you have the same sections for the API pages as the provided example. It will save us iterations  when we review it.
     *   The general guidelines link a template for this, that is located here:
        *   https://forge.fi-ware.eu/plugins/mediawiki/wiki/fi-ware-private/index.php/RESTful_API_specification_template

Schedule

  *   You can start editing now or next week once you finish your contributions for the deadlines of the 22nd of April
  *   29/April/2013 - this day EOB I will expect the doc version of your chapter uploaded and ready on the open Specs cockpit
  *   30/April/2013 - start of the peer review
  *   08/May/2013 - end of the peer review. At the end of this day, the cockpit has links to all the reviews stored on the private project(a word doc tracking the changes).
  *   10/May/2013 - end of incorporation of comments. This is done directly on thew wiki. At the end of this day, the Open specs cockpit has the new versions of the docs, with all changes incorporated. This docs must be re-generated from the wiki by the WPL

Note that we will possibly  deliver to the EC chapter by chapter.

Info for the WPL/WPAs: I will create placeholders for the cover pages on the delivery cockpit shortly. But start editing the Open Spec, this pages I refer to is is something that we will need when we generate the doc (so this is not urgent and not for now) - your partners do not need this to start the work. It will be located here:

  *   https://forge.fi-ware.eu/plugins/mediawiki/wiki/fi-ware-private/index.php/Deliverables_cockpit

Each WPL/WPA will have to organize his WP internally to comply with this.

Best regards,

Miguel


--
----------------------------------------------------------------------
     _/          _/_/                     Miguel Carrillo Pacheco
    _/   _/     _/  _/   Telefónica       Distrito Telefónica
   _/ _/_/_/   _/   _/   Investigación y  Edifico Oeste 1, Planta 4
  _/   _/     _/  _/     Desarrollo       Ronda de la Comunicación S/N
 _/          _/_/                         28050 Madrid (Spain)
                                          Tel:  (+34) 91 483 26 77

                                          e-mail: mcp at tid.es<mailto:mcp at tid.es>

Follow FI-WARE on the net

        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
----------------------------------------------------------------------

________________________________

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/old-fiware/attachments/20130419/d84654de/attachment.html>