feat: add a README file #33
Conversation
|
This commit is a first version to outline the structure and the content of the documentation. I am working on the |
README.md
Outdated
| @@ -0,0 +1,120 @@ | |||
| # NgsiLdToCkan | |||
|
|
|||
| [](https://www.fiware.org/developers/catalogue/) | |||
There was a problem hiding this comment.
it is not (yet) a FIWARE component
README.md
Outdated
| # NgsiLdToCkan | ||
|
|
||
| [](https://www.fiware.org/developers/catalogue/) | ||
| [](https://www.etsi.org/deliver/etsi_gs/CIM/001_099/009/01.06.01_60/gs_CIM009v010601p.pdf) |
There was a problem hiding this comment.
it is not a NGSI-LD context broker
README.md
Outdated
| - [Metadata List](#metadata-list) | ||
|
|
||
| ## Overview | ||
| `NgsiLdToCkan` is a Nifi processor developed by FIWARE to persist NGSI-LD context data events within a [CKAN](https://ckan.org/) server. Context data is received as a notification sent by a Context Broker or any system that supports NGSI-LD. |
There was a problem hiding this comment.
developed by FIWARE?? you got a new job?
There was a problem hiding this comment.
it's not initially developed by them? (the fiware-draco.. that's why I added this)
There was a problem hiding this comment.
Draco is a FIWARE component developed by UPM
README.md
Outdated
| - [Metadata List](#metadata-list) | ||
|
|
||
| ## Overview | ||
| `NgsiLdToCkan` is a Nifi processor developed by FIWARE to persist NGSI-LD context data events within a [CKAN](https://ckan.org/) server. Context data is received as a notification sent by a Context Broker or any system that supports NGSI-LD. |
README.md
Outdated
|
|
||
| ## Functionality | ||
|
|
||
| The processor receives NGSI-LD events (notifications) and converts them internally into an `NGSIEvent` objects, which contain the entities to be published on the CKAN server. |
There was a problem hiding this comment.
Too technical, the user does not care about the NGSIEvent object.
README.md
Outdated
| ``` | ||
| ### Output | ||
|
|
||
| The `NgsiLdToCkan` processor publishes all entities received in the notified context data in the same dataset. Each entity will be added as a resource |
There was a problem hiding this comment.
the first sentence is not correct
There was a problem hiding this comment.
all entities of the same type ?
README.md
Outdated
|
|
||
| CKAN offers a generic mapping between its model and [DCAT](https://www.w3.org/TR/vocab-dcat-3/) classes like `dcat:Dataset` and `dcat:Distribution`. | ||
| CKAN offers a generic mapping between its model and [DCAT](https://www.w3.org/TR/vocab-dcat-3/) classes like `dcat:Catalog`, `dcat:Dataset` and `dcat:Distribution`. |
There was a problem hiding this comment.
But there's no mapping for a dcat:Catalog ?
No description provided.