Uploaded image for project: 'SAFe Program'
  1. SAFe Program
  2. SP-641

Create 'getting started guide' and design documentation for the SDP MVP

Change Owns to Parent OfsSet start and due date...
    XporterXMLWordPrintable

Details

    • Data Processing
    • Hide

      A 'getting started guide' is needed in order to make it easier for new and existing SKA developers to work on and with the Data Processing SDP MVP. Alongside this getting started guide design documentation describing the current implementation of the Data Processing SDP MVP is important to be able to communicate the current state of the solution, and to help inform new and existing developers who are contributing to this code base.

      Show
      A 'getting started guide' is needed in order to make it easier for new and existing SKA developers to work on and with the Data Processing SDP MVP. Alongside this getting started guide design documentation describing the current implementation of the Data Processing SDP MVP is important to be able to communicate the current state of the solution, and to help inform new and existing developers who are contributing to this code base.
    • Hide

      Sphinx (Read the Docs) documentation discoverable via the SKA Developer portal consisting of a getting started guide and initial design documentation for the SDP MVP (currently in the sdp-prototype repo)

      The design documentation should include:

      • A description of the structure and behaviour of different services and controllers
      • A description of the structure and behaviour of a basic workflow

      This feature will be tested as follows:

      A questionnaire that will be sent out to teams that will need to make use of this documentation (PSS and NZAPP) asking to rate the usefulness of the documentation along three dimensions 

      • The ease of understanding how to get started and integrate their products into the system
      • The ease of understanding the context of how their products fit into the rest of the system
      • The ease of understanding key architectural concerns and high-level design that guide the way they should implement their products.
      Show
      Sphinx (Read the Docs) documentation discoverable via the SKA Developer portal consisting of a getting started guide and initial design documentation for the SDP MVP (currently in the sdp-prototype repo) The design documentation should include: A description of the structure and behaviour of different services and controllers A description of the structure and behaviour of a basic workflow This feature will be tested as follows: A questionnaire that will be sent out to teams that will need to make use of this documentation (PSS and NZAPP) asking to rate the usefulness of the documentation along three dimensions  The ease of understanding how to get started and integrate their products into the system The ease of understanding the context of how their products fit into the rest of the system The ease of understanding key architectural concerns and high-level design that guide the way they should implement their products.
    • 3
    • 3
    • 4.333
    • Team_SIM
    • Sprint 5
    • Hide

      The SDP prototype documentation in the developer portal has been significantly expanded to include information on the design and how to develop a workflow:

      https://developer.skatelescope.org/projects/sdp-prototype/en/latest/

      The PSS team has used the documentation to develop a PSS receive workflow and execution engine, which has been successfully incorporated into the prototype.

      Show
      The SDP prototype documentation in the developer portal has been significantly expanded to include information on the design and how to develop a workflow: https://developer.skatelescope.org/projects/sdp-prototype/en/latest/ The PSS team has used the documentation to develop a PSS receive workflow and execution engine, which has been successfully incorporated into the prototype.
    • 5.6
    • PI24 - UNCOVERED

    • 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

          Structure

            Activity

              People

                g.leroux Le Roux, Gerhard [X] (Inactive)
                g.leroux Le Roux, Gerhard [X] (Inactive)
                Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Feature Progress

                  Story Point Burn-up: (82.14%)

                  Feature Estimate: 3.0

                  IssuesStory Points
                  To Do15.0
                  In Progress   00.0
                  Complete1123.0
                  Total1228.0

                  Dates

                    Created:
                    Updated:
                    Resolved:

                    Structure Helper Panel