Skip to content

Commit

Permalink
add readme description and initial road map
Browse files Browse the repository at this point in the history
Signed-off-by: ac360 <austen@serverless.com>
  • Loading branch information
austencollins authored and Doug Davis committed Feb 1, 2018
1 parent 9c3fa47 commit 5f0b5df
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 6 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
# CloudEvents Specification
# CloudEvents

This repository... (TBD)
Events are everywhere. However, event publishers tend to describe events
differently.

The [CNCF Serverless Working Group](https://github.com/cncf/wg-serverless)
owns this repository. Please see our [Governance](GOVERNANCE.md) document
for information on the processes we follow.
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 CloudEvents, a specification for describing event data in a common way.
CloudEvents seeks to ease event declaration and delivery across services,
platforms and beyond.

CloudEvents 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/).
35 changes: 35 additions & 0 deletions roadmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## Roadmap

The CloudEvents Roadmap.

*January*

* Establish governance, contributing guidelines and initial stakeholders.
* Agree on design goals for CloudEvents V.1.
* Draft educational materials on how to become a stakeholder.
* Draft educational materials on use-cases.
* Iterate on version 0.1 of the specification.

*February*

* Draft educational materials on use-cases.
* Collaborate on libraries and supporting tools to use CloudEvents and
integrate it with the ecosystem.
* Finalize version 0.1 of the specification by the end of February, 2018.

*March*

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

*April*

* Collaborate on libraries and supporting tools to use CloudEvents and
integrate it with the ecosystem.
* Build out promotional materials (website, logos, etc).

*May*

* Announce progress at CloudNativeCon Europe
2 changes: 1 addition & 1 deletion spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ that contains both context and data).
* OPTIONAL
* If present, MUST be a non-empty string

### open-events-version
### cloud-events-version
* Type: String
* Description: The version of the CloudEvents specification which the event
uses. This enables the interpretation of the context.
Expand Down

0 comments on commit 5f0b5df

Please sign in to comment.