From 5f0b5dfea18ea252699ba589d65eee7181d4b62f Mon Sep 17 00:00:00 2001 From: ac360 Date: Wed, 10 Jan 2018 13:44:39 -0800 Subject: [PATCH] add readme description and initial road map Signed-off-by: ac360 --- README.md | 23 ++++++++++++++++++----- roadmap.md | 35 +++++++++++++++++++++++++++++++++++ spec.md | 2 +- 3 files changed, 54 insertions(+), 6 deletions(-) create mode 100644 roadmap.md diff --git a/README.md b/README.md index 346369488..507835295 100644 --- a/README.md +++ b/README.md @@ -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/). diff --git a/roadmap.md b/roadmap.md new file mode 100644 index 000000000..3bb5b133a --- /dev/null +++ b/roadmap.md @@ -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 diff --git a/spec.md b/spec.md index dcc2fb401..059edb173 100644 --- a/spec.md +++ b/spec.md @@ -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.