Details
-
Enabler
-
Must have
-
None
-
True
-
Data Processing
-
-
-
Intra Program
-
2
-
2
-
0
-
REL-815 SDP 0.18.0
-
Team_NALEDI
-
Sprint 5
-
-
-
-
20.6
-
Stories Completed, Integrated, BDD Testing Passes (no errors), Outcomes Reviewed, NFRS met, Demonstrated, Satisfies Acceptance Criteria, Accepted by FO
-
-
Low-G1 Mid-G1
Description
Address the specific points that have been raised from internal reviews of the documentation for recent versions of SDP (0.16.x):
- Poor introduction.
- Needs a list of functionality the system currently supports in a language that talks to the way others will use SDP.
- Needs an easy way to find the documented public API, e.g. where to find what it means when the SDP subarray reports its health state is OK.
- Missing easy to find documentation of SDP UIs (signal displays, Taranta dashboards). Needs to link to data product dashboard documentation.
- Not easy enough to find out how to use SDP for key use cases.
- Information is duplicated, e.g. instructions for operating the SDP in a number of pages in the "Running the SDP" and "Using the SDP" sections. Reorganise the pages to remove the duplication and inconsistencies as far as possible. Possible arrangement of sections:
- Design
- Installation
- Operation
- Development
- Troubleshooting
- Information on installing and testing in Minikube is prominent in older pages. The standard instructions should be about installing SDP in SKAO-managed clusters (STFC cloud, PSIs, ITFs) and treat Minikube as a special case (see next point).
- Revise Minikube-related documentation to use standard SKAO Minikube deployment instead of custom configuration.
- Design section is out of date. Components and Modules pages are missing information on queue connector Tango devices, data queues (Kafka) and QA components.
Who?
- Solution and product managers.
- AIV engineers.
What?
- Documentation revised to address points listed above.
Why?
- Make the documentation more useful to users not familiar with the system.
References
Attachments
Issue Links
- Is delivered by
-
REL-815 SDP 0.18.0
- Released
- mentioned on