Details
-
Enabler
-
Data Processing
-
-
-
3
-
3
-
4.333
-
Team_SIM
-
Sprint 5
-
-
-
-
5.6
-
-
Team_SIM goal_D1 goal_S1 goal_S3
Description
Create a 'getting started guide' and design documentation for the current Data Processing SDP MVP (ie. the sdp-prototype repo) that is discoverable through the SKA developer portal (https://developer.skatelescope.org) and targeted towards developers working on the data processing evolutionary prototype. This should take the form of Sphinx (Read the Docs) documentation that can be easily kept up to date.
The 'getting started guide' should be accessible to developers not already familiar with the MVP, and at a minimum describe:
- The current capabilities of this prototype
- How to obtain and execute the SDP MVP on a development machine
- How to obtain and execute the SDP MVP in the integrated test environment
Design documentation should include (but not necessarily be limited to):
- A description of how the different services and controllers work together
- A description of how errors and failures propagate
- A description of how workflows are developed and integrated
This documentation should be maintained alongside the code and be placed under revision control such that it can be easily referred to and and updated as the code evolves.
Where possible, it should be linked (both ways) to the relevant architecture documents so that it provides traceability between the high-level intended architecture and current implemented solution. As the relevant architecture documentation may not yet in a form that supports this traceability, the team developing documentation should stay in close communication with the DP Architect, so that they are up to date with how the SKA Solution Intent is being managed.
As this is a strictly time-boxed activity and is expected to evolve in future PIs along with the code, if full traceability to architecture documents is not possible documenting the current implementation should take priority over the practices of SKA Solution Intent.
Attachments
Issue Links
- relates to
-
SP-688 Simple batch processing blocks
- Done
-
SP-699 Workflow execution in the integration environment
- Done
-
SP-698 Design documentation for the SDP MVP
- Discarded
-
SP-707 PSS receive workflow integration with the SDP MVP
- Done
-
SS-24 Enable execution of workflows across the OMC and SDP MVPs
- Done
- links to
- mentioned in
-
Page Loading...
-
Page Loading...
-
Page Loading...
-
Page Loading...
-
Page Loading...
-
Page Loading...
-
Page Loading...