/communication-docs

Documentation of communication among SHOP4CF components

Communication among SHOP4CF components

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.

Contributing

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:

  • open a pull request, or
  • contact Michal Zimniewicz (PSNC) via email to get permissions to push directly.

If you modify file names or add new *.md files, then please update index.md accordingly.

Any other suggestions are welcomed.