From 4d350107cedeb2fa8e00c8ac85a16663d16cf5bc Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Tue, 12 Mar 2024 14:45:27 +0100 Subject: [PATCH] correct line starts --- README.md | 115 ++++++++++++++++++------------------ doc/02-processing/README.md | 18 +++--- 2 files changed, 66 insertions(+), 67 deletions(-) diff --git a/README.md b/README.md index 679f15d..88848bf 100644 --- a/README.md +++ b/README.md @@ -17,62 +17,61 @@ The following chapters provide a formal description of the format to describe so ### Core Parts * 1. [Model](doc/01-model/README.md) - * 1.1. [OCM Model](doc/01-model/01-model.md#ocm-model) - * 1.1.1. [Introduction](doc/01-model/01-model.md#introduction) - * 1.1.2. [Components and Component Versions](doc/01-model/01-model.md#components-and-component-versions) - * 1.1.3. [Component Repositories](doc/01-model/01-model.md#component-repositories) - * 1.1.4. [Summary](doc/01-model/01-model.md#summary) + * 1.1 [OCM Model](doc/01-model/01-model.md#ocm-model) + * 1.1.1 [Introduction](doc/01-model/01-model.md#introduction) + * 1.1.2 [Components and Component Versions](doc/01-model/01-model.md#components-and-component-versions) + * 1.1.3 [Component Repositories](doc/01-model/01-model.md#component-repositories) + * 1.1.4 [Summary](doc/01-model/01-model.md#summary) * 1.2. [Model Elements](doc/01-model/02-elements-toplevel.md#model-elements) - * 1.2.1. [Components and Component Versions](doc/01-model/02-elements-toplevel.md#components-and-component-versions) - * 1.2.2. [Artifacts (Resources and Sources)](doc/01-model/02-elements-toplevel.md#artifacts-resources-and-sources) - * 1.2.3. [Sources](doc/01-model/02-elements-toplevel.md#sources) - * 1.2.4. [Resources](doc/01-model/02-elements-toplevel.md#resources) - * 1.2.5. [References](doc/01-model/02-elements-toplevel.md#references) - * 1.2.6. [Summary](doc/01-model/02-elements-toplevel.md#summary) + * 1.2.1 [Components and Component Versions](doc/01-model/02-elements-toplevel.md#components-and-component-versions) + * 1.2.2 [Artifacts (Resources and Sources)](doc/01-model/02-elements-toplevel.md#artifacts-resources-and-sources) + * 1.2.3 [Sources](doc/01-model/02-elements-toplevel.md#sources) + * 1.2.4 [Resources](doc/01-model/02-elements-toplevel.md#resources) + * 1.2.5 [References](doc/01-model/02-elements-toplevel.md#references) + * 1.2.6 [Summary](doc/01-model/02-elements-toplevel.md#summary) * 1.3. [Model Elements - Fundamentals](doc/01-model/03-elements-sub.md) - * 1.3.1. [Identifiers](doc/01-model/03-elements-sub.md#identifiers) - * 1.3.2. [Access Specification](doc/01-model/03-elements-sub.md#access-specification) - * 1.3.3. [Access Types](doc/01-model/03-elements-sub.md#access-types) - * 1.3.4. [Labels](doc/01-model/03-elements-sub.md#labels) - * 1.3.5. [Repository Contexts](doc/01-model/03-elements-sub.md#repository-contexts) - * 1.3.6. [Signatures](doc/01-model/03-elements-sub.md#signatures) - * 1.3.7. [Digest Info](doc/01-model/03-elements-sub.md#digest-info) - * 1.3.8. [Signature Info](doc/01-model/03-elements-sub.md#signature-info) - * 1.4. [Example of a complete Component Version](doc/01-model/04-example.md#example-of-a-complete-component-version) - * 1.5. [Conventions](doc/01-model/06-conventions.md#conventions) - * 1.5.1. [Intended Environments](doc/01-model/06-conventions.md#intended-environments) - * 1.5.2. [Selection of Usage Scenarios](doc/01-model/06-conventions.md#selection-of-usage-scenarios) - * 1.6. [Extending the Open Component Model](doc/01-model/07-extensions.md#extending-the-open-component-model) - * 1.6.1. [Functional extensions](doc/01-model/07-extensions.md#functional-extensions) - * 1.6.2. [Semantic extensions](doc/01-model/07-extensions.md#semantic-extensions) + * 1.3.1 [Identifiers](doc/01-model/03-elements-sub.md#identifiers) + * 1.3.2 [Access Specification](doc/01-model/03-elements-sub.md#access-specification) + * 1.3.3 [Access Types](doc/01-model/03-elements-sub.md#access-types) + * 1.3.4 [Labels](doc/01-model/03-elements-sub.md#labels) + * 1.3.5 [Repository Contexts](doc/01-model/03-elements-sub.md#repository-contexts) + * 1.3.6 [Signatures](doc/01-model/03-elements-sub.md#signatures) + * 1.3.7 [Digest Info](doc/01-model/03-elements-sub.md#digest-info) + * 1.3.8 [Signature Info](doc/01-model/03-elements-sub.md#signature-info) + * 1.4 [Example of a complete Component Version](doc/01-model/04-example.md#example-of-a-complete-component-version) + * 1.5 [Conventions](doc/01-model/06-conventions.md#conventions) + * 1.5.1 [Intended Environments](doc/01-model/06-conventions.md#intended-environments) + * 1.5.2 [Selection of Usage Scenarios](doc/01-model/06-conventions.md#selection-of-usage-scenarios) + * 1.6 [Extending the Open Component Model](doc/01-model/07-extensions.md#extending-the-open-component-model) + * 1.6.1 [Functional extensions](doc/01-model/07-extensions.md#functional-extensions) + * 1.6.2 [Semantic extensions](doc/01-model/07-extensions.md#semantic-extensions) * 2. [Processing](doc/02-processing/README.md) - * 2.1. [Referencing](doc/02-processing/01-references.md#referencing) - * 2.1.1. [Example](doc/02-processing/01-references.md#example) - * 2.2. [Signing](doc/02-processing/03-signing.md#signing) - * 2.2.1. [Verification Procedure](doc/02-processing/03-signing.md#verification-procedure) - * 2.3. [Normalization](doc/02-processing/04-digest.md#normalization) - * 2.3.1. [Artifact Digest](doc/02-processing/04-digest.md#artifact-digest) - * 2.3.2. [Normalization Types](doc/02-processing/04-digest.md#normalization-types) - * 2.3.3. [Serialization Format](doc/02-processing/04-digest.md#serialization-format) - * 2.3.4. [Recursive Digest Calculation](doc/02-processing/04-digest.md#recursive-digest-calculation) - * 2.4. [Example](doc/02-processing/04-digest.md#example) - * 2.4.1. [Simple Component-Version](doc/02-processing/04-digest.md#simple-component-version) - * 2.4.2. [Component-Version With Reference](doc/02-processing/04-digest.md#component-version-with-reference) - * 2.5. [Component Descriptor Normalization](doc/02-processing/04-digest.md#component-descriptor-normalization) - * 2.5.1. [Relevant information in Component Descriptors](doc/02-processing/04-digest.md#relevant-information-in-component-descriptors) - * 2.5.2. [Labels](doc/02-processing/04-digest.md#labels) - * 2.5.3. [Exclude Resources from Normalization/Signing](doc/02-processing/04-digest.md#exclude-resources-from-normalizationsigning) - * 2.5.4. [Generic Normalization Format](doc/02-processing/04-digest.md#generic-normalization-format) - * 2.6. [Artifact Normalization](doc/02-processing/04-digest.md#artifact-normalization) - * 2.6.1. [Blob Representation Format for Resource Types](doc/02-processing/04-digest.md#blob-representation-format-for-resource-types) - * 2.6.2. [Interaction of Local Blobs, Access Methods, Uploaders and Media Types](doc/02-processing/04-digest.md#interaction-of-local-blobs-access-methods-uploaders-and-media-types) + * 2.1 [Referencing](doc/02-processing/01-references.md#referencing) + * 2.1.1 [Example](doc/02-processing/01-references.md#example) + * 2.2 [Signing](doc/02-processing/03-signing.md#signing) + * 2.2.1 [Verification Procedure](doc/02-processing/03-signing.md#verification-procedure) + * 2.3 [Normalization](doc/02-processing/03-signing-process.md#signing-process-and-normalization) + * 2.3.1 [Artifact Digest](doc/02-processing/03-signing-process.md#determing-the-artifact-digests) + * 2.3.2 [Normalization Types](doc/02-processing/03-signing-process.md#normalization-types) + * 2.3.3 [Serialization Format](doc/02-processing/03-signing-process.md#serialization-format) + * 2.3.4 [Recursive Digest Calculation](doc/02-processing/03-signing-process.md#recursive-digest-calculation) + * 2.4 [Example](doc/02-processing/04-signing-examples.md#examples-for-signing-of-component-version) + * 2.4.1 [Simple Component-Version](doc/02-processing/04-signing-examples.md#simple-component-version) + * 2.4.2 [Component-Version With Reference](doc/02-processing/04-signing-examples.md#component-version-with-reference) + * 2.5 [Component Descriptor Normalization](doc/02-processing/04-signing-examples.md#component-descriptor-normalization) + * 2.5.1 [Signing-relevant information in Component Descriptors](doc/02-processing/04-signing-examples.md#relevant-information-in-component-descriptors) + * 2.5.2 [Exclude Resources from Normalization/Signing](doc/02-processing/05-component-descriptor-normalization.md#exclude-resources-from-normalizationsigning) + * 2.5.3 [Generic Normalization Format](doc/02-processing/05-component-descriptor-normalization.md#generic-normalization-format) + * 2.6 [Artifact Normalization](doc/02-processing/06-artifact-normalization.md#artifact-normalization) + * 2.6.1 [Blob Representation Format for Resource Types](doc/02-processing/06-artifact-normalization.md#blob-representation-format-for-resource-types) + * 2.6.2 [Interaction of Local Blobs, Access Methods, Uploaders and Media Types](doc/02-processing/06-artifact-normalization.md#interaction-of-local-blobs-access-methods-uploaders-and-media-types) * 3. [Persistence](doc/03-persistence/README.md) - * 3.1. [Model Operations](doc/03-persistence/01-operations.md#model-operations) - * 3.2. [Abstract Operations defined by the Open Component Model](doc/03-persistence/01-operations.md#abstract-operations-defined-by-the-open-component-model) - * 3.2.1. [Repository Operations](doc/03-persistence/01-operations.md#repository-operations) - * 3.2.2. [Access Method Operations](doc/03-persistence/01-operations.md#access-method-operations) + * 3.1 [Model Operations](doc/03-persistence/01-operations.md#model-operations) + * 3.2 [Abstract Operations defined by the Open Component Model](doc/03-persistence/01-operations.md#abstract-operations-defined-by-the-open-component-model) + * 3.2.1 [Repository Operations](doc/03-persistence/01-operations.md#repository-operations) + * 3.2.2 [Access Method Operations](doc/03-persistence/01-operations.md#access-method-operations) * 3.3. [Mappings for OCM Persistence](doc/03-persistence/02-mappings.md#mappings-for-ocm-persistence) - * 3.3.1. [Storage Backend Mappings for the Open Component Model](doc/03-persistence/02-mappings.md#storage-backend-mappings-for-the-open-component-model) + * 3.3.1 [Storage Backend Mappings for the Open Component Model](doc/03-persistence/02-mappings.md#storage-backend-mappings-for-the-open-component-model) ### Extensible Parts @@ -110,13 +109,13 @@ The following chapters provide a formal description of the format to describe so ### Guidelines and Conventions * 5. [Guidelines](doc/05-guidelines/README.md) - * 5.1. [Transport](doc/05-guidelines/01-transport.md#transport) - * 5.1.1. [Kinds of Transports](doc/05-guidelines/01-transport.md#kinds-of-transports) - * 5.2. [Model Contract](doc/05-guidelines/02-contract.md#model-contract) - * 5.2.1. [Example: Helm deployment](doc/05-guidelines/02-contract.md#example-helm-deployment) - * 5.3. [References](doc/05-guidelines/03-references.md#references) - * 5.3.1. [Relative Artifact References](doc/05-guidelines/03-references.md#relative-artifact-references) - * 5.3.2. [Absolute Artifact References](doc/05-guidelines/03-references.md#absolute-artifact-references) + * 5.1 [Transport](doc/05-guidelines/01-transport.md#transport) + * 5.1.1 [Kinds of Transports](doc/05-guidelines/01-transport.md#kinds-of-transports) + * 5.2 [Model Contract](doc/05-guidelines/02-contract.md#model-contract) + * 5.2.1 [Example: Helm deployment](doc/05-guidelines/02-contract.md#example-helm-deployment) + * 5.3 [References](doc/05-guidelines/03-references.md#references) + * 5.3.1 [Relative Artifact References](doc/05-guidelines/03-references.md#relative-artifact-references) + * 5.3.2 [Absolute Artifact References](doc/05-guidelines/03-references.md#absolute-artifact-references) ### Glossary diff --git a/doc/02-processing/README.md b/doc/02-processing/README.md index 7215376..fa6ec66 100644 --- a/doc/02-processing/README.md +++ b/doc/02-processing/README.md @@ -17,16 +17,16 @@ This chapter explains how to create and use components. * 4.1.[Simple Component-Version](04-signing-examples.md#simple-component-version) * 4.2.[Component-Version With Reference](04-signing-examples.md#component-version-with-reference) * 5.[Component Descriptor Normalization](04-signing-examples.md#component-descriptor-normalization) - * 5.1.[Relevant information in Component Descriptors](04-signing-examples.md#relevant-information-in-component-descriptors) + * 5.1.[Signing-relevant information in Component Descriptors](04-signing-examples.md#relevant-information-in-component-descriptors) * 5.1.1.[Access Methods](05-component-descriptor-normalization.md#access-methods) - * 5.2.[Labels](05-component-descriptor-normalization.md#labels) - * 5.3.[Exclude Resources from Normalization/Signing](05-component-descriptor-normalization.md#exclude-resources-from-normalizationsigning) - * 5.4.[Generic Normalization Format](05-component-descriptor-normalization.md#generic-normalization-format) - * 5.4.1.[Simple Values](05-component-descriptor-normalization.md#simple-values) - * 5.4.2.[Dictionary](05-component-descriptor-normalization.md#dictionary) - * 5.4.3.[Lists](05-component-descriptor-normalization.md#lists) - * 5.4.4.[Combined example](05-component-descriptor-normalization.md#combined-example) - * 5.4.5.[Empty values](05-component-descriptor-normalization.md#empty-values) + * 5.1.2.[Labels](05-component-descriptor-normalization.md#labels) + * 5.2.[Exclude Resources from Normalization/Signing](05-component-descriptor-normalization.md#exclude-resources-from-normalizationsigning) + * 5.3.[Generic Normalization Format](05-component-descriptor-normalization.md#generic-normalization-format) + * 5.3.1.[Simple Values](05-component-descriptor-normalization.md#simple-values) + * 5.3.2.[Dictionary](05-component-descriptor-normalization.md#dictionary) + * 5.3.3.[Lists](05-component-descriptor-normalization.md#lists) + * 5.3.4.[Combined example](05-component-descriptor-normalization.md#combined-example) + * 5.3.5.[Empty values](05-component-descriptor-normalization.md#empty-values) * 6.[Artifact Normalization](06-artifact-normalization.md#artifact-normalization) * 6.1.[Blob Representation Format for Resource Types](06-artifact-normalization.md#blob-representation-format-for-resource-types) * 6.2.[Interaction of Local Blobs, Access Methods, Uploaders and Media Types](06-artifact-normalization.md#interaction-of-local-blobs-access-methods-uploaders-and-media-types)