diff --git a/docs/annexes/diffs-from-previous-editions.md b/docs/annexes/diffs-from-previous-editions.md index 8c95349fbb..576300fed9 100644 --- a/docs/annexes/diffs-from-previous-editions.md +++ b/docs/annexes/diffs-from-previous-editions.md @@ -1,6 +1,6 @@ -# Annex I Differences from previous editions (Informative) +# Annex A: Differences from previous editions (Informative) -# I.1 Differences between V3.0 and V2.3 +# A.1 Differences between V3.0 and V2.3 ## Structural Differences @@ -797,7 +797,7 @@ The Tag/Value, YAML, RDF/XML and Spreadsheet formats are not supported. Additional serialization formats are being considered for the SPDX 3.1 release. -# I.2 Differences between V2.3 and V2.2.2 +# A.2 Differences between V2.3 and V2.2.2 V2.3 has added new fields to improve the ability to capture security related information and to improve interoperabiility with other SBOM formats. @@ -821,7 +821,7 @@ Key changes include: * Added Annex K ( How To Use SPDX in Different Scenarios ) to illustrate linking to external security information, and illustrate how the NTIA SBOM mandatory minimum elements map to SPDX fields. -# I.3 Differences between V2.2.2 and V2.2.1 +# A.3 Differences between V2.2.2 and V2.2.1 V2.2.2 fixed formatting, grammatical and spelling issues found since ISO/IEC 5962:2021 SPDX v2.2.1 was published. No new fields were added. @@ -837,7 +837,7 @@ Key changes include: * It fixed annex lettering inconsistencies. It also moved CC-BY-3.0 to the end of the spec to keep annex letters more consistent in future versions. Here is the translation between lettering in V2.2.2 and the version that came before it: -**Table I.1 — SPDX V2.2.2 Organizational Changes** +**Table A.1 — SPDX V2.2.2 Organizational Changes** Title | V2.2.1 ([spdx.dev](https://spdx.dev/)) | V2.2.1 (ISO) | V2.2.2 ----- | -------------------------------------- | ------------ | ------ @@ -848,11 +848,11 @@ Creative Commons Attribution License 3.0 Unported | Annex G | [omitted] | Ann *_This edition featured inconsistent lettering._ -# I.4 Differences between V2.2.1 and V2.2 +# A.4 Differences between V2.2.1 and V2.2 There were no technical differences; V2.2.1 is V2.2 reformatted for submission to ISO via the PAS process. As a result, new clauses were added causing the previous clause-numbering sequence to change. Also, Annexes went from having Roman numbers to Latin letters. Here is the translation between numbering in V2.2.1 and the version that came before it: -**Table I.2 — SPDX V2.2.1 Organizational Changes** +**Table A.2 — SPDX V2.2.1 Organizational Changes** Title | V2.2 | V2.2.1 ([spdx.dev](https://spdx.dev/)) | V2.2.1 (ISO) ----- | --------- | -------------------------------------- | ------------ @@ -883,7 +883,7 @@ Differences from Earlier SPDX Versions | N/A | Annex J/I* | *_This edition featured inconsistent lettering._ -# I.5 Differences from V2.2 and V2.1 +# A.5 Differences from V2.2 and V2.1 * JSON, YAML, and a development version of XML have been added as supported file formats. @@ -895,7 +895,7 @@ Differences from Earlier SPDX Versions | N/A | Annex J/I* | * Miscellaneous bug fixes and non-breaking improvements as reported on the mailing list and reported as issues on the spdx-spec GitHub repository. -# I.6 Differences between V2.1 and V2.0 +# A.6 Differences between V2.1 and V2.0 * Snippets have been added to allow a portion of a file to be identified as having different properties from the file it resides in. The use of snippets is completely optional and it is not mandatory for snippets to be identified. See section 5 Snippet Information for further details on the fields available to describe snippets. @@ -910,7 +910,7 @@ more information. * Miscellaneous bug fixes. -# I.7 Differences between V2.0 and V1.2 +# A.7 Differences between V2.0 and V1.2 * Abstraction has been applied to the underlying model with the inclusion of SPDX elements. With SPDX 2.0, the concept of an SPDX element is introduced (see Appendix III). This includes SPDX documents, SPDX files, and SPDX packages, each of which gets associated with an SPDX identifier which is denoted by “SPDXRef-”. diff --git a/docs/annexes/getting-started.md b/docs/annexes/getting-started.md index e3accfe521..acf79870e5 100644 --- a/docs/annexes/getting-started.md +++ b/docs/annexes/getting-started.md @@ -1,4 +1,4 @@ -# Annex J: Getting started writing SPDX 3 (Informative) +# Annex B: 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 diff --git a/mkdocs.yml b/mkdocs.yml index df075c5043..35486ce1db 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -330,14 +330,14 @@ nav: - model/Extension/Properties/cdxPropValue.md - model/Extension/Properties/cdxProperty.md - annexes: + - 'Diffs from Previous Editions': annexes/diffs-from-previous-editions.md + - 'Getting started with SPDX 3': annexes/getting-started.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 - '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