diff --git a/README.md b/README.md index 64bcac16..adabbf1f 100644 --- a/README.md +++ b/README.md @@ -39,11 +39,9 @@ points for metrics. ## CDEvents Specification The latest release of the specification is -[v0.1](https://github.com/cdevents/spec/tree/0.1.0/spec.md). - -You can also preview the ongoing work on the [CDEvents Specification](./spec.md) -on the `main` branch. +[v0.1.0](https://github.com/cdevents/spec/tree/0.1.0/spec.md), and you can continuously follow the latest updates +The concepts and ideas that have formed the current specification are outlined in the [CDEvents Primer](./primer.md). ## CDEvents SDKs CDEvents is developing as set of SDKs: diff --git a/primer.md b/primer.md index 8fb9399d..7381983c 100644 --- a/primer.md +++ b/primer.md @@ -187,7 +187,7 @@ The version of an event is included in its type. This allows for easy filtering of events of a specific version, by looking at a single field in the context. Examples of full event versions are: -- `dev.cdevents.build.queued.0.1.0` +- `dev.cdevents.build.queued.0.1.0-draft` - `dev.cdevents.environment.deleted.0.1.0` ### Versioning of the CDEvents specification @@ -207,7 +207,7 @@ format `vMajor.Minor.Patch`. identified by a change in the major version, for instance 0.1.2 -> 2.0.0 While a version of the specification is work in progress, its version is tagged -with an extra `-draft` at the end, for instance 0.1.0. +with an extra `-draft` at the end, for instance 0.1.0-draft. ### Development of a new version @@ -408,11 +408,11 @@ There are two root use cases that we are considering: The [CDF Interoperability Special Interest Group][sig-interop] has produced a [table of the terms][tool-terms] used by different CI/CD tools and how they -related to each other. The SIG is also working on distilling a recommended -[shared terminology][shared-terms]. CDEvents strives to adopt to the shared -terminology and collaborate with the SIG Interoperability. +relate to each other. The SIG Interoperability is also working on distilling a +recommended [shared terminology][shared-terms]. CDEvents strives to adopt to the +shared terminology and collaborate with the SIG Interoperability. -Work to align terms to those identified by the SIG will continue in upcoming +Work to align terms to those identified by the SIG Interoperability will continue in upcoming CDEvents releases. ## Design Decisions