From ea54981e26614f3dabe563a6278d17656306927c Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Tue, 30 Jul 2024 14:30:44 +0200 Subject: [PATCH] highlight implicit adding of version (#115) highlight implicit adding of version --- README.md | 2 +- doc/01-model/03-elements-sub.md | 6 +++--- doc/glossary.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e163d33..b872d9c 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,7 @@ The following chapters provide a formal description of the format to describe so ## Central OCM project web page -Check out the main project [web page](https://ocm.software) to find out more about OCM. It is your central entry point to all kinds of ocm related [docs and guides](https://ocm.software/docs/getting-started/first-steps-with-ocm/), this [spec](https://ocm.software/docs/overview/specification/) and all project-related [github repositories](https://github.com/open-component-model). It also offers a [Getting Started](https://ocm.software/docs/getting-started/first-steps-with-ocm/) to quickly make your hands dirty with ocm, its toolset and concepts :-) +Check out the main project [web page](https://ocm.software) to find out more about OCM. It is your central entry point to all kinds of ocm related [docs and guides](https://ocm.software/docs/getting-started), this [spec](https://ocm.software/docs/overview/specification/) and all project-related [github repositories](https://github.com/open-component-model). It also offers a [Getting Started](https://ocm.software/docs/getting-started) to quickly make your hands dirty with ocm, its toolset and concepts :-) ## Contributing diff --git a/doc/01-model/03-elements-sub.md b/doc/01-model/03-elements-sub.md index 008dc07..c63222e 100644 --- a/doc/01-model/03-elements-sub.md +++ b/doc/01-model/03-elements-sub.md @@ -43,9 +43,9 @@ descriptor. - **`version`** (optional) *string* This optional field version describes the version of the element. - If given, and the name and extra identity of the element is not unique in its - context, the version is implicitly added to the identity attribute set. - The resulting identity must be unique. + If given, and the `name` and `extraIdentity` attributes of the element + are not unique in the context, **the version is implicitly added to the + identity attribute set**. The resulting identity must be unique. By default, the version of an element in *not* part of the element identity to achieve a stable local element identity across multiple versions diff --git a/doc/glossary.md b/doc/glossary.md index 8f51372..d50ff88 100644 --- a/doc/glossary.md +++ b/doc/glossary.md @@ -50,7 +50,7 @@ The formal type of an [artifact](#artifact) described by a [component version](# An abstract entity describing a dedicated usage context or meaning for a provided piece of software. -### [Component Constructor](https://ocm.software/docs/getting-started/first-steps-with-ocm/#all-in-one) +### [Component Constructor](https://ocm.software/docs/getting-started/getting-started-with-ocm/create-a-component-version/#all-in-one) A file that acts as input for the OCM CLI to construct one or multiple component version(s).