Skip to content

[DOCS] Document your CycloneDX properties #1255

@jkowalleck

Description

@jkowalleck

Problem Statement

I see that tern uses CycloneDX properties. like here

"properties": [
{
"name": "tern:repotag",
"value": "photon:3.0"
},
{
"name": "tern:os_guess",
"value": "VMware Photon OS/Linux"
}
],

I would love to see a documentation of the CycloneDX property taxonomy used by tern.
Maybe I just missed it? At least it was not linked in the official registry https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/ed8a972a5e1c925bba05f8865c1ad3219b872c98/README.md?plain=1#L117

Describe the Proposal

Have the CycloneDX properties documented:

  • property name
  • scope - where the property should be used
  • value space - what the value mean

something similar to https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx.md

Steps to Implement Proposal

I guess, the documentation could be done in a regularly updated file in this repo, or even in this repo's wiki.

After publishing your taxonomy, please link them in the CycloneDX Property taxonomy registry.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions