generated from linkml/linkml-template
-
Notifications
You must be signed in to change notification settings - Fork 8
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 and inter-collection relationship graphs in schema documentation #2198
Closed
eecavanna
wants to merge
20
commits into
microbiomedata:main
from
microbiomedata:2188-berkeley-incorporate-refscan-graphs-into-schema-documentation
+116
−13
Closed
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
3d4820b
WIP: Generate `refgraph` visualizations via GHA workflow
eecavanna 9852362
Constrain Python version and regenerate `poetry.lock` file
eecavanna 5ecdcd5
WIP: Inject `refgraph` pages into documentation preview site
eecavanna ea3794b
Install `refscan` via `pipx` instead of via `poetry`
eecavanna 27754b1
Regenerate `poetry.lock` file (by running `$ poetry lock --no-update`)
eecavanna 9c22098
Use correct directory name
eecavanna aa4843c
Remove comment to simplify PR diff
eecavanna 80d509d
Remove unnecessary commands from GHA workflow
eecavanna d8ed9b3
Use `pipx run` to avoid installing anything
eecavanna 4e753b9
Revert unnecessary changes to `poetry.lock` file
eecavanna 9b750e1
WIP: Update site navigation bar so it contains links to graphs
eecavanna 8915b2b
Restrict which `refscan` version will be used
eecavanna 53a7875
Remove comment unrelated to other changes on branch
eecavanna 168a3cc
Standardize comments between doc-related GHA workflows
eecavanna 4da13d4
WIP: Populate project version number before generating derivative files
eecavanna 472270e
Install `refscan` and update `gendoc` Makefile target to run `refgraph`
eecavanna 8acd4c3
Remove `refgraph` step from GHA workflows (is handled by `make gendoc`)
eecavanna 904ff38
Clarify comment
eecavanna 9911c4c
Update sidebar link text to be more descriptive
eecavanna e5943a9
Introduce "Visualizations" page as an intermediate destination
eecavanna File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev
Previous commit
Introduce "Visualizations" page as an intermediate destination
commit e5943a9c065b50d451eac15882b6b2e1148cde87
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Visualizations | ||
|
||
## Inter-collection relationship diagram | ||
|
||
<!-- Note: `visualizations/collection-graph.html` does not exist in the source code repository. | ||
It gets generated as part of the documentation build process. --> | ||
This [**inter-collection relationship diagram**](visualizations/collection-graph.html) | ||
shows the database **collections** described by the schema, and the **relationships** between those collections. | ||
|
||
Each circle represents a collection. | ||
Each arrow represents all of the fields that documents in one collection—the one at that arrow's tail—can | ||
use to refer to documents in another collection—the one at that arrow's head. | ||
If you click on a circle, the names of the fields will appear on the arrows connected to that circle. | ||
|
||
## Inter-class relationship diagram | ||
|
||
<!-- Note: `visualizations/class-graph.html` does not exist in the source code repository. | ||
It gets generated as part of the documentation build process. --> | ||
This [**inter-class relationship diagram**](visualizations/class-graph.html) | ||
shows the **classes** defined within the schema, and the **relationships** between those classes. | ||
|
||
Each circle represents a class. | ||
Each arrow represents all of the slots that instances of that class—the one at that arrow's tail—can | ||
use to refer to instances of another class—the one at that arrow's head. | ||
If you click on a circle, the names of the slots will appear on the arrows connected to that circle. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My two cents here is it will be confusing and not very useful to distribute the inter-class relationship diagram until we make the ranges as strict as the structured syntax patterns.