Harvesting pipeline documentation #17
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Old vs new general pipeline structure
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- Track mermaid code in separate files (*.mmd) - Generate diagrams using mermaid cli courtesy of docker image: https://github.com/mermaid-js/mermaid-cli#use-dockerpodman
- Bold arrows ==> logic control - Normal arrows --> data access - Dashed arrows -.> error/skip conditions - Added a few connections that were previously missing (minor update)
There are a lot of moving pieces... this diagram does not have the most fine-tuned specificity... - I have confidence that >90% of the important steps are accounted for, there should be two types of checks and balances for these diagrams: (1) review from a fresh perspective from various team members to see if there are any glaring issues at a high level, (2) in-depth review during pipeline consolidation and cross-checking with the code when the time comes.
- All xml files are geospatial - fetch is empty, same as datajson - lots of repeated code... - seems pretty straightforward
The code is a mess, so make two instances of things if there are two instances in code. Make the diagram easier to read.. but takes more time to notice things are duplicated. The code should duplication well though. Hindsight.... the dcat structure is messy because things are done in set operations in code, not necessarily code iterations... so ... the logic is harder to ascertain. This should probably be refactored to follow the xml diagram.. but the current design stays truer to the code, so I'm torn **shrug**
This abstracts the different sections better
To highlight connection to import
unify import stage for single xml and waf
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Notes:
npm run makeDocNPM script to generate new SVGs.This is not an exhaustive list of all the new docs for Harvester 2.0, but currently this is good to go as is, and can be added to in future.
References: