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.

Sign up for GitHub

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

Jump to bottom

Add inter-collection diagram generated by refscan to schema documentation #2240

Closed
3 tasks done
eecavanna opened this issue Nov 1, 2024 · 3 comments · Fixed by #2241
Closed
3 tasks done

Add inter-collection diagram generated by refscan to schema documentation #2240

eecavanna opened this issue Nov 1, 2024 · 3 comments · Fixed by #2241
Assignees
@eecavanna
Labels
diagrams documentation Improvements or additions to documentation gen-doc GH actions X SMALL Less than 8 hours, less than 1 day

Comments

@eecavanna
Copy link
Collaborator

eecavanna commented Nov 1, 2024 •
edited
Loading

This is a more narrowly-focused spin-off from #2188.

  • Add an inter-collection diagram (dynamically generated based upon the current schema files)
  • Add an explanatory web page that links to the diagram
  • Add a sidebar link that points to that web page
@eecavanna eecavanna self-assigned this Nov 1, 2024
@eecavanna eecavanna linked a pull request Nov 1, 2024 that will close this issue
Include inter-collection relationship graph in schema documentation #2241
Merged
@eecavanna eecavanna moved this from In Progress to In Review in 2024 - Sprint 48 - October 21 - November 1, 2024 Nov 1, 2024
@eecavanna
Copy link
Collaborator Author

This has been implemented in PR #2241.

This was referenced Nov 1, 2024
Closed
Open
@eecavanna eecavanna added documentation Improvements or additions to documentation X SMALL Less than 8 hours, less than 1 day diagrams GH actions gen-doc labels Nov 1, 2024
@ssarrafan
Copy link
Collaborator

@eecavanna is this done? Is the final at https://microbiomedata.github.io/nmdc-schema/visualizations/collection-graph.html?

@eecavanna
Copy link
Collaborator Author

eecavanna commented Dec 18, 2024 •
edited
Loading

Yes, this is done. Yes, that is the long-term URL of the graph (that graph gets regenerated whenever the documentation site gets regenerated, but it is always at that URL).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@eecavanna eecavanna

Labels
diagrams documentation Improvements or additions to documentation gen-doc GH actions X SMALL Less than 8 hours, less than 1 day
Projects
Documentation Squad Board
Status: Done
2024 - Sprint 48 - October 21 - November 1, 2024
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Include inter-collection relationship graph in schema documentation microbiomedata/nmdc-schema
2 participants
@ssarrafan @eecavanna