NZODN Workflow Documentation

[woodRock]

Goal

Create a basic documentation for the NZODN workflow.

Tasklist

• [x] PlantUML diagram
• [x] Textual explanation for each component
• [x] Wiki

Success Criteria

Created a basic documentation for the NZODN data ingestion process for new users to follow.

[woodRock]

@startuml
folder Biozip <<zip>>

database Postgres <<PSQL>> {
    rectangle bio <<Schema>> {
        rectangle biological_map <<Table>>
    }
}
rectangle GeoServer <<WMS>> {
    rectangle bio_map <<Layer>> {
        rectangle biological_data <<Store>>
    }
}

rectangle GeoNetwork <<Catalogue>> {
    rectangle Benthic <<Metadata>>
}

rectangle NZODN

Biozip <-- biological_map : references filepath
biological_map <- biological_data : query
biological_data <- Benthic : WFS
biological_data <- Benthic : WMS
Benthic <- NZODN : shows

@enduml

[woodRock]

@startuml

rectangle SourceData <<Mooring>>
database Local <<Field>>
database Central <<Niwa>>
database NZODN <<Welimos>>

SourceData -> Local : ingested
Local -> Central : automated
Central -> NZODN : CRON job

@enduml

[woodRock]

This process has been documented in further detail on the wiki. I intend to use that space for documentation in the future, rather than GitHub Issues, as the Wiki is more purpose built for creating discoverable and easily traveresable documentation for an existing project.