[Fiware-chapter-leaders] [IMPORTANT]Guidelines for the Open Specs (important clarification)

[MIGUEL CARRILLO PACHECO]

Dear all,

A colleague came to me asking one question and I realised that there is a wrong approach in some GEs. Fortunately, I took a look and saw  that there are very few who have posted their contributions to the wiki already.

The "Summary of Open specs" pages work as in previous versions. I anticipated that it is a "coarse copy-paste from previous versions" implying that the structure is similar. For instance, see the source wiki page for the "old" Open Specs of the Orion Context Broker:

  *   <https://forge.fiware.org/plugins/mediawiki/wiki/fiware/index.php?title=FIWARE.OpenSpecification.Data.ContextBroker&action=edit> https://forge.fiware.org/plugins/mediawiki/wiki/fiware/index.php?title=FIWARE.OpenSpecification.Data.ContextBroker&action=edit

most of it is "includes" of Architecture pages!!!  Admittedly, sometimes you will need to shuffle around the sections in the architecture to make them uniform but this should not be a big deal.

The big work is actually for the other part, the API. The "Summary" page should be easy and quick.

This must be a bit new for the new enablers/partners but for the others it should be trivial to understand.

Sorry if this was not sufficiently clear in the first place.

Best regards,

Miguel
P.D.: It would be arguable whether to using the same info on two pages makes sense. We were forced to do this after receiving one comment from the reviewers.


El 18/07/2015 a las 0:07, MIGUEL CARRILLO PACHECO escribió:
Dear all,

My colleague José Manuel Cantera has anticipated how you should edit the Open Specs APIs and this is the major item of work we expect for this part of the 4th Release of the Open Specs. But I will add the information to complete the work. We will proceed like this:

AS REGARDS THE APIs
=====================

  *   You will create the APIs following Jose Manuel´s intructions, ideally on APIary.
  *   If you do not use APIary as we expect you will do by default, you are free to do so but it would be trouble for you.  This would imply that the automated tools we are creating to produce deliverables would not work for you and you would have to create all by hand and complying strictly with the same templates, etc. We will not accept any delays on the grounds of this, if you do not accept APIry it is fine but then you will need to make the effort to present the same docs in time.
  *   The documents I refer to will be automatically generated from your APIary repository and you will add them to your Github repository.
     *   If you use APIary following the guidelines, you will get the docs as an output of automated scripts
     *   If you do not use APIARy the process is the same, you will have to edit the docs by hand and upload to Github
     *   Jose Manuel will send the templates for those who refuse to use APIAry when they are ready (getting there but not available yet  ...). Those using APIary do not need them.
  *   You mustn't edit the pages linked from this one:
     *   http://wiki.fiware.org/Summary_of_FIWARE_API_Open_Specifications
     *   At the end of the process we will just put a list of links to the Github repos and this page will just have the list of links.

AS FOR THE "SUMMARY OF OPEN SPECS" PAGES
=========================================
The work space is this page I just created to start it up:

  *   http://wiki.fiware.org/Summary_of_FIWARE_Open_Specifications_R4

Work to do:

  *   This page is a coarse copy-paste from the previous one with slight modifications. The chapter leaders will have to add, delete, modify or whatever is needed to ensure that we have the links for the GEs in their chapters in R4 on this page. There are radical changes to do in several chapters (Security, I2ND and  WebUI, for instance)
  *   Each GE owner will have to provide their inputs for his/her GE page linked from here. Please use these sections STRICTLY:

1 Preface
2 Copyright
3 Legal Notice
4 Overview
5 Basic Concepts
6 Generic Architecture
7 Main Interactions
8 Basic Design Principles
9 Detailed Specifications
10 Re-utilised Technologies/Specifications
11 Terms and definitions

  *   In "9 Detailed Specifications" we just want  a link to the Github repository. We will add an explanatory text later.

DEADLINES
=================

  *   July, 24: For the leaders to have the links on page  ready (if absent, the Architect will have to do it architect) – I will apply karma on the 27th
  *   Sept, 4: The summer is here and most of you will take a few weeks of well deserved break. Let us give a reasonable deadline the GE owners to have their pages and all on Github at the beginning of September (on the 4th).

Needless to say, the chapter leaders have the duty of following up an ensuring that all is in good order and delivered on time.

Regards,

Miguel

--

Please update your address book with my new e-mail address: miguel.carrillopacheco at telefonica.com<mailto:miguel.carrillopacheco at telefonica.com>

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

                         e-mail: miguel.carrillopacheco at telefonica.com<mailto:miguel.carrillopacheco at telefonica.com>

Follow FIWARE on the net

        Website:  http://www.fiware.org
        Facebook: https://www.facebook.com/eu.fiware
        Twitter:  http://twitter.com/Fiware
        LinkedIn: https://www.linkedin.com/groups/FIWARE-4239932
----------------------------------------------------------------------

________________________________

Este mensaje y sus adjuntos se dirigen exclusivamente a su destinatario, puede contener información privilegiada o confidencial y es para uso exclusivo de la persona o entidad de destino. Si no es usted. el destinatario indicado, queda notificado de que la lectura, utilización, divulgación y/o copia sin autorización puede estar prohibida en virtud de la legislación vigente. Si ha recibido este mensaje por error, le rogamos que nos lo comunique inmediatamente por esta misma vía y proceda a su destrucción.

The information contained in this transmission is privileged and confidential information intended only for the use of the individual or entity named above. If the reader of this message is not the intended recipient, you are hereby notified that any dissemination, distribution or copying of this communication is strictly prohibited. If you have received this transmission in error, do not read it. Please immediately reply to the sender that you have received this communication in error and then delete it.

Esta mensagem e seus anexos se dirigem exclusivamente ao seu destinatário, pode conter informação privilegiada ou confidencial e é para uso exclusivo da pessoa ou entidade de destino. Se não é vossa senhoria o destinatário indicado, fica notificado de que a leitura, utilização, divulgação e/ou cópia sem autorização pode estar proibida em virtude da legislação vigente. Se recebeu esta mensagem por erro, rogamos-lhe que nos o comunique imediatamente por esta mesma via e proceda a sua destruição



_______________________________________________
Fiware-chapter-architects mailing list
Fiware-chapter-architects at lists.fi-ware.org<mailto:Fiware-chapter-architects at lists.fi-ware.org>
https://lists.fi-ware.org/listinfo/fiware-chapter-architects



--

Please update your address book with my new e-mail address: miguel.carrillopacheco at telefonica.com<mailto:miguel.carrillopacheco at telefonica.com>

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

                         e-mail: miguel.carrillopacheco at telefonica.com<mailto:miguel.carrillopacheco at telefonica.com>

Follow FIWARE on the net

        Website:  http://www.fiware.org
        Facebook: https://www.facebook.com/eu.fiware
        Twitter:  http://twitter.com/Fiware
        LinkedIn: https://www.linkedin.com/groups/FIWARE-4239932
----------------------------------------------------------------------

________________________________

Este mensaje y sus adjuntos se dirigen exclusivamente a su destinatario, puede contener información privilegiada o confidencial y es para uso exclusivo de la persona o entidad de destino. Si no es usted. el destinatario indicado, queda notificado de que la lectura, utilización, divulgación y/o copia sin autorización puede estar prohibida en virtud de la legislación vigente. Si ha recibido este mensaje por error, le rogamos que nos lo comunique inmediatamente por esta misma vía y proceda a su destrucción.

The information contained in this transmission is privileged and confidential information intended only for the use of the individual or entity named above. If the reader of this message is not the intended recipient, you are hereby notified that any dissemination, distribution or copying of this communication is strictly prohibited. If you have received this transmission in error, do not read it. Please immediately reply to the sender that you have received this communication in error and then delete it.

Esta mensagem e seus anexos se dirigem exclusivamente ao seu destinatário, pode conter informação privilegiada ou confidencial e é para uso exclusivo da pessoa ou entidade de destino. Se não é vossa senhoria o destinatário indicado, fica notificado de que a leitura, utilização, divulgação e/ou cópia sem autorização pode estar proibida em virtude da legislação vigente. Se recebeu esta mensagem por erro, rogamos-lhe que nos o comunique imediatamente por esta mesma via e proceda a sua destruição
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fiware.org/private/fiware-chapter-leaders/attachments/20150820/9dd37abd/attachment.html>