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

[DH-301] adding workflow diagram #6426

Merged

Conversation

shaneknapp
Copy link
Contributor

No description provided.

@github-actions github-actions bot added documentation Issues around adding and modifying docs images labels Oct 25, 2024
@ryanlovett
Copy link
Collaborator

@shaneknapp You may want to check out https://mermaid.js.org/syntax/flowchart.html. They can be integrated right into the doc so that if you want to make a change, you don't have go back to your drawing program, regenerate the SVG, etc. Here's an example of mermaid in a myst doc, https://jupyterhealth.org/software-documentation/security.

@ryanlovett
Copy link
Collaborator

Here are more in a jekyll README, https://github.com/berkeley-cdss/course-site-quarto.

@shaneknapp
Copy link
Contributor Author

Here are more in a jekyll README, https://github.com/berkeley-cdss/course-site-quarto.

this is awesome! i'll do this now! :)

@github-actions github-actions bot removed the images label Oct 25, 2024
@shaneknapp
Copy link
Contributor Author

that's kinda amazing, tstl...

image

i'm curious as to why that one box w/the user's fork is a different color than the rest tho...

@ryanlovett
Copy link
Collaborator

i'm curious as to why that one box w/the user's fork is a different color than the rest tho...

Good question! Sometimes I'll paste my mermaid diagram into the live editor at https://mermaid.live/ to see if it is a tooling issue, e.g. maybe the issue is due to quarto's mermaid integration.

@shaneknapp
Copy link
Contributor Author

i'm curious as to why that one box w/the user's fork is a different color than the rest tho...

Good question! Sometimes I'll paste my mermaid diagram into the live editor at https://mermaid.live/ to see if it is a tooling issue, e.g. maybe the issue is due to quarto's mermaid integration.

it renders perfectly there... i'll merge this and see what it looks like once it's live.

@shaneknapp shaneknapp merged commit a10420f into berkeley-dsep-infra:staging Oct 25, 2024
2 checks passed
@shaneknapp shaneknapp deleted the add-cicd-workflow-diagram branch October 25, 2024 23:38
@shaneknapp
Copy link
Contributor Author

i'm curious as to why that one box w/the user's fork is a different color than the rest tho...

Good question! Sometimes I'll paste my mermaid diagram into the live editor at https://mermaid.live/ to see if it is a tooling issue, e.g. maybe the issue is due to quarto's mermaid integration.

it renders perfectly there... i'll merge this and see what it looks like once it's live.

boo it's still colored weirdly.

@ryanlovett
Copy link
Collaborator

I was about to say the same!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues around adding and modifying docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants