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

Charts #54

Merged
merged 11 commits into from May 9, 2019

Conversation

Projects
None yet
4 participants
@Swaagie
Copy link
Member

commented May 8, 2019

Summary

Provide maintainable and scalable diagrams that can be easily used in docs.

Changelog

Include canihaz to optionally install puppeteer.
Provide script (bin/diagrams) to render mermaid diagrams and store snapshots to file
Provide npm command to execute above script
Reference diagrams in documentation.

Test Plan

Not applicable as it is dev-tooling only.

@indexzero
Copy link
Member

left a comment

TravisCI is only failing for node@8

👍 overall on the diagrams. Perhaps it would be useful to include them in the README.md?

@Swaagie

This comment has been minimized.

Copy link
Member Author

commented May 8, 2019

For sure, have some WIP locally, due to puppeteer timings I can't get it to render the first diagram properly.. Should be able to resolve today

Show resolved Hide resolved assets/diagrams/assets.mmd Outdated
Show resolved Hide resolved assets/diagrams/promote.mmd Outdated
Show resolved Hide resolved bin/diagrams Outdated
Show resolved Hide resolved bin/diagrams
Show resolved Hide resolved assets/diagrams/promote.mmd Outdated

Swaagie added some commits May 8, 2019

Show resolved Hide resolved README.md Outdated
@burgessa23
Copy link

left a comment

on addition of alt tags

comments addressed

@Swaagie Swaagie merged commit 5823169 into master May 9, 2019

1 of 3 checks passed

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
continuous-integration/travis-ci/push The Travis CI build is in progress
Details
security/snyk - package.json (godaddy) No new issues
Details

@Swaagie Swaagie deleted the charts branch May 9, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.