Skip to content

Commit 9adb453

Browse files
authored
Correct links (#106)
**What this PR does / why we need it**: correct links and markdown files style
1 parent 15590da commit 9adb453

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+1222
-1131
lines changed

.github/.markdownlint.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
default: true
22

33
MD013: false #https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md013
4+
MD029: false #https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md033
45
MD033: false #https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md033

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Welcome to the OCM community!
1+
# Welcome to the OCM community
22

33
We welcome many different types of contributions.
44

5-
Please refer to the [Contributing Guide in the Community repository](https://github.com/open-component-model/community/blob/main/CONTRIBUTING.md) for more information on how to get support from maintainers, find work to contribute, the Pull Request checklist, the Pull Request process, and other useful information on contributing to the OCM projects.
5+
Please refer to the [Contributing Guide in the Community repository](https://github.com/open-component-model/community/blob/main/CONTRIBUTING.md) for more information on how to get support from maintainers, find work to contribute, the Pull Request checklist, the Pull Request process, and other useful information on contributing to the OCM projects.

README.md

Lines changed: 100 additions & 99 deletions
Large diffs are not rendered by default.

doc/01-model/01-model.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ The Open Compoment Model consists of a core model plus extensions. The core mode
88

99
The following chapters will provide more details about these concepts.
1010

11-
1211
## Components and Component Versions
1312

1413
Usually, complex software products are divided into logical units (called components in this specification). A component is typically maintained in a version control system. It has a build procedure generating binary artifacts from source code and a release process to make it available for consumers. Usually, releases are repeated from time to time, making new versions available. A component is a logical unit within a software product. It is a semantic bracket around software pieces belonging together because they fulfill a specific purpose. E.g. like, "This is the Frontend Component," "This is the Database component," and "This is the Kubernetes vertical autoscale component."

doc/01-model/02-elements-toplevel.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,7 @@ A *Component* is technically defined by a globally unique identifier.
2121

2222
The component identity uses the following naming scheme:
2323

24-
<div>
25-
26-
*&lt;DNS domain>* `/` *&lt;name component> {* `/` *&lt;name component> }*
27-
28-
</div>
24+
*\<DNS domain>* `/` *\<name component>* { `/` *\<name component>* }
2925

3026
Hereby the DNS domain plus optionally any number of leading name components MUST
3127
be owned by the provider of a component. For example, `github.com`, as DNS domain
@@ -42,6 +38,7 @@ specification (e.g. `github.com/gardener/external-dns-management:0.15.1`).
4238
## Artifacts (Resources and Sources)
4339

4440
The Open Component Model distinguishes two kinds of artifacts:
41+
4542
- *Sources* are optional artifacts that contain the sources, which
4643
were used to generate the deployment-relevant *Resources*.
4744
- *Resources* are artifacts that finally make up the deployment-relevant set of artifacts.
@@ -71,7 +68,6 @@ Those attributes are described by formal fields in the component descriptor:
7168

7269
The access specification for the actual artifact (see below)
7370

74-
7571
### Artifact Types
7672

7773
The formal type of an artifact uniquely specifies the logical interpretation of an artifact and its kind,
@@ -161,7 +157,7 @@ There are two kinds of types:
161157

162158
So, the complete pattern looks as follows:
163159

164-
```
160+
```text
165161
<DNS domain name>/[a-z][a-zA-Z0-9]*
166162
```
167163

@@ -206,8 +202,8 @@ In addition to the common artifact information, a resource may optionally descri
206202
A resource uses the following additional formal fields:
207203

208204
- **`relation`** (required) *string['local', 'external']*
209-
Indicates whether the entity providing a component is also the provider of the resource ('local') or whether the
210-
resource is provided by a separate entity ('external'). This may be useful to determine whether the entity responsible
205+
Indicates whether the entity providing a component is also the provider of the resource ('local') or whether the
206+
resource is provided by a separate entity ('external'). This may be useful to determine whether the entity responsible
211207
for the component is also responsible for the resource.
212208
This property is purely informational and completely unrelated to the access method type.
213209

@@ -223,12 +219,12 @@ A resource uses the following additional formal fields:
223219
This field is used to describe the sources used to generate the resource.
224220
The selection is done by the following two fields:
225221

226-
- **`identitySelector`** *map[string]string*
222+
- **`identitySelector`** *map[string]string*
227223

228224
Identity attributes determining an appropriate source
229225
element.
230226

231-
- **`labels`** (optional) *[]Label*
227+
- **`labels`** (optional) *[]Label*
232228

233229
A list of arbitrary labels
234230

@@ -285,6 +281,7 @@ A `references` element has the following fields:
285281
The extra identity of the referenced component.
286282

287283
Example:
284+
288285
```yaml
289286
...
290287
references:

doc/01-model/03-elements-sub.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ of constraints is then just a partial match of the set of identity attributes.
4949
You want to describe different image versions to be used
5050
for different Kubernetes versions deployed on different OS platforms and CPU architectures.
5151
With identity attributes this can be easily modeled by using
52+
5253
- the `name` attribute for the purpose (e.g. OCM CLI)
5354
- the `version` attribute for the version
5455
- and an `extraIdentity` attribute for the intended Kubernetes OS platform and architecture
@@ -120,7 +121,7 @@ The content of a described artifact is accessible by applying its global identit
120121
<img src="ocmresourceaccess.png" alt="Structure of OCM Specification" width="800"/>
121122
</div>
122123

123-
The access specification of an artifact may change when component versions are transported among repositories.
124+
The access specification of an artifact may change when component versions are transported among repositories.
124125

125126
Examples for access specification types are:
126127

@@ -189,7 +190,7 @@ attributes are not allowed at the label entry level.
189190
They can be changed in any repository the component version has been transferred to.
190191
This is supported to attach evolving information to a component version.
191192
But it also implies, that a component version must be updatable (re-transferable) in a certain target repository.
192-
This may lead to conflicting changes which might need to be resolved in a non-trivial way.
193+
This may lead to conflicting changes which might need to be resolved in a non-trivial way.
193194

194195
The merge behaviour can be specified together with the label definition using the `merge` attribute.
195196
It has the following fields:
@@ -246,7 +247,6 @@ Every signature entry has the following formal fields:
246247

247248
The signature for the specified digest.
248249

249-
250250
## Digest Info
251251

252252
A digest is specified by the following fields:

doc/01-model/06-conventions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ If platform specific images are described as separate resources instead of using
2626

2727
## Selection of Usage Scenarios
2828

29-
Usage scenarios for sets of described artifacts are best described by a dedicated [description artifacts](../../specification/contract/README.md#how-does-it-look-like-in-the-open-component-model) with a dedicated tool-specific artifact type. Here, there is the complete freedom to describe the conditions and environments artifacts are to be used. The artifacts are described by [relative resource references](../05-guidelines/03-references.md#relative-artifact-references) in relation to the component version containing the description artifact.
29+
Usage scenarios for sets of described artifacts are best described by a dedicated description artifact with a dedicated tool-specific artifact type. Here, there is the complete freedom to describe the conditions and environments artifacts are to be used. The artifacts are described by [relative resource references](../05-guidelines/03-references.md#relative-artifact-references) in relation to the component version containing the description artifact.
3030

3131
Another possibility is to use dedicated [labels](./03-elements-sub.md#labels) to describe the usage scenario for dedicated artifacts. Here, the tool working on a component versions does not read a description artifact, but has to analyse the label settings of all the provided artifacts. In both cases there is a dedicated OCM specific interpretation of content provided by the component model. But while the first solution allows to describe a closed scenario in a dedicated resource, where resources from dependent component version can be described by relative resource references and multiple scenarios can be separated by multiple flavors of this resource, the label-based approach is restricted to a local component version and a single scenario. Instead of an artifact type for the description, labels with a defined [name structure](./03-elements-sub.md#labels) are required.

0 commit comments

Comments
 (0)