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

Docs/submission diagram update #88

Merged
merged 6 commits into from
Dec 7, 2023
Merged

Conversation

blankdots
Copy link
Contributor

@blankdots blankdots commented Dec 5, 2023

Describe the pull request:

  • Code cleanup
  • Build system change
  • Documentation change

Changes made:

  • make use of mermaid diagrams to update database schema, submission workflow, GA4GH visas workflow
  • introduce mermaid diagram rendering
  • remove some outdated css and outdated sequence submission workflow diagram
  • update data out to be data retrieval (to have a consistent language)

Related issues:

Additional information:

  • Diagrams are not that visible on a small screen, and i tried looking for zooming options, but failed short there

Release note:

Documentation change:

Mentions:

@aaperis apologies about taking the task related to db, but i found this: https://github.com/KarnerTh/mermerd that helped me generate the diagram. Still feel free to make changes

@blankdots blankdots self-assigned this Dec 5, 2023
@blankdots blankdots force-pushed the docs/submission-diagram-update branch from fe9d7b9 to d43c07b Compare December 5, 2023 17:44
@blankdots blankdots force-pushed the docs/submission-diagram-update branch from 29139bb to 92cd3c9 Compare December 5, 2023 18:20
@blankdots blankdots force-pushed the docs/submission-diagram-update branch from 7b366a3 to b297568 Compare December 5, 2023 18:40
@blankdots blankdots requested a review from a team December 5, 2023 18:40
@blankdots blankdots marked this pull request as ready for review December 5, 2023 18:43
Copy link
Contributor

@kjellp kjellp left a comment

Choose a reason for hiding this comment

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

Nice improvements! The database and submission pipeline mermaid diagrams were quite tiny, and since they are not pictures, they cant easily be mangnified in a separate viewer. Firefox zoom (ctrl-+) only enlarge the text of the page and not really the diagram text (or the effect is not really that noticable).

Copy link
Contributor

@aaperis aaperis left a comment

Choose a reason for hiding this comment

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

Nice! The only problem is as @kjellp mentioned that the diagram details can be very hard to read.

@blankdots
Copy link
Contributor Author

we could split the diagrams or try to find a way to zoom into them

I know at least on github there is a way to zoom
image

for now merging,

@blankdots blankdots merged commit 4afa835 into master Dec 7, 2023
3 checks passed
@blankdots blankdots deleted the docs/submission-diagram-update branch December 7, 2023 06:20
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.

4 participants