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

Include inter-class relationship graph in schema documentation #2243

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

eecavanna
Copy link
Collaborator

@eecavanna eecavanna commented Nov 1, 2024

This PR is a "sequel" to #2241.

In this PR branch, I did two things:

  1. I updated make gendoc to generate an inter-class diagram, storing it in the schema documentation website's file tree
  2. I updated the explanatory "Visualizations" web page to include a blurb about this inter-class diagram and to link to it

🕐 I do not expect this PR branch to be merged into main until issue #2238 has been resolved. I am ready for that merge to happen as soon as that issue has been resolved, though. In other words, I consider this branch to be "done."

@eecavanna eecavanna self-assigned this Nov 1, 2024
@eecavanna eecavanna linked an issue Nov 1, 2024 that may be closed by this pull request
2 tasks
Copy link

github-actions bot commented Nov 1, 2024

PR Preview Action v1.4.8
🚀 Deployed preview to https://microbiomedata.github.io/nmdc-schema/pr-preview/pr-2243/
on branch gh-pages at 2024-11-11 19:19 UTC

@eecavanna eecavanna marked this pull request as ready for review November 1, 2024 20:26
@eecavanna eecavanna changed the title Generate inter-class relationship diagram and add it to docs site Include inter-class relationship graph in schema documentation Nov 1, 2024
@eecavanna
Copy link
Collaborator Author

Closing because the upstream nmdc-schema repo already has an equivalent PR.

@eecavanna eecavanna closed this Nov 11, 2024
@eecavanna eecavanna deleted the 2242-add-inter-class-diagram-generated-by-refscan-to-schema-documentation branch November 11, 2024 19:14
@eecavanna eecavanna restored the 2242-add-inter-class-diagram-generated-by-refscan-to-schema-documentation branch November 11, 2024 19:16
@eecavanna
Copy link
Collaborator Author

Oops! This is the "upstream nmdc-schema repo." Re-opening after realizing that.

@eecavanna eecavanna reopened this Nov 11, 2024
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 inter-class diagram generated by refscan to schema documentation
1 participant