Add readme description and initial road map#4
Conversation
|
|
||
| Events are everywhere. However, event publishers tend to describe events differently. | ||
|
|
||
| The lack of a common way of describing events means developers must constantly re-learn how to receive events. This also limits the potential for libraries, tooling and infrastructure to aide the delivery of event data across environments, like SDKs, event routers or tracing systems. The portability and productivity we can achieve from event data is hindered overall. |
There was a problem hiding this comment.
Can we wrap things at 80 columns? it makes the github diff tool work much better.
| Enter OpenEvents, a specification for describing event data in a common way. OpenEvents seeks to ease event declaration and delivery across services, platforms and beyond. | ||
|
|
||
| OpenEvents is a new effort and it's still under active development. However, its working group has received a surprising amount of industry interest, ranging from major cloud providers to popular SaaS companies. Our end goal is to offer this specification to the [Cloud Native Computing Foundation](https://www.cncf.io/). | ||
|
|
There was a problem hiding this comment.
I think there's an AI to add a "usecases" doc. Would it make sense to add at least a placeholder doc and href into this PR so people can then incrementally add to the doc over time?
There was a problem hiding this comment.
The use-cases are in another PR. Let me know if you think we should still link to it.
| # spec | ||
| # OpenEvents | ||
|
|
||
| Events are everywhere. However, event publishers tend to describe events differently. |
There was a problem hiding this comment.
Do we need to be explicit about whether we're talking about events as they appear "on the wire" vs "as presented to the function" or both? This is probably related to my "usecases" comment below - meaning I think our target usecases should make it clear where the level of interop is that we're shooting for.
There was a problem hiding this comment.
Yes, but I don't think that distinction needs to be made in this line.
|
|
||
| *January* | ||
|
|
||
| * Establish governance, contributing guidelines and initial stakeholders. |
There was a problem hiding this comment.
Might be good to include things like: gather/agree to usecases and design goals for v1
There was a problem hiding this comment.
This one a good point. On one hand, it is useful to list all the use cases where event-driven architecture applies. On the other hand, it will keep the spec focussed if we define which use cases we are targetting and which we are explicitly leaving out at this stage.
There was a problem hiding this comment.
I've added "agree upon design goals" to the Road map. Unsure about whether to limit the use-cases. We should discuss.
There was a problem hiding this comment.
You are right. It may be too early to have a conversation about limiting the use cases. 👍 for "agree upon design goals"
|
@ac360 did you want to address the comments before today's call? |
|
reopening to kick travis |
|
|
||
| *February* | ||
|
|
||
| * Iterate on version 0.1 of the specification. |
There was a problem hiding this comment.
redundant. Last bullet about finalization assumes this.
|
Addressed the comments in a few minor updates. Signed-off-by: Austen Collins <austenATserverless.com> |
|
LGTM |
| environments, like SDKs, event routers or tracing systems. The portability and | ||
| productivity we can achieve from event data is hindered overall. | ||
|
|
||
| Enter OpenEvents, a specification for describing event data in a common way. |
| productivity we can achieve from event data is hindered overall. | ||
|
|
||
| Enter OpenEvents, a specification for describing event data in a common way. | ||
| OpenEvents seeks to ease event declaration and delivery across services, |
| OpenEvents seeks to ease event declaration and delivery across services, | ||
| platforms and beyond. | ||
|
|
||
| OpenEvents is a new effort and it's still under active development. However, |
| *February* | ||
|
|
||
| * Draft educational materials on use-cases. | ||
| * Collaborate on libraries and supporting tools to use OpenEvents and |
|
|
||
| *March* | ||
|
|
||
| * Collaborate on libraries and supporting tools to use OpenEvents and integrate |
|
|
||
| *April* | ||
|
|
||
| * Collaborate on libraries and supporting tools to use OpenEvents and integrate |
|
overall looks good to me - just a few old refs to OpenEvents and a rebase needed. |
|
DCO check failing too |
|
@ac360 I've updated references from OpenEventing to CloudEvents. If you'll allow my user |
| platforms and beyond. | ||
|
|
||
| OpenEvents is a new effort and it's still under active development. However, | ||
| its working group has received a surprising amount of industry interest, |
There was a problem hiding this comment.
I don't think it is surprising at all, given that a lot of Cloud providers have event platforms that are so similar that a 3rd party can create an interoperable platform even without a standard :)
| ranging from major cloud providers to popular SaaS companies. Our end goal is | ||
| to offer this specification to the [Cloud Native Computing Foundation](https://www.cncf.io/). | ||
|
|
||
| ## Roadmap |
There was a problem hiding this comment.
I think It would be good to split the roadmap into a separate doc, then will be easier to manage PRs separately!
There was a problem hiding this comment.
+1. I'll do this.
| * Collaborate on libraries and supporting tools to use CloudEvents and | ||
| integrate it with the ecosystem. | ||
| * Draft documentation and user guides. | ||
| * Build out promotional materials (website, logos, etc.) |
There was a problem hiding this comment.
minor nit but I think the period goes outside the parens. Below too.
There was a problem hiding this comment.
lol. Period is for the abbreviation. It also needs a period after the sentence though.
612ec20 to
856f3fe
Compare
|
LGTM |
Signed-off-by: ac360 <austen@serverless.com>
856f3fe to
5f0b5df
Compare
|
Approved on Feb 1st call |
Adds a basic overview of the effort and an initial road map.
Signed-off-by: Austen Collins <austenATserverless.com>