Skip to content

Commit

Permalink
Update mkdocs.yml
Browse files Browse the repository at this point in the history
Update mkdocs.yml and fix some of the ordering/formatting in the
annexes. The updates to mkdocs.yml reflect the most current state of the
model.

Addresses #902

Signed-off-by: Rose Judge <rose.judge@broadcom.com>
  • Loading branch information
rnjudge authored and goneall committed Apr 14, 2024
1 parent 5787559 commit 3b3521d
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/annexes/RDF-object-model-and-identifier-syntax.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Annex C RDF object model and identifier syntax (Normative)
# Annex C: RDF object model and identifier syntax (Normative)

TODO: update for SPDXv3

Expand Down
10 changes: 5 additions & 5 deletions docs/annexes/SPDX-Lite.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Annex G SPDX Lite
# Annex H: SPDX Lite

## G.1 Definition of the Lite profile <a name="G.1"></a>
## H.1 Definition of the Lite profile <a name="H.1"></a>

The Lite profile is designed to make it quick and easy to start a Software Bill of Materials in situations where a company may have limited capacity for introducing new items into its process.
The Lite profile captures the minimum set of information required for license compliance in the software supply chain. It contains information about the creation of the SBOM, package lists with licensing and other related items, and their relationships.

All elements in Lite profile are essential for complying with licenses. It is easy to use a SPDX document with the Lite profile for anyone who does not have enough knowledge about licensing information and easy to import license information from former versions of SPDX Lite format files.
The Lite profile offers the flexibility to be used either alone or in combination with other SPDX profiles as a SPDX document in the software supply chain.

## G.2 Table of the Lite profile elements <a name="G.2"></a>
## H.2 Table of the Lite profile elements <a name="H.2"></a>

A SPDX document with the Lite profile must include properties for each class listed in **Table G.1**. And ```Cardinality 1..1``` means a **REQUIRED** element, and the others **SHOULD** be filled in as much as possible if necessary.
A SPDX document with the Lite profile must include properties for each class listed in **Table H.1**. And ```Cardinality 1..1``` means a **REQUIRED** element, and the others **SHOULD** be filled in as much as possible if necessary.

**Table G.1 — the Lite profile elements**
**Table H.1 — the Lite profile elements**

1. For a /Core/SpdxDocument to be conformant with this profile, the following has to hold:

Expand Down
2 changes: 1 addition & 1 deletion docs/annexes/SPDX-license-expressions.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Annex D SPDX license expressions (Normative)
# Annex D: SPDX license expressions (Normative)

## D.1 Overview <a name="D.1"></a>

Expand Down
2 changes: 1 addition & 1 deletion docs/annexes/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Annex F Getting started writing SPDX 3 (Informative)
# Annex J: Getting started writing SPDX 3 (Informative)
## (a.k.a My First SPDX File)

This guide is designed to walk you through the concepts behind an SPDX
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Annex E Using SPDX license list short identifiers in source files (Informative)
# Annex E: Using SPDX license list short identifiers in source files (Informative)

TODO: update for SPDXv3

Expand Down
35 changes: 31 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,13 @@ nav:
- model/Core/Datatypes/DateTime.md
- model/Core/Datatypes/MediaType.md
- model/Core/Datatypes/SemVer.md
- Individuals:
- model/Core/Individuals/NoAssertionElement.md
- model/Core/Individuals/NoneElement.md
- Software:
- 'Description': model/Software/Software.md
- Classes:
- model/Software/Classes/ContentIdentifier.md
- model/Software/Classes/File.md
- model/Software/Classes/Package.md
- model/Software/Classes/Sbom.md
Expand All @@ -132,10 +136,13 @@ nav:
- model/Software/Properties/additionalPurpose.md
- model/Software/Properties/attributionText.md
- model/Software/Properties/byteRange.md
- model/Software/Properties/contentIdentifier.md
- model/Software/Properties/contentIdentifierType.md
- model/Software/Properties/contentIdentifierValue.md
- model/Software/Properties/contentType.md
- model/Software/Properties/copyrightText.md
- model/Software/Properties/downloadLocation.md
- model/Software/Properties/gitoid.md
- model/Software/Properties/fileKind.md
- model/Software/Properties/homePage.md
- model/Software/Properties/isDirectory.md
- model/Software/Properties/lineRange.md
Expand All @@ -146,6 +153,8 @@ nav:
- model/Software/Properties/snippetFromFile.md
- model/Software/Properties/sourceInfo.md
- Vocabularies:
- model/Software/Vocabularies/ContentIdentifierType.md
- model/Software/Vocabularies/FileKindType.md
- model/Software/Vocabularies/SbomType.md
- model/Software/Vocabularies/SoftwarePurpose.md
- Security:
Expand Down Expand Up @@ -243,6 +252,7 @@ nav:
- 'Description': model/Dataset/Dataset.md
- Classes:
- model/Dataset/Classes/Dataset.md
- model/Dataset/Classes/DatasetPackage.md
- Properties:
- model/Dataset/Properties/anonymizationMethodUsed.md
- model/Dataset/Properties/confidentialityLevel.md
Expand All @@ -253,6 +263,7 @@ nav:
- model/Dataset/Properties/datasetSize.md
- model/Dataset/Properties/datasetType.md
- model/Dataset/Properties/datasetUpdateMechanism.md
- model/Dataset/Properties/hasSensitivePersonalInformation.md
- model/Dataset/Properties/intendedUse.md
- model/Dataset/Properties/knownBias.md
- model/Dataset/Properties/sensitivePersonalInformation.md
Expand All @@ -265,11 +276,17 @@ nav:
- 'Description': model/AI/AI.md
- Classes:
- model/AI/Classes/AIPackage.md
- model/AI/Classes/EnergyConsumption.md
- model/AI/Classes/EnergyConsumptionDescription.md
- Properties:
- model/AI/Properties/autonomyType.md
- model/AI/Properties/domain.md
- model/AI/Properties/energyConsumption.md
- model/AI/Properties/energyQuantity.md
- model/AI/Properties/energyUnit.md
- model/AI/Properties/finetuningEnergyConsumption.md
- model/AI/Properties/hyperparameter.md
- model/AI/Properties/inferenceEnergyConsumption.md
- model/AI/Properties/informationAboutApplication.md
- model/AI/Properties/informationAboutTraining.md
- model/AI/Properties/limitation.md
Expand All @@ -280,8 +297,11 @@ nav:
- model/AI/Properties/safetyRiskAssessment.md
- model/AI/Properties/sensitivePersonalInformation.md
- model/AI/Properties/standardCompliance.md
- model/AI/Properties/trainingEnergyConsumption.md
- model/AI/Properties/typeOfModel.md
- model/AI/Properties/useSensitivePersonalInformation.md
- Vocabularies:
- model/AI/Vocabularies/EnergyUnitType.md
- model/AI/Vocabularies/SafetyRiskAssessmentType.md
- Build:
- 'Description': model/Build/Build.md
Expand All @@ -302,15 +322,22 @@ nav:
- Extension:
- 'Description': model/Extension/Extension.md
- Classes:
- model/Extension/Classes/CdxPropertiesExtension.md
- model/Extension/Classes/CdxPropertyEntry.md
- model/Extension/Classes/Extension.md
- Properties:
- model/Extension/Properties/cdxPropName.md
- model/Extension/Properties/cdxPropValue.md
- model/Extension/Properties/cdxProperty.md
- annexes:
- 'Diffs from Previous Editions': annexes/diffs-from-previous-editions.md
- 'Including Security Information in SPDX': annexes/including-security-information-in-SPDX.md
- 'RDF Object Model and Identifier Syntax': annexes/RDF-object-model-and-identifier-syntax.md
- 'SPDX License Expressions': annexes/SPDX-license-expressions.md
- 'Using SPDX short identifiers in Source Files': annexes/using-SPDX-short-identifiers-in-source-files.md
- 'Getting started with SPDX 3': annexes/getting-started.md
- 'Using SPDX to comply with norms, standards and regulation': annexes/using-SPDX-to-comply-with-industry-guidance.md
- 'Including Security Information in SPDX': annexes/including-security-information-in-SPDX.md
- 'SPDX Lite': annexes/SPDX-Lite.md
- 'Diffs from Previous Editions': annexes/diffs-from-previous-editions.md
- 'Getting started with SPDX 3': annexes/getting-started.md
- licenses:
- 'Creative Commons Attribution License 3.0 Unported': licenses/CC-BY-3.0.md
- 'Community Specification License 1.0': licenses/Community-Spec-1.0.md

0 comments on commit 3b3521d

Please sign in to comment.