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

Update References chapter #1006

Merged
merged 11 commits into from
Aug 9, 2024
Merged

Conversation

bact
Copy link
Collaborator

@bact bact commented Jul 25, 2024

Notes

  • https://spdx.org/rdf/ontology/spdx-3-0-1 does not exist
  • List formatting consistency
    • Normative References uses regular paragraphs, one reference per one paragraph - no numbered
    • Non-normative References uses numbered list
      • Because these numbers will be used in "Annex F: History, Motivation and Rational" (in the text as [6], [2, 3], etc)
  • Numbering 10, 11, 12 in this PR and in the Word doc is not sync. As in the original Word doc 10. is missing/skipped.
    • Need to resync the numbers with the final Annex F.
  • For IETF RFC links, wait for a decision from What is a standard URL to reference IETF RFC? #1012

@bact
Copy link
Collaborator Author

bact commented Jul 25, 2024

Missing References

These are referred to in model descriptions but not yet documented in the References section.

In AI Profile:

In Build Profile:

In Core Profile:

In Dataset Profile:

In ExpandedLicensing Profile:

In Security Profile:

In Software Profile:

@bact
Copy link
Collaborator Author

bact commented Jul 25, 2024

Should we specify the version for "Common Platform Enumeration (CPE) – Specification" ?

  • There's no version specified for "Common Platform Enumeration (CPE) – Specification" in the Normative References section.
  • At the top of our Normative References section, we said
    "For undated references, the latest edition of the referenced document (including any amendments) applies."
  • Next to it, we we also have a ref to "NIST IR 7695 Common Platform Enumeration: Naming Specification Version 2.3" which is part of CPE 2.3 stacks.
  • In our current v3 model, there are at least two citations to CPE, in ExternalIdentifierType:

Should we change the line:
"Common Platform Enumeration (CPE) – Specification, The MITRE Corporation"
to:
"Common Platform Enumeration (CPE) – Specification 2.2, The MITRE Corporation" ?

--

spdx/spdx-3-model#806 will clarify this on the model side.

@bact bact mentioned this pull request Jul 25, 2024
69 tasks
bact added 3 commits July 26, 2024 23:07
Add Non-normative References section

Using text from Bob's Word doc 2024-07-22 and existing reference formatting from normative-reference.md

Signed-off-by: Arthit Suriyawongkul <[email protected]>
Use https://www.rfc-editor.org/info/rfcXXX for IETF RFC links

Signed-off-by: Arthit Suriyawongkul <[email protected]>
Singed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact force-pushed the update-chap-reference branch from f7d48ed to c9af2c6 Compare July 26, 2024 22:12
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

@goneall goneall added this to the 3.0.1 milestone Aug 9, 2024
Copy link
Contributor

@kestewart kestewart left a comment

Choose a reason for hiding this comment

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

Looks good.

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 goneall merged commit 0dbf279 into spdx:development/v3.0.1 Aug 9, 2024
3 checks passed
@bact bact deleted the update-chap-reference branch August 9, 2024 18:40
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.

4 participants