Skip to content

Commit d9e3038

Browse files
committed
Add notes about SIG interop terms
Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
1 parent 903f282 commit d9e3038

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

primer.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -377,11 +377,6 @@ new tool.
377377

378378
A single consumer may receive events from heterogenous sources.
379379

380-
## Acknowledgments
381-
382-
The initial structure of the CDEvents specification format was based on the
383-
specification of the [CloudEvents](https://github.com/cloudevents/spec) project.
384-
385380
## Use Cases
386381

387382
There are two root use cases that we are considering:
@@ -409,6 +404,17 @@ There are two root use cases that we are considering:
409404
- Lead time for changes: the amount of time it takes a commit to get into production
410405
- Deployment frequency: how often an organization successfully releases to production
411406

407+
## Terminology
408+
409+
The [CDF Interoperability Special Interest Group][sig-interop] has produced a
410+
[table of the terms][tool-terms] used by different CI/CD tools and how they
411+
related to each other. The SIG is also working on distilling a recommended
412+
[shared terminology][shared-terms]. CDEvents strives to adopt to the shared
413+
terminology and collaborate with the SIG Interoperability.
414+
415+
Work to align terms to those identified by the SIG will continue in upcoming
416+
CDEvents releases.
417+
412418
## Design Decisions
413419

414420
### Keys, Values and Types
@@ -454,6 +460,11 @@ audience of DevOps Engineers, Project Managers/Directors, CTOs, and Cloud
454460
Architects who are interested in learning more about CDEvents, why it was
455461
created and its mission.
456462

463+
## Acknowledgments
464+
465+
The initial structure of the CDEvents specification format was based on the
466+
specification of the [CloudEvents](https://github.com/cloudevents/spec) project.
467+
457468
[workstream]: https://github.com/cdfoundation/sig-interoperability/tree/master/workstreams/archived/events_in_cicd
458469
[sig-interop]: https://github.com/cdfoundation/sig-interoperability
459470
[sig-events]: https://github.com/cdfoundation/sig-events/
@@ -464,4 +475,9 @@ created and its mission.
464475
https://github.com/package-url/purl-spec/blob/master/PURL-SPECIFICATION.rst
465476
[sig-interop-vocabulary]:
466477
https://github.com/cdfoundation/sig-interoperability/blob/main/docs/vocabulary.md
467-
[dora]: https://cloud.google.com/blog/products/devops-sre/using-the-four-keys-to-measure-your-devops-performance
478+
[dora]:
479+
https://cloud.google.com/blog/products/devops-sre/using-the-four-keys-to-measure-your-devops-performance
480+
[tool-terms]:
481+
https://github.com/cdfoundation/sig-interoperability/blob/main/docs/tools-terminology.md
482+
[shared-terms]:
483+
https://github.com/cdfoundation/sig-interoperability/blob/main/docs/pipelines-terminology.md

0 commit comments

Comments
 (0)