Prometeo-Pyrrha icon indicating copy to clipboard operation
Prometeo-Pyrrha copied to clipboard

Published 20 hours ago • verified publisher icon Call-for-Code

High-level overview/diagram of the software architecture for Open Source (OS) contributors [software steel-thread]

Open JSegrave-IBM opened this issue 4 years ago • 0 comments

"As an Open Source (OS) contributor, I need a high-level overview of the software architecture so that I can understand how to implement any enhancements or defect fixes that I want to contribute."

These 'Open Source Contributors' include us Prometeo team members :-)

  • Publish a software architecture Enablement doc in the Prometeo GitHub repo
  • Include a high level overview diagram and brief description ('less is more' - brief is easier for readers)
  • Maybe show how a sensor reading gets from an API to the dashboard -worked examples always help
  • (simulation story #94 will also add documentation here describing how to generate simulated sensor data for testing)

Subsequent epics will add more substance to this Enablement doc and flesh out the worked examples.

JSegrave-IBM avatar Jul 28 '20 09:07 JSegrave-IBM