Skip to content

Fix source from the context links #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
randomnoise wants to merge 1 commit into from
Closed

Fix source from the context links #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions continuous-deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ An `environment` is a platform which may run a `service`.
| Field | Type | Description | Examples |
|-------|------|-------------|----------|
| id | `String` | Uniquely identifies the subject within the source. | `1234`, `maven123`, `builds/taskrun123` |
| source | `URI-Reference` | [source](../spec.md#source) from the context | `staging/tekton`, `tekton-dev-123`|
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | `staging/tekton`, `tekton-dev-123`|
Copy link
Member

@afrittoli afrittoli Mar 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the link should be source (no initial '/')

| name | `String` | Name of the environment | `dev`, `staging`, `production`, `ci-123`|
| url | `String` | URL to reference where the environment is located | `https://my-cluster.zone.my-cloud-provider`|

Expand All @@ -39,7 +39,7 @@ A `service` can represent for example a binary that is running, a daemon, an app
| Field | Type | Description | Examples |
|-------|------|-------------|----------|
| id | `String` | Uniquely identifies the subject within the source. | `service/myapp`, `daemonset/myapp` |
| source | `URI-Reference` | [source](../spec.md#source) from the context | `staging/tekton`, `tekton-dev-123`|
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | `staging/tekton`, `tekton-dev-123`|
| environment | `Object` ([`environment`](#environment)) | Reference for the environment where the service runs | `{"id": "1234"}`, `{"id": "maven123, "source": "tekton-dev-123"}` |
| artifactId | `Purl` | Identifier of the artifact deployed with this service | `pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c` |

Expand All @@ -56,7 +56,7 @@ This event represents an environment that has been created. Such an environment
| Field | Type | Description | Examples | Required |
|-------|------|-------------|----------|----------------------------|
| id | `String` | Uniquely identifies the subject within the source. | `tenant1/12345-abcde`, `namespace/pipelinerun-1234` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | | |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | | |
| name | `String` | Name of the environment | `dev`, `staging`, `production`, `ci-123`| |
| url | `String` | URL to reference where the environment is located | `https://my-cluster.zone.my-cloud-provider`| |

Expand All @@ -71,7 +71,7 @@ This event represents an environment that has been modified.
| Field | Type | Description | Examples | Required |
|-------|------|-------------|----------|----------------------------|
| id | `String` | Uniquely identifies the subject within the source. | `tenant1/12345-abcde`, `namespace/pipelinerun-1234` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | | |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | | |
| name | `String` | Name of the environment | `dev`, `staging`, `production`, `ci-123`| |
| url | `String` | URL to reference where the environment is located | `https://my-cluster.zone.my-cloud-provider`| |

Expand All @@ -86,7 +86,7 @@ This event represents an environment that has been deleted.```
| Field | Type | Description | Examples | Required |
|-------|------|-------------|----------|----------------------------|
| id | `String` | Uniquely identifies the subject within the source. | `tenant1/12345-abcde`, `namespace/pipelinerun-1234` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | | |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | | |
| name | `String` | Name of the environment | `dev`, `staging`, `production`, `ci-123`| |

### `service deployed`
Expand Down
28 changes: 14 additions & 14 deletions continuous-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ __Note:__ The data model for `builds`, apart from `id` and `source`, only includ
| Field | Type | Description | Examples |
|-------|------|-------------|----------|
| id | `String` | Uniquely identifies the subject within the source. | `1234`, `maven123`, `builds/taskrun123` |
| source | `URI-Reference` | [source](../spec.md#source) from the context | `staging/tekton`, `tekton-dev-123`|
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | `staging/tekton`, `tekton-dev-123`|
| artifactId | `String` | Identifier of the artifact produced by the build | `pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c` |

### `testCase`
Expand All @@ -44,7 +44,7 @@ __Note:__ The data model for `testCase` only includes `id` and `source`, inputs
| Field | Type | Description | Examples |
|-------|------|-------------|----------|
| id | `String` | Uniquely identifies the subject within the source. | `unitest-abc`, `e2e-test1`, `scan-image1` |
| source | `URI-Reference` | [source](../spec.md#source) from the context | `staging/tekton`, `tekton-dev-123`|
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | `staging/tekton`, `tekton-dev-123`|

### `testSuite`

Expand All @@ -55,7 +55,7 @@ __Note:__ The data model for `testSuite` only includes `id` and `source`, inputs
| Field | Type | Description | Examples |
|-------|------|-------------|----------|
| id | `String` | Uniquely identifies the subject within the source. | `unit`, `e2e`, `security` |
| source | `URI-Reference` | [source](../spec.md#source) from the context | `staging/tekton`, `tekton-dev-123`|
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | `staging/tekton`, `tekton-dev-123`|

### `artifact`

Expand All @@ -64,7 +64,7 @@ An `artifact` is usually produced as output of a build process. Events need to b
| Field | Type | Description | Examples |
|-------|------|-------------|----------|
| id | `String` | Uniquely identifies the subject within the source. | `pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c` |
| source | `URI-Reference` | [source](../spec.md#source) from the context | `staging/tekton`, `tekton-dev-123`|
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | `staging/tekton`, `tekton-dev-123`|
| change | `object` | The change (tag, commit, revision) of the repository which was used to build the artifact" | `{"id": "527d4a1aca5e8d0df24813df5ad65d049fc8d312", "source": "my-git.example/an-org/a-repo"}`, `{"id": "feature1234", "source": "my-git.example/an-org/a-repo"}` |

## Events
Expand All @@ -80,7 +80,7 @@ This event represents a Build task that has been queued; this build process usua
| Field | Type | Description | Examples | Required |
|-------|------|-------------|----------|----------------------------|
| id | `String` | Uniquely identifies the subject within the source. | `1234`, `maven123`, `builds/taskrun123` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | | |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | | |

### `build started`

Expand All @@ -93,7 +93,7 @@ This event represents a Build task that has been started; this build process usu
| Field | Type | Description | Examples | Required |
|-------|------|-------------|----------|----------------------------|
| id | `String` | Uniquely identifies the subject within the source. | `1234`, `maven123`, `builds/taskrun123` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | | |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | | |

### `build finished`

Expand All @@ -106,7 +106,7 @@ This event represents a Build task that has finished. This event will eventually
| Field | Type | Description | Examples | Required |
|-------|------|-------------|----------|----------------------------|
| id | `String` | Uniquely identifies the subject within the source. | `1234`, `maven123`, `builds/taskrun123` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | | |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | | |
| artifactId | `Purl` | Identifier of the artifact produced by the build | `pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c` | |

### `testCase queued`
Expand All @@ -120,7 +120,7 @@ This event represents a Test task that has been queued, and it is waiting to be
| Field | Type | Description | Examples | Required |
|-------|------|-------------|----------|----------------------------|
| id | `String` | Uniquely identifies the subject within the source. | `unitest-abc`, `e2e-test1`, `scan-image1` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | | |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | | |

### `testCase started`

Expand All @@ -133,7 +133,7 @@ This event represents a Test task that has started.
| Field | Type | Description | Examples | Required |
|-------|------|-------------|----------|----------------------------|
| id | `String` | Uniquely identifies the subject within the source. | `unitest-abc`, `e2e-test1`, `scan-image1` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | | |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | | |

### `testCase finished`

Expand All @@ -146,7 +146,7 @@ This event represents a Test task that has finished. This event will eventually
| Field | Type | Description | Examples | Required |
|-------|------|-------------|----------|----------------------------|
| id | `String` | Uniquely identifies the subject within the source. | `unitest-abc`, `e2e-test1`, `scan-image1` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | | |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | | |

### `testSuite started`

Expand All @@ -159,7 +159,7 @@ This event represents a Test suite that has been started.
| Field | Type | Description | Examples | Required |
|-------|------|-------------|----------|----------------------------|
| id | `String` | Uniquely identifies the subject within the source. | `unit`, `e2e`, `security` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | | |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | | |

### `testSuite finished`

Expand All @@ -172,7 +172,7 @@ This event represents a Test suite that has has finished, the event will contain
| Field | Type | Description | Examples | Required |
|-------|------|-------------|----------|----------------------------|
| id | `String` | Uniquely identifies the subject within the source. | `unit`, `e2e`, `security` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | | |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | | |

### `artifact packaged`

Expand All @@ -185,7 +185,7 @@ The event represents an artifact that has been packaged for distribution; this a
| Field | Type | Description | Examples | Required |
|-------|------|-------------|----------|----------------------------|
| id | `Purl` | Uniquely identifies the subject within the source. | `pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | | |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | | |
| change | `object` | The change (tag, commit, revision) of the repository which was used to build the artifact" | `{"id": "527d4a1aca5e8d0df24813df5ad65d049fc8d312", "source": "my-git.example/an-org/a-repo"}`, `{"id": "feature1234", "source": "my-git.example/an-org/a-repo"}` | ✅ |

### `artifact published`
Expand All @@ -199,4 +199,4 @@ The event represents an artifact that has been published and it can be advertise
| Field | Type | Description | Examples | Required |
|-------|------|-------------|----------|----------------------------|
| id | `Purl` | Uniquely identifies the subject within the source. | `pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427?repository_url=mycr.io/myapp`, `pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | | |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | | |
8 changes: 4 additions & 4 deletions continuous-operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ An `incident` represents a problem in a production environment.
| Field | Type | Description | Examples |
|-------|------|-------------|----------|
| id | `String` | Uniquely identifies the subject within the source. | `04896C75-F34D-40FF-A584-3F2B71CB9D47`, `issue123`, `risk-CVE123` |
| source | `URI-Reference` | [source](../spec.md#source) from the context | `region1/production`, `monitoring-system/metricA`|
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | `region1/production`, `monitoring-system/metricA`|
| description | `String` | Short, free style description of the incident | "Response time above 10ms", "New CVE-123 detected" |
| environment | `Object` ([`environment`](./continuous-deployment.md#environment)) | Reference to the environment | `{"id": "production"}`, `{"id": "staging"}`, `{"id": "prod123", "source": "iaas-region-1"}` |
| service | `Object` ([`service`](./continuous-deployment.md#service)) | Reference to the service | `{"id": "service123"}`, `{"id": "service123", "source": "region1/k8s/namespace"}` |
Expand All @@ -46,7 +46,7 @@ This event represents an incident that has been detected by a system or human.
| Field | Type | Description | Examples | Mandatory ✅ |
|-------|------|-------------|----------|----------------------------|
| id | `String` | Uniquely identifies the subject within the source. | `04896C75-F34D-40FF-A584-3F2B71CB9D47`, `issue123`, `risk-CVE123` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | `region1/production`, `monitoring-system/metricA`| |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | `region1/production`, `monitoring-system/metricA`| |
| description | `String` | Short, free style description of the incident | "Response time above 10ms", "New CVE-123 detected" | |
| environment | `Object` ([`environment`](./continuous-deployment.md#environment)) | Reference to the environment | `{"id": "production"}`, `{"id": "staging"}`, `{"id": "prod123", "source": "iaas-region-1"}` | ✅ |
| service | `Object` ([`service`](./continuous-deployment.md#service)) | Reference to the service | `{"id": "service123"}`, `{"id": "service123", "source": "region1/k8s/namespace"}` | |
Expand All @@ -63,7 +63,7 @@ This event represents an incident that has been reported through a ticketing sys
| Field | Type | Description | Examples | Mandatory ✅ |
|-------|------|-------------|----------|----------------------------|
| id | `String` | Uniquely identifies the subject within the source. | `04896C75-F34D-40FF-A584-3F2B71CB9D47`, `issue123`, `risk-CVE123` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | `region1/production`, `monitoring-system/metricA`| |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | `region1/production`, `monitoring-system/metricA`| |
| description | `String` | Short, free style description of the incident | "Response time above 10ms", "New CVE-123 detected" | |
| environment | `Object` ([`environment`](./continuous-deployment.md#environment)) | Reference to the environment | `{"id": "production"}`, `{"id": "staging"}`, `{"id": "prod123", "source": "iaas-region-1"}` | ✅ |
| ticketURI | `URI` | URI of the ticket | `example.issues.com/ticket123` | ✅ |
Expand All @@ -81,7 +81,7 @@ This event represents an incident that has been resolved, meaning that the probl
| Field | Type | Description | Examples | Mandatory ✅ |
|-------|------|-------------|----------|----------------------------|
| id | `String` | Uniquely identifies the subject within the source. | `04896C75-F34D-40FF-A584-3F2B71CB9D47`, `issue123`, `risk-CVE123` | ✅ |
| source | `URI-Reference` | [source](../spec.md#source) from the context | `region1/production`, `monitoring-system/metricA`| |
| source | `URI-Reference` | [source](/spec.md#source-context) from the context | `region1/production`, `monitoring-system/metricA`| |
| description | `String` | Short, free style description of the incident resolution | "Response time restored below 10ms", "CVE-123 acknowledged as non-exploitable" | |
| environment | `Object` ([`environment`](./continuous-deployment.md#environment)) | Reference to the environment | `{"id": "production"}`, `{"id": "staging"}`, `{"id": "prod123", "source": "iaas-region-1"}` | ✅ |
| service | `Object` ([`service`](./continuous-deployment.md#service)) | Reference to the service | `{"id": "service123"}`, `{"id": "service123", "source": "region1/k8s/namespace"}` | |
Expand Down
Loading