Details
-
Feature
-
Must have
-
None
-
Data Processing
-
-
-
Intra Program
-
3
-
3
-
0
-
REL-670 SDP 0.16.0
-
Team_NALEDI
-
Sprint 4
-
-
-
-
19.5
-
Stories Completed, Integrated, Outcomes Reviewed, Demonstrated, Satisfies Acceptance Criteria, Accepted by FO
-
-
SOL-G1 SOL-G4
Description
Improve the documentation of SDP releases to provide explicit information about the interfaces it supports and the tests it has passed.
The interface documentation should include information on the APIs, especially the Tango interface and the schema versions it supports. It should also include the user interfaces, including signal displays, Taranta dashboard, data product dashboard and SDP Jupyter notebooks. It could also include low-level interfaces, like shell commands to retrieve data products from a Kubernetes volume ("kubectl cp ...") which would be useful if the data product dashboard is not deployed.
We could document the interfaces in the SDP integration documentation by linking from there to the relevant component documentation. The integration documentation would need some rearrangement to make it more user-centric. It would require being able to link to the tagged version of the documentation for a component release or an SDP release, rather than just the latest version. At the moment it appears we only publish the latest version (and sometimes the "stable" version, which is the most recently tagged semantic version) for SDP repositories on Read the Docs.
Documenting the tests that a release has passed might be as simple as taking the existing SDP integration tests in Jira and grouping them into a test plan.
The interface and test documentation should be linked to the release (REL) ticket in Jira.
Who?
- SDP users
- AIV engineers.
What?
- Documentation for SDP releases of:
- Interfaces provided by the release, including APIs and UIs;
- Tests the release has passed.
- TBC: Build tagged versions of SDP documentation corresponding to releases.
- Links from the release (REL) ticket to the documentation.
Why?
- Enables users of the SDP, including AIV engineers, who may not be familiar with the system, to understand its interfaces and explore and test its behaviour.
