search

GeoscienceAustralia / ga_sar_workflow

InSAR processing workflow used by Geoscience Australia
Apache License 2.0
3 stars 0 forks source link

Developer intro documentation for the project at a high level #354

Closed mwheeler closed 2 years ago

mwheeler commented 2 years ago

This PR adds a document for new developers that covers the rough module structure of the code base, important classes/concepts, what/where the processing modules are, etc.

Edit: I've also added a document for new developers that covers the structure of the Luigi DAG / workflow, important tasks, design details & quirks, etc.

This addresses part of #327 - along with some existing docs that have already made it upstream & an upcoming Luigi workflow developer document that will be in PR later this week.

mwheeler commented 2 years ago

To save on PR-overload, I've added the Luigi DAG doc to this PR as well (so there's now 2 developer onboarding documents in this PR, not just the first one) - seemed like a safe bet since no one had started the review yet & this doc is 'also' for onboarding and 'also' for the same GH issue.

mwheeler commented 2 years ago

Comments to date addressed in 8e38edf