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

Bring back RelationshipType (relationship name, from, to) to the model diagram #940

Open
bact opened this issue Dec 10, 2024 · 2 comments
Open
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@bact
Copy link
Collaborator

bact commented Dec 10, 2024

Background

PR #935 improves diagrams by simplifying them to make their layout friendly for printed version (PDF, for example).
One of the strategies to simplifying the diagrams is to remove vocabulary entries.

Issue

While other vocabulary entries may seems redundant to be included in the model diagram, as one can directly look at the spec of each vocab easily (all entry names are at the beginning of each line), the RelationshipType is different as they involve with more information than just entry names and not all of them are in tabular-like format.

3 important information in RelationshipType are: 1) relationship name, 2) "from" Element, and 3) "to" Element.

While one can carefully read each line in https://spdx.github.io/spdx-spec/v3.0.1/model/Core/Vocabularies/RelationshipType/ for those information, the previously available diagram (shown below) clearly provides a quicker overview when one wants to check the "from" and "to", as they are in a tabular-like format. The table also group relationship types into sections with headings that based on their textual entry description, to assist the reader.

RelationshipType

Proposal

  • Bring back only the RelationType vocab, showing entry name, "from" Element, "to" Element in a tabular-like format (improve upon the previously available one)
  • Adjust its layout to accommodate printed format
@bact bact added the documentation Improvements or additions to documentation label Dec 10, 2024
@goneall goneall added this to the 3.1 milestone Dec 10, 2024
@goneall
Copy link
Member

goneall commented Dec 10, 2024

Changing to 3.1 milestone - @bact - let me know if you disagree

@bact
Copy link
Collaborator Author

bact commented Dec 10, 2024

No prob at all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants