Add SPDX Java library family diagram#359
Conversation
Add a diagram showing a family of SPDX Java libraries and their relationships to help implementers quickly get the overview. The diagram is rendered from a PlantUML file. Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
|
Alternatively, we can remove the spec Turtle file, to make the diagram simpler: 
|
|
A diagram like this will be exceptionally useful to newcomers! Great idea! |
goneall
left a comment
goneall
left a comment
There was a problem hiding this comment.
This looks great as is - I just have one suggested improvement.
The SPDX Java Library includes a simple in memory storage implementation.
It may be good to note this - it is storage.simple package inside the library.
If you think it would be confusing to note this detail, we can go with the PR as is.
|
Thank you. I will find a way to include the in-memory storage. |
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
|
@pmonks @goneall the updated diagram, with the in-memory store 
Another thing, currently the diagram uses "implements" label for a relationship from store to the store interface. SPDX 3 does not have "implements" relationship type, but has "has specification"; should we use that in the diagram or "implements" is fine here? |
I think Implements is find for the diagram |
3 participants
Add a diagram showing a family of SPDX Java libraries and their relationships to help implementers quickly get the overview.
The diagram is rendered from a PlantUML file.
It will look like this: