Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

As the author of this PR, please check off the items in this checklist:

- [ ] Has the [primer doc](https://github.com/cdevents/spec/blob/main/primer.md) been updated if a design decision is involved
- [ ] Has the [primer doc](https://github.com/cdevents/spec/blob/main/primer/_index.md) been updated if a design decision is involved
- [ ] Have the [JSON schemas](https://github.com/tektoncd/community/blob/main/standards.md#tests) been updated if the specification changed
- [ ] Has spec version and event versions been updated according to the [versioning policy](https://github.com/cdevents/spec/blob/main/primer.md#versioning)
- [ ] Has spec version and event versions been updated according to the [versioning policy](https://github.com/cdevents/spec/blob/main/primer/_index.md#versioning)
- [ ] Meets the [CDEvents contributor standards](https://github.com/cdevents/.github/blob/main/docs/CONTRIBUTING.md)
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The latest release of the specification on is
continuously follow the latest updates of the specification on [the `main`
branch](./spec.md).

The concepts and ideas that have formed the current specification are outlined in the [CDEvents Primer](./primer.md).
The concepts and ideas that have formed the current specification are outlined in the [CDEvents Primer](./primer/_index.md).
## CDEvents SDKs

CDEvents is developing as set of SDKs:
Expand Down
12 changes: 6 additions & 6 deletions primer.md → primer/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ limitation can be worked-around by adding the missing data in the tool output.
This solution may be brittle, because the tool output may not be a stable
interface for the tool, and it may change over time without notice.

![watcher-producer](images/watcher-producer.svg)
![watcher-producer](watcher-producer.svg)

This approach is certainly valid to build a proof-of-concept or to experiment
with events in an existing environment.
Expand All @@ -330,7 +330,7 @@ tool itself and the process of generating events.
If a tool does produce events, it may be possible to use an external adapter
component to convert the existing events into CDEvents.

![adapter](images/adapter.svg)
![adapter](adapter.svg)

Similar to the [previous case](#external-event-producer), incoming events may be
missing data required by CDEvents. If the events come from a tool that we do not
Expand All @@ -347,7 +347,7 @@ solved on the producer side by sending both format of events in parallel.
In some cases it may be possible to use a single broker for both event types,
for instance if both formats are CloudEvents based.

![multiple-produced](images/multiple-produced.svg)
![multiple-produced](multiple-produced.svg)

### Consumer-side architectures

Expand All @@ -362,7 +362,7 @@ produces only one format of events, which is sent to the broker. The adapter
subscribes to the events, converts them and publishes them back to the broker.
Consumer may then subscribe to the type of events that they prefer.

![original-adapter](images/original-adapter.svg)
![original-adapter](original-adapter.svg)

With this architecture, the adapter may even be able to convert messages from
different tools, instead of just one.
Expand All @@ -375,15 +375,15 @@ An adapter can be used to convert a CDEvent into the consumer specific format or
to extract data from a CDEvent and use it to invoke an API for the receiving
side.

![consumer-adapter](images/consumer-adapter.svg)
![consumer-adapter](consumer-adapter.svg)

#### Multiple event formats consumed

In this scenario, a new tool is added that produces CDEvents. An existing
consumer wants to benefit from existing events as well as the events from the
new tool.

![multiple-received](images/multiple-received.svg)
![multiple-received](multiple-received.svg)

A single consumer may receive events from heterogenous sources.

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
6 changes: 3 additions & 3 deletions roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ The continuous delivery ecosystem is quite large as it includes tools and servic
from the design of software, through its implementation, build, test, release, deployment and
operation.

In 2022 we want to focus on a few [key use cases](primer.md#use-cases) and make sure that we can fully support
In 2022 we want to focus on a few [key use cases](./primer/_index.md#use-cases) and make sure that we can fully support
them with the protocol specification. More specifically:

- Capture our key use cases and design decisions in the [CDEvents primer](primer.md) document
- Develop the spec to fully support our [key use cases](primer.md#use-cases)
- Capture our key use cases and design decisions in the [CDEvents primer](./primer/_index.md) document
- Develop the spec to fully support our [key use cases](./primer/_index.md#use-cases)
- Create our first [release v0.1](https://github.com/orgs/cdevents/projects/1)
- Define the specification versioning and stability policy
- Define our requirements for a v1.0
Expand Down
8 changes: 4 additions & 4 deletions spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ The specification is structured in two main parts:
dedicated document in the spec.

For an introduction see the [CDEvents README](README.md) and for more background
information please see our [CDEvents primer](primer.md).
information please see our [CDEvents primer](/docs/primer).
Copy link
Contributor

Choose a reason for hiding this comment

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

This link may work on the website, but not on github


## Notations and Terminology

Expand Down Expand Up @@ -190,7 +190,7 @@ defined in the [vocabulary](#vocabulary):
All event types should be prefixed with `dev.cdevents.`. One occurrence may
have multiple events associated, as long as they have different event types.
*Versions* are semantic in the *major.minor.patch* format. For more details about versions
see the the see [versioning](primer.md#versioning) documentation.
see the the see [versioning](/docs/primer#versioning) documentation.
Copy link
Contributor

Choose a reason for hiding this comment

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

ditto


- Constraints:
- REQUIRED
Expand All @@ -211,7 +211,7 @@ defined in the [vocabulary](#vocabulary):
to the same application.

When selecting the format for the source, it may be useful to think about how
clients may use it. Using the [root use cases](./primer.md#use-cases) as
clients may use it. Using the [root use cases](/docs/primer#use-cases) as
Copy link
Contributor

Choose a reason for hiding this comment

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

ditto

reference:

- A client may want to react only to events sent by a specific service, like
Expand Down Expand Up @@ -256,7 +256,7 @@ defined in the [vocabulary](#vocabulary):
- Description: The version of the CDEvents specification which the event
uses. This enables the interpretation of the context. Compliant event
producers MUST use a value of `0.1.1` when referring to this version of the
specification. For more details see [versioning](primer.md#versioning).
specification. For more details see [versioning](/docs/primer#versioning).
Copy link
Contributor

Choose a reason for hiding this comment

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

ditto


- Constraints:
- REQUIRED
Expand Down