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

[Diagram] Remove all named individuals #884

Merged
merged 5 commits into from
Sep 25, 2024

Conversation

bact
Copy link
Collaborator

@bact bact commented Sep 13, 2024

Per Tech Call 24 Sep 2024 - Remove all named individuals to "fix" IRI inconsistencies between the model and the diagram.

Removing:

  • Core/NoAssertionElement
  • Core/NoneElement
  • Licensing/NoAssertionLicense
  • Licensing/NoneLicense

@bact bact added documentation Improvements or additions to documentation Profile:Core Core Profile and related matters publishing Dependency for publishing final version of spec labels Sep 13, 2024
@bact bact added this to the 3.0.1 milestone Sep 13, 2024
@bact bact requested a review from sbarnum September 13, 2024 15:39
@bact
Copy link
Collaborator Author

bact commented Sep 13, 2024

@sbarnum Since this is about diagram, if you have few mins please take a look at the SpdxOrganization individual added.

It is in the "Individuals" box in two diagrams:

  • Core: the box is at the bottom-right corner
  • Core+Software: the box is near the top-right corner

Thank you for your help.

@sbarnum
Copy link
Collaborator

sbarnum commented Sep 20, 2024

I see two problems, none of which are directly caused by the diagram changes but rather by the changes to SPDXOrganization that led to the diagram changes.

  1. The currently defined IRI for SPDXOrganization is inconsistent with other IRIs for named individuals. As a named Individual, the IRI identifier for the SPDXOrganization should at least be "https://spdx.org/rdf/SPDXOrganization". It is currently missing the "rdf" portion which aligns to all of the other named Individuals. It is fine leaving out the release version portion of the IRI path as this individual spans versions but it should at least have the rdf portion. To be even more consistent it should actually probably be "https://spdx.org/rdf/Core/SPDXOrganization" given that it is defined as part of Core.
  2. In the SPDXOrganization.md file, under metadata it lists only the IRI prefix under "IRI". This metadata field should assert the full IRI (as specified above) for the named individual. This is something I have long suggested should be done for all named individuals.

These issues should be addressed then updated in the diagrams.

BTW, there is also a remaining typo in buildType.md. There is an occurence of "builtType" rather than "buildType"

@bact
Copy link
Collaborator Author

bact commented Sep 21, 2024

Thank you @sbarnum for the typos, please see PR #885

@goneall
Copy link
Member

goneall commented Sep 21, 2024

The currently defined IRI for SPDXOrganization is inconsistent with other IRIs for named individuals. As a named Individual, the IRI identifier for the SPDXOrganization should at least be "https://spdx.org/rdf/SPDXOrganization". It is currently missing the "rdf" portion which aligns to all of the other named Individuals. It is fine leaving out the release version portion of the IRI path as this individual spans versions but it should at least have the rdf portion. To be even more consistent it should actually probably be "https://spdx.org/rdf/Core/SPDXOrganization" given that it is defined as part of Core.

@sbarnum see different but related discussion at #880 (comment)

@zvr - thoughts? I'm OK with either URI

@bact
Copy link
Collaborator Author

bact commented Sep 21, 2024

fyi, these are named individuals we currently have, together with their IRIs:

  1. SpdxOrganization - Markdown
  2. NoAssertionElement - Markdown
  3. NoneElement - Markdown
  4. NoAssertionLicense - Markdown
  5. NoneLicense - Markdown

(#883 is proposed to fix inconsistencies in (2) and (3))

@zvr
Copy link
Member

zvr commented Sep 22, 2024

Thinking more about it, I am not even sure the Individuals should appear on the diagram...

I mean, we will also publish hundreds more Individuals -- the licenses and exceptions of the License List. Why show some and not all?

@goneall
Copy link
Member

goneall commented Sep 24, 2024

  1. The currently defined IRI for SPDXOrganization is inconsistent with other IRIs for named individuals. As a named Individual, the IRI identifier for the SPDXOrganization should at least be "https://spdx.org/rdf/SPDXOrganization". It is currently missing the "rdf" portion which aligns to all of the other named Individuals. It is fine leaving out the release version portion of the IRI path as this individual spans versions but it should at least have the rdf portion. To be even more consistent it should actually probably be "https://spdx.org/rdf/Core/SPDXOrganization" given that it is defined as part of Core.

In the 3.0.1 shacl TTL file, it looks like we have the standard URI ns2:SpdxOrganization as well as the sameAs owl:sameAs <https://spdx.org/> so this doesn't look like an issue in the model

@goneall
Copy link
Member

goneall commented Sep 24, 2024

based on the tech call on 24 Sept 2024: We'll remove the individuals from the diagram - SpdxOrganization, NoneElement, NoAssertionElement, NoneLicense, NoAssertionLicense. Resolves the inconsistencies' and allows us to move the decision on the URI's to 3.1.

@goneall
Copy link
Member

goneall commented Sep 24, 2024

@bact will update the diagram based on the above decision

@bact bact changed the title Update diagram with new SpdxOrganization individual [Diagram] Remove all named individuals Sep 24, 2024
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Copy link
Collaborator Author

bact commented Sep 24, 2024

All named individuals are now removed from the diagrams in this PR and also in spdx/spdx-spec#1120

@goneall
Copy link
Member

goneall commented Sep 24, 2024

Thanks @bact

Copy link
Member

@goneall goneall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@goneall
Copy link
Member

goneall commented Sep 24, 2024

@sbarnum @zvr - Please review and if it looks good, let's merge - we want to freeze the changes for the ISO submittal. It would be nice to have the diagram consistent with the model.

Copy link

@bobmartin3000 bobmartin3000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@zvr zvr merged commit cad7284 into spdx:main Sep 25, 2024
1 check passed
@bact bact deleted the update-diagram-spdxorganization branch September 25, 2024 08:21
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 Profile:Core Core Profile and related matters publishing Dependency for publishing final version of spec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants