-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- 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
- Loading branch information
1 parent
5894911
commit 0e30190
Showing
5 changed files
with
41 additions
and
36 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,14 @@ | ||
# Harvesting Pipeline Structure | ||
|
||
To generate diagrams, run the mermaid-cli: | ||
```bash | ||
docker run --rm -u `id -u`:`id -g` -v ./:/data minlag/mermaid-cli -i new_harvesting.mmd -o new_harvesting.svg [-t dark -b transparent] | ||
``` | ||
|
||
## Old Harvesting Logic | ||
Unique to each file + schema format | ||
```mermaid | ||
flowchart LR | ||
sc([SOURCE CREATION]) | ||
gs([GATHER STAGE]) | ||
fs([FETCH STAGE]) | ||
is([IMPORT STAGE]) | ||
sc --> gs | ||
gs --> fs | ||
fs --> is | ||
``` | ||
![diagram](./old_harvesting.svg) | ||
|
||
## New Harvesting Logic | ||
Universal to all file + schema formats | ||
```mermaid | ||
flowchart TD | ||
sc([SOURCE CREATION]) | ||
extract([Extract Catalog Source]) | ||
compare([Compare Source Catalog to Data.gov Catalog]) | ||
nochanges{No Changes?} | ||
deletions{Datasets to Delete?} | ||
updates{Datasets to Add or Update?} | ||
load([Load into Data.gov Catalog]) | ||
validate([Validate Dataset]) | ||
transform([Transform Schema of Dataset]) | ||
completed([End]) | ||
sc --> extract | ||
extract --> compare | ||
compare --> deletions | ||
compare --> updates | ||
deletions --> load | ||
updates --> validate | ||
validate --> transform | ||
transform --> validate | ||
validate --> load | ||
load --> completed | ||
compare --> nochanges | ||
nochanges --> completed | ||
``` | ||
![diagram](./new_harvesting.svg) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
flowchart TD | ||
sc([SOURCE CREATION]) | ||
extract([Extract Catalog Source]) | ||
compare([Compare Source Catalog to Data.gov Catalog]) | ||
nochanges{No Changes?} | ||
deletions{Datasets to Delete?} | ||
updates{Datasets to Add or Update?} | ||
load([Load into Data.gov Catalog]) | ||
validate([Validate Dataset]) | ||
transform([Transform Schema of Dataset]) | ||
completed([End]) | ||
|
||
sc --> extract | ||
extract --> compare | ||
compare --> deletions | ||
compare --> updates | ||
deletions --> load | ||
updates --> validate | ||
validate --> transform | ||
transform --> validate | ||
validate --> load | ||
load --> completed | ||
compare --> nochanges | ||
nochanges --> completed |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
flowchart LR | ||
sc([SOURCE CREATION]) | ||
gs([GATHER STAGE]) | ||
fs([FETCH STAGE]) | ||
is([IMPORT STAGE]) | ||
sc --> gs | ||
gs --> fs | ||
fs --> is |
Oops, something went wrong.
0e30190
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Coverage Report