This is documentation of communication among SHOP4CF components.
As the first step, we document input/output of components. The purpose is to identify similarities and propose an uniform FIWARE data model for communication among components (and also for communication between the components and other systems in pilot locations).
Draft documentation files are already present in this repo for each component. Responsible project partners are expected to update them, and to keep updating them in the future, if needed.
To contribute, make changes to files under docs/partners/<partner>/
.
You can also find your files starting from the index: index.md.
Changes can be made either via GitHub web interface or via Git clients.
Format files with Markdown (see GitHub docs).
To push your changes:
- fork this repo, edit files, and open a pull request back to this repo (these steps happen automatically when editing via the web interface), or
- send your GitHub username to Michal Zimniewicz (PSNC) via email; once you get permissions, you can create your branch in this repo and then open a pull request to branch master.
If you modify file names or add new *.md
files,
then please update index.md accordingly.
Any other suggestions are welcomed.