We use proprietary and third party's cookies to improve your experience and our services, identifying your Internet Browsing preferences on our website; develop analytic activities and display advertising based on your preferences. If you keep browsing, you accept its use. You can get more information on our Cookie Policy
Cookies Policy
How to describe assets adopted as baseline for development of GE reference implementations - FIWARE Forge Wiki

How to describe assets adopted as baseline for development of GE reference implementations

From FIWARE Forge Wiki

Jump to: navigation, search

This tutorial describes how to add the description of assets adopted as baseline for development of FI-WARE GE reference implementations to the Wiki.

Find the place where description of assets should go

On the Wiki Main page click on "Materializing the FI-WARE Vision" in the "Getting started with FI-WARE" section.

You will see the following page that containes different sections for each FI-Ware chapter (e.g. Apps & Services, Cloud Hosting, etc.). Use one of these sections if you are a FI-WARE member.

When you navigate to the Wiki page where materialization of a given FI-WARE chapter is described, you will see it is structured in a number of sections, one per Generic Enabler on the chapter. Each section is further structured into subsections and one of them (the first one) deals with description of Baseline Assets. You can edit this subsection by clicking on the "Edit" link on the right hand side of the subsection title.

Adding the description of assets to the 'Baseline Assets' section

You should provide the contents of the section. It should contain a list of the assets adopted as baseline. Not just the ones to be developed/evolved in FI-WARE but also those open source assets coming from third parties that are relevant to mention.

You must associate a page to each of the assets in the list. Please add an introductory paragraph and a closing paragraph (which introduces the list of Themes/Epics/Feactures/User-stories associated to the implementation of the Generic Enabler):

By clicking on the red links you will create the page linked to description of the asset.

Regarding assets being developed/evolved in FI-WARE, you should provide the following info (check the example below):

  • Brief Description:
Add a brief description (one-two paragraphs) about the asset (it is assumed that the reader will have to review publicly available documentation below in order to learn more details about the asset).
In addition, provide a description of the programs (internal to a company or public funding) under which the asset has been developed.
  • Programming artifacts
Here we will briefly describe what sort of artifacts (APIs, tools) will be provided to app developers or to ease integration. It is important to describe what bindings (e.g., REST, SOAP, IIOP, Java API ...) are supported for each API
  • Technologies used
How the asset is programmed and what programming libraries from Runtime base technologies (e.g., JQuery) it uses
  • Runtime pre-requisites
Description of software to be installed in servers/clients where software linked to the asset is expected to run. If needs to be a concrete version, please specify.
  • IPR
Explain whether the product is going to be licensed as Open Source (in such case, what Open Source License) or will be licensed under FRAND (Fair Reasonable and Non-Discriminatory) Terms according to pre-requisites of the FI-PPP program.
  • Publicly available documentation
Include here links to manuals, articles, whatever information (no matter how much detailed) could be useful to learn about the asset.

For open source assets coming from third parties, you just need to provide the Brief Description section, The IPR section (essentially describing what is the open source license associated to the asset) and the section with links to Publicly available documentation.

Personal tools
Create a book