[Fiware-wpl] *** EXTREMELY IMPORTANT *** How to populate the catalogue!!!

Matteo Melideo matteo.melideo at eng.it
Wed Aug 1 12:09:53 CEST 2012


Dear All,
sorry if the mail is a bit long but I think it is extremely necessary 
after the conference call we had yesterday and the current status of the 
catalogue.

The first clarificationis that in our view (catalogue and testbed), 
these are the existing relationships:
- 1 Generic Enabler Open Specification corresponds to 1..N Generic 
Enabler implementations.
- 1 Generic Enabler implementation can have 1...N Generic Enabler 
Instance\s.
(The reason for the last relationship is that in the future, according 
to the DoW, we assume the possibility to have not only the FI-WARE 
Testbed but different FI-WARE Instances. For this reason we assume that 
for 1 Generic Enabler implementation there could be different endpoints 
(instances) on different FI-WARE Instances).

The second clarificationis that the FI-WARE Catalogue is the FI-WARE 
Generic Enablers Implementations Catalogue(we will change the name 
accordingly and explain this in the first page as an introduction for 
the potential users). This means that each entry into the catalogue 
should represent an implementation (complete or partial) of a Generic 
Enable Open specification and this MUST be evident!!!

The third clarificationconcerns how to populate the different pages 
arranged for each Generic Enabler Implementation: Overview - Instances - 
Download - Documentation. (For the "Instances" label we will also try to 
find a more self explanatory alternative).

Overview: this page should explain what you are offering and mainly what 
GE Open Specification you are implementing, detailing if you are 
implementing all the specification or only part of it and, if possible 
an overview of the API.  (see attached file for template)

To note: Where and when it makes sense you should also include links to 
wiki pages (e.g., when referring to the Open Specifications, it should 
be the link to the wiki page where the specifications are published).

Instances: this is a very simple page where it should be specified at 
least one URL of the endpoint where requests to operations of the 
RESTFul API can be directed in order to interact with the GE. (One 
endpoint as at the moment there is only the FI-WARE Testbed. Hopefully 
in the next future we will have more endpoints if there will be more 
FI-WARE Instances). For this endpoint you have the opportunity to 
provide any additional information you may consider helpful (e.g. 
registration required, legal constraints, terms of use, etc.).

In this page it is also possible to add links to admin pages or user 
interface pages related to the specific GE instance (e.g., Cloud Portal)
IMPORTANT NOTE:  At this time we don't know, but we may lead to multiple 
instances of the same GE implementation deployed on the FI-WARE Testbed, 
each serving a concrete UC project (because the GE implementation 
happens not to be multi-tenant, or there are conditions that recommend 
so). If that it is the case, the information of each of those instances 
should be listed here, clear enough as to allow each UC project to find 
out what instance to use or ask for a specific one. (see attached file 
for template)

Download: this page is to add any client, library, driver, stub or 
whatever necessary to be installed locally to interact with the GE 
endpoint. In addition to this, it will be possible to add the source 
code or binaries (whatever is applicable) of the GE implementation of 
those GEs that are public plus any other file or necessary document 
(release notes, license and terms of use, etc.)  (see attached file for 
template)

Documentation: any information necessary for the developer to use the 
endpoint and the sw listed in the download page (e.g code examples, how 
to use, tricks and tips, etc.). This page should include at least the 
Users' and Programmers' Guide that has been produced for the release. 
  (see attached file for template)

It is important to note that the GEs that will not comply with the rules 
above will not be published in the catalogue (or unpublished for those 
already published) and therefore not be made accessible to UC projects. 
We pretend that the FI-WARE Generic Enablers Implementations Catalogue 
becomes the single, user-friendly, mean through which the UC projects 
will get all the information they need to start using the GE 
implementations available at the FI-WARE Testbed.

In this respect, we expect that the catalogue is populated and\or 
updated in parallel with the deployment of the GE instance in the 
FI-WARE Testbed.

Please do not hesitate to ask for additional clarifications and send us 
comments and suggestions to improve.

Thanks a lot for your cooperation and best regards,

Matteo, Davide Stefano and Juanjo
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fiware.org/private/fiware-wpl/attachments/20120801/c3aa055a/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: Catalogue sections templates.doc
Type: application/msword
Size: 18944 bytes
Desc: not available
URL: <https://lists.fiware.org/private/fiware-wpl/attachments/20120801/c3aa055a/attachment.doc>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: matteo_melideo.vcf
Type: text/x-vcard
Size: 354 bytes
Desc: not available
URL: <https://lists.fiware.org/private/fiware-wpl/attachments/20120801/c3aa055a/attachment.vcf>


More information about the Fiware-wpl mailing list

You can get more information about our cookies and privacy policies clicking on the following links: Privacy policy   Cookies policy