Add readme description and initial road map #4

austencollins · 2018-01-10T23:27:22Z

Adds a basic overview of the effort and an initial road map.

Signed-off-by: Austen Collins <austenATserverless.com>

duglin · 2018-01-11T15:54:47Z

README.md

+
+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.


Can we wrap things at 80 columns? it makes the github diff tool work much better.

duglin · 2018-01-11T15:56:10Z

README.md

+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/).
+


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?

The use-cases are in another PR. Let me know if you think we should still link to it.

duglin · 2018-01-11T16:16:15Z

README.md

-# spec
+# OpenEvents
+
+Events are everywhere.  However, event publishers tend to describe events differently.


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.

Yes, but I don't think that distinction needs to be made in this line.

duglin · 2018-01-11T16:19:23Z

README.md

+
+*January*
+
+* Establish governance, contributing guidelines and initial stakeholders.


Might be good to include things like: gather/agree to usecases and design goals for v1

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.

I've added "agree upon design goals" to the Road map. Unsure about whether to limit the use-cases. We should discuss.

You are right. It may be too early to have a conversation about limiting the use cases. 👍 for "agree upon design goals"

duglin · 2018-01-18T15:21:09Z

@ac360 did you want to address the comments before today's call?

duglin · 2018-01-18T22:29:49Z

reopening to kick travis

carimura

LGTM

carimura · 2018-01-22T16:18:16Z

README.md

+
+*February*
+
+* Iterate on version 0.1 of the specification.


redundant. Last bullet about finalization assumes this.

austencollins · 2018-01-25T08:20:18Z

Addressed the comments in a few minor updates.

Signed-off-by: Austen Collins <austenATserverless.com>

schatekar · 2018-01-25T09:44:29Z

LGTM

duglin · 2018-01-25T13:37:06Z

README.md

+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.  


s/OpenEvents/CloudEvents

duglin · 2018-01-25T13:37:18Z

README.md

+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,


CloudEvents

duglin · 2018-01-25T13:37:28Z

README.md

+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,


CloudEvents

duglin · 2018-01-25T13:38:26Z

README.md

+*February*
+
+* Draft educational materials on use-cases.
+* Collaborate on libraries and supporting tools to use OpenEvents and


CloudEvents

duglin · 2018-01-25T13:38:36Z

README.md

+
+*March*
+
+* Collaborate on libraries and supporting tools to use OpenEvents and integrate


CloudEvents

duglin · 2018-01-25T13:38:43Z

README.md

+
+*April*
+
+* Collaborate on libraries and supporting tools to use OpenEvents and integrate


CloudEvents

duglin · 2018-01-25T13:39:25Z

overall looks good to me - just a few old refs to OpenEvents and a rebase needed.

duglin · 2018-01-25T13:39:36Z

DCO check failing too

leecalcote · 2018-01-25T16:38:39Z

@ac360 I've updated references from OpenEventing to CloudEvents. If you'll allow my user leecalcote to contribute to your ac360/spec fork, I'll commit them to this PR.

ultrasaurus · 2018-01-25T15:53:42Z

README.md

+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,


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 :)

ultrasaurus · 2018-01-25T15:54:34Z

README.md

+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


I think It would be good to split the roadmap into a separate doc, then will be easier to manage PRs separately!

+1. I'll do this.

duglin · 2018-01-29T21:48:42Z

roadmap.md

+* 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.)


minor nit but I think the period goes outside the parens. Below too.

lol. Period is for the abbreviation. It also needs a period after the sentence though.

deissnerk · 2018-02-01T15:42:34Z

LGTM

markito

LGTM

dklyle

LGTM

Signed-off-by: ac360 <austen@serverless.com>

duglin · 2018-02-01T19:40:52Z

Approved on Feb 1st call

duglin reviewed Jan 11, 2018

View reviewed changes

duglin closed this Jan 18, 2018

duglin reopened this Jan 18, 2018

carimura approved these changes Jan 22, 2018

View reviewed changes

duglin reviewed Jan 25, 2018

View reviewed changes

README.md Outdated

*March*

* Collaborate on libraries and supporting tools to use OpenEvents and integrate

Copy link

Collaborator

duglin Jan 25, 2018

Choose a reason for hiding this comment

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

CloudEvents

duglin reviewed Jan 25, 2018

View reviewed changes

README.md Outdated

*April*

* Collaborate on libraries and supporting tools to use OpenEvents and integrate

Copy link

Collaborator

duglin Jan 25, 2018

Choose a reason for hiding this comment

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

CloudEvents

ultrasaurus suggested changes Jan 25, 2018

View reviewed changes

duglin reviewed Jan 29, 2018

View reviewed changes

duglin force-pushed the readme-updates branch 3 times, most recently from 612ec20 to 856f3fe Compare January 30, 2018 00:15

markito approved these changes Feb 1, 2018

View reviewed changes

dklyle approved these changes Feb 1, 2018

View reviewed changes

add readme description and initial road map

5f0b5df

Signed-off-by: ac360 <austen@serverless.com>

duglin force-pushed the readme-updates branch from 856f3fe to 5f0b5df Compare February 1, 2018 19:39

duglin merged commit fd58fb9 into cloudevents:master Feb 1, 2018


		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.

		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/).


		January

		* Establish governance, contributing guidelines and initial stakeholders.


		March

		* Collaborate on libraries and supporting tools to use OpenEvents and integrate


		April

		* Collaborate on libraries and supporting tools to use OpenEvents and integrate

Add readme description and initial road map #4

Add readme description and initial road map #4

Conversation

austencollins commented Jan 10, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

duglin commented Jan 18, 2018

duglin commented Jan 18, 2018

carimura left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

austencollins commented Jan 25, 2018

schatekar commented Jan 25, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

duglin commented Jan 25, 2018

duglin commented Jan 25, 2018

leecalcote commented Jan 25, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

deissnerk commented Feb 1, 2018

markito left a comment

Choose a reason for hiding this comment

dklyle left a comment

Choose a reason for hiding this comment

duglin commented Feb 1, 2018