Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initialize data catalog overview docs with data flow diagram #102

Conversation

jeancochrane
Copy link
Contributor

@jeancochrane jeancochrane commented Aug 28, 2023

This PR initializes the overview section of our dbt docs with a new data flow diagram for our department's data.

You can check out the diagram on the live docs site:

Screenshot 2023-08-29 101309

Closes ccao-data/wiki#2. Connects #67.

@jeancochrane jeancochrane linked an issue Aug 28, 2023 that may be closed by this pull request
@jeancochrane jeancochrane force-pushed the jeancochrane/2-add-overall-architecture-diagram-for-the-data-dept branch from 45f09df to 5c8c22b Compare August 28, 2023 21:19
@jeancochrane jeancochrane force-pushed the jeancochrane/2-add-overall-architecture-diagram-for-the-data-dept branch from 1f11baf to f770f49 Compare August 29, 2023 15:01
@jeancochrane jeancochrane temporarily deployed to github-pages August 29, 2023 15:05 — with GitHub Actions Inactive
@jeancochrane jeancochrane temporarily deployed to github-pages August 29, 2023 15:08 — with GitHub Actions Inactive
.github/workflows/deploy_dbt_docs.yaml Show resolved Hide resolved
.gitignore Show resolved Hide resolved
dbt/README.md Outdated Show resolved Hide resolved
dbt/models/overview.md Show resolved Hide resolved
@jeancochrane jeancochrane marked this pull request as ready for review August 29, 2023 16:48
@jeancochrane jeancochrane requested a review from a team as a code owner August 29, 2023 16:48
dbt/README.md Outdated Show resolved Hide resolved
- name: Prepare Mermaid assets for docs
run: |
for file in assets/*.mmd; do
mmdc -i "$file" -o "${file/.mmd/.png}"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick (blocking): Can we swap the output file to SVG for better dark mode compatibility?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call, done in 9caa3ea! The SVG is live on the production site if you want to spot check it.

dbt/models/overview.md Outdated Show resolved Hide resolved
dbt/models/overview.md Outdated Show resolved Hide resolved
@jeancochrane jeancochrane temporarily deployed to github-pages August 29, 2023 19:09 — with GitHub Actions Inactive
@jeancochrane jeancochrane force-pushed the jeancochrane/2-add-overall-architecture-diagram-for-the-data-dept branch from ec41767 to 46c91f7 Compare August 29, 2023 19:20
@jeancochrane jeancochrane temporarily deployed to github-pages August 29, 2023 19:20 — with GitHub Actions Inactive
@jeancochrane
Copy link
Contributor Author

Should be ready for one more look @dfsnow!

Copy link
Member

@dfsnow dfsnow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great @jeancochrane! Nice addition to the docs.

@jeancochrane jeancochrane merged commit 4540f35 into master Aug 30, 2023
3 checks passed
@jeancochrane jeancochrane deleted the jeancochrane/2-add-overall-architecture-diagram-for-the-data-dept branch August 30, 2023 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add overall architecture diagram for the Data Dept.
2 participants