Open
1 of 1 issue completed
Description
Documentation Publication
All APIs, libraries, and user facing functions that we own must be documented and published. This does not include COTS products like Jupyter, Airflow, etc, though we may want to ensure existing documentation for that is valid.
Acceptance Criteria
Acceptance criteria required to implement the epic
- Unity-sds-client documentation is published and up to date with latest capabilities
- All Schemas are documneted as openAPI specifications and are CMed in https://github.com/unity-sds/unity-monorepo/tree/main/schemas
- All Schemas are published - see https://github.com/unity-sds/unity-monorepo/tree/main/schemas/app-package-service and https://github.com/unity-sds/unity-monorepo/blob/main/.github/workflows/schema_apgs.yml for examples of publishing and documenting a schema automatically
- Schemas we expect:
- OGC server api (SPS)
- DAPA server API (UDS)
- App-package-generation-system (ADS)
- Healthcheck schema (CS?)
- Others?
- Librariers we expect:
- unity-sds-client (UIUX)
- uds-stage-in/out libraries (UDS)
- Other Documentation
- Stage-in/Stage-out documentation - required parameters for stage_out, automated cataloging, and the STAC requirements (e.g. must include the stac.json)
- Documentation should be linked from gitbook where applicable.
Work Tickets
Link to work tickets required to implement the epic
- TBC (to be created)
Dependencies
Other epics or outside tickets required for this to work
- TBC
Associated Risks
links to risk issues associated with this epic
- TBC
Sub-issues
Metadata
Metadata
Type
Projects
Status
Done