From cd41f28485aba611c6dbb365177c428cca69fc59 Mon Sep 17 00:00:00 2001 From: Doug Davis Date: Thu, 11 Nov 2021 02:41:35 +0000 Subject: [PATCH] re-org and fix links Signed-off-by: Doug Davis --- Makefile | 13 ------ README.md | 40 +++++++++--------- SDK.md => cloudevents/SDK.md | 0 adapters.md => cloudevents/adapters.md | 0 {adapters => cloudevents/adapters}/aws-s3.md | 0 {adapters => cloudevents/adapters}/couchdb.md | 0 {adapters => cloudevents/adapters}/github.md | 0 {adapters => cloudevents/adapters}/gitlab.md | 0 .../bindings/amqp-protocol-binding.md | 0 .../bindings/http-protocol-binding.md | 0 .../bindings/kafka-protocol-binding.md | 4 +- .../bindings/mqtt-protocol-binding.md | 0 .../bindings/nats-protocol-binding.md | 0 spec.avsc => cloudevents/cloudevents.avsc | 0 spec.json => cloudevents/cloudevents.json | 0 .../documented-extensions.md | 2 +- .../extensions}/dataref.md | 0 .../extensions}/distributed-tracing.md | 0 .../extensions}/partitioning.md | 0 .../extensions}/sampled-rate.md | 0 .../extensions}/sequence.md | 0 .../formats/avro-format.md | 2 +- .../formats/json-format.md | 4 +- .../http-webhook.md | 0 primer.md => cloudevents/primer.md | 12 +++--- .../proprietary-specs.md | 0 .../source-event-action.png | Bin spec.md => cloudevents/spec.md | 8 ++-- CONTRIBUTING.md => community/CONTRIBUTING.md | 0 GOVERNANCE.md => community/GOVERNANCE.md | 12 +++--- community/open-source.md | 4 +- misc/Makefile | 19 +++++++++ {artwork => misc/artwork}/README.md | 0 roadmap.md => misc/roadmap.md | 6 +-- .../2018-02-22-CloudEvents-Routing.pptx | Bin .../share}/2018-02-22-CloudEvents.pdf | Bin .../share}/2018-03-22-TopicsAndSubjects.pptx | Bin .../2018-11-14-KubeCon-Intro-DeepDive.pdf | Bin {share => misc/share}/README.md | 0 {tools => misc/tools}/verify-docs.sh | 0 {tools => misc/tools}/verify-links.sh | 0 {tools => misc/tools}/verify-specs.sh | 0 42 files changed, 66 insertions(+), 60 deletions(-) delete mode 100644 Makefile rename SDK.md => cloudevents/SDK.md (100%) rename adapters.md => cloudevents/adapters.md (100%) rename {adapters => cloudevents/adapters}/aws-s3.md (100%) rename {adapters => cloudevents/adapters}/couchdb.md (100%) rename {adapters => cloudevents/adapters}/github.md (100%) rename {adapters => cloudevents/adapters}/gitlab.md (100%) rename amqp-protocol-binding.md => cloudevents/bindings/amqp-protocol-binding.md (100%) rename http-protocol-binding.md => cloudevents/bindings/http-protocol-binding.md (100%) rename kafka-protocol-binding.md => cloudevents/bindings/kafka-protocol-binding.md (98%) rename mqtt-protocol-binding.md => cloudevents/bindings/mqtt-protocol-binding.md (100%) rename nats-protocol-binding.md => cloudevents/bindings/nats-protocol-binding.md (100%) rename spec.avsc => cloudevents/cloudevents.avsc (100%) rename spec.json => cloudevents/cloudevents.json (100%) rename documented-extensions.md => cloudevents/documented-extensions.md (96%) rename {extensions => cloudevents/extensions}/dataref.md (100%) rename {extensions => cloudevents/extensions}/distributed-tracing.md (100%) rename {extensions => cloudevents/extensions}/partitioning.md (100%) rename {extensions => cloudevents/extensions}/sampled-rate.md (100%) rename {extensions => cloudevents/extensions}/sequence.md (100%) rename avro-format.md => cloudevents/formats/avro-format.md (99%) rename json-format.md => cloudevents/formats/json-format.md (98%) rename http-webhook.md => cloudevents/http-webhook.md (100%) rename primer.md => cloudevents/primer.md (98%) rename proprietary-specs.md => cloudevents/proprietary-specs.md (100%) rename source-event-action.png => cloudevents/source-event-action.png (100%) rename spec.md => cloudevents/spec.md (98%) rename CONTRIBUTING.md => community/CONTRIBUTING.md (100%) rename GOVERNANCE.md => community/GOVERNANCE.md (94%) create mode 100644 misc/Makefile rename {artwork => misc/artwork}/README.md (100%) rename roadmap.md => misc/roadmap.md (95%) rename {share => misc/share}/2018-02-22-CloudEvents-Routing.pptx (100%) rename {share => misc/share}/2018-02-22-CloudEvents.pdf (100%) rename {share => misc/share}/2018-03-22-TopicsAndSubjects.pptx (100%) rename {share => misc/share}/2018-11-14-KubeCon-Intro-DeepDive.pdf (100%) rename {share => misc/share}/README.md (100%) rename {tools => misc/tools}/verify-docs.sh (100%) rename {tools => misc/tools}/verify-links.sh (100%) rename {tools => misc/tools}/verify-specs.sh (100%) diff --git a/Makefile b/Makefile deleted file mode 100644 index 69e8426b1..000000000 --- a/Makefile +++ /dev/null @@ -1,13 +0,0 @@ -all: verify - -verify: - @echo Running href checker: - @# Use "-x" if you want to skip external links - @tools/verify-links.sh -v . - @echo Running the spec phrase checker: - @tools/verify-specs.sh -v spec.md documented-extensions.md json-format.md \ - http-protocol-binding.md http-webhook.md mqtt-protocol-binding.md \ - nats-protocol-binding.md \ - kafka-protocol-binding.md avro-format.md - @echo Running the doc phrase checker: - @tools/verify-docs.sh -v . diff --git a/README.md b/README.md index c26f0b7df..621425d0b 100644 --- a/README.md +++ b/README.md @@ -27,38 +27,38 @@ The following documents are available: | | Latest Release | Working Draft | | :---------------------------- | :----------------------------------------------------------------------------: | :---------------------------------------------------------------------------------: | | **Core Specification:** | -| CloudEvents | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/spec.md) | [master](https://github.com/cloudevents/spec/blob/master/spec.md) | +| CloudEvents | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/cloudevents/spec.md) | [main](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md) | | | | **Optional Specifications:** | -| AMQP Protocol Binding | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/amqp-protocol-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/amqp-protocol-binding.md) | -| AVRO Event Format | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/avro-format.md) | [master](https://github.com/cloudevents/spec/blob/master/avro-format.md) | -| HTTP Protocol Binding | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/http-protocol-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/http-protocol-binding.md) | -| JSON Event Format | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/json-format.md) | [master](https://github.com/cloudevents/spec/blob/master/json-format.md) | -| Kafka Protocol Binding | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/kafka-protocol-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/kafka-protocol-binding.md) | -| MQTT Protocol Binding | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/mqtt-protocol-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/mqtt-protocol-binding.md) | -| NATS Protocol Binding | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/nats-protocol-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/nats-protocol-binding.md) | -| Web hook | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/http-webhook.md) | [master](https://github.com/cloudevents/spec/blob/master/http-webhook.md) | +| AMQP Protocol Binding | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/amqp-protocol-binding.md) | [main](https://github.com/cloudevents/spec/blob/main/cloudevents/bindings/amqp-protocol-binding.md) | +| AVRO Event Format | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/avro-format.md) | [main](https://github.com/cloudevents/spec/blob/main/cloudevents/formats/avro-format.md) | +| HTTP Protocol Binding | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/http-protocol-binding.md) | [main](https://github.com/cloudevents/spec/blob/main/cloudevents/bindings/http-protocol-binding.md) | +| JSON Event Format | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/json-format.md) | [main](https://github.com/cloudevents/spec/blob/main/cloudevents/formats/json-format.md) | +| Kafka Protocol Binding | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/kafka-protocol-binding.md) | [main](https://github.com/cloudevents/spec/blob/main/cloudevents/bindings/kafka-protocol-binding.md) | +| MQTT Protocol Binding | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/mqtt-protocol-binding.md) | [main](https://github.com/cloudevents/spec/blob/main/cloudevents/bindings/mqtt-protocol-binding.md) | +| NATS Protocol Binding | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/nats-protocol-binding.md) | [main](https://github.com/cloudevents/spec/blob/main/cloudevents/bindings/nats-protocol-binding.md) | +| Web hook | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/http-webhook.md) | [main](https://github.com/cloudevents/spec/blob/main/cloudevents/http-webhook.md) | | | | **Additional Documentation:** | -| CloudEvents Adapters | - | [master](https://github.com/cloudevents/spec/blob/master/adapters.md) | -| CloudEvents SDK Requirements | - | [master](https://github.com/cloudevents/spec/blob/master/SDK.md) | -| Documented Extensions | - | [master](https://github.com/cloudevents/spec/blob/master/documented-extensions.md) | -| Primer | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/primer.md) | [master](https://github.com/cloudevents/spec/blob/master/primer.md) | -| Proprietary Specifications | - | [master](https://github.com/cloudevents/spec/blob/master/proprietary-specs.md) | +| CloudEvents Adapters | - | [main](https://github.com/cloudevents/spec/blob/main/cloudevetns/adapters.md) | +| CloudEvents SDK Requirements | - | [main](https://github.com/cloudevents/spec/blob/main/cloudevents/SDK.md) | +| Documented Extensions | - | [main](https://github.com/cloudevents/spec/blob/main/cloudevents/documented-extensions.md) | +| Primer | [v1.0](https://github.com/cloudevents/spec/blob/v1.0/cloudevents/primer.md) | [main](https://github.com/cloudevents/spec/blob/main/cloudevents/primer.md) | +| Proprietary Specifications | - | [main](https://github.com/cloudevents/spec/blob/main/cloudevents/proprietary-specs.md) | If you are new to CloudEvents, it is recommended that you start by reading the -[Primer](primer.md) for an overview of the specification's goals and design -decisions, and then move on to the [core specification](spec.md). +[Primer](cloudevents/primer.md) for an overview of the specification's goals and design +decisions, and then move on to the [core specification](cloudevents/spec.md). Since not all event producers generate CloudEvents by default, there is documentation describing the recommended process for adapting some popular events into CloudEvents, see -[CloudEvents Adapters](https://github.com/cloudevents/spec/blob/master/adapters.md). +[CloudEvents Adapters](https://github.com/cloudevents/spec/blob/main/cloudevents/adapters.md). ## SDKs In addition to the documentation mentioned above, there are also an -[SDK proposal](SDK.md) and a set of SDKs being developed: +[SDK proposal](cloudevents/SDK.md) and a set of SDKs being developed: - [CSharp](https://github.com/cloudevents/sdk-csharp) - [Go](https://github.com/cloudevents/sdk-go) @@ -78,8 +78,8 @@ native ecosystem by making our systems interoperable with CloudEvents. ## Process -The CloudEvents project is working to formalize the [specification](spec.md) -based on [design goals](primer.md#design-goals) which focus on interoperability +The CloudEvents project is working to formalize the [specification](cloudevents/spec.md) +based on [design goals](cloudevents/primer.md#design-goals) which focus on interoperability between systems which generate and respond to events. In order to achieve these goals, the project must describe: diff --git a/SDK.md b/cloudevents/SDK.md similarity index 100% rename from SDK.md rename to cloudevents/SDK.md diff --git a/adapters.md b/cloudevents/adapters.md similarity index 100% rename from adapters.md rename to cloudevents/adapters.md diff --git a/adapters/aws-s3.md b/cloudevents/adapters/aws-s3.md similarity index 100% rename from adapters/aws-s3.md rename to cloudevents/adapters/aws-s3.md diff --git a/adapters/couchdb.md b/cloudevents/adapters/couchdb.md similarity index 100% rename from adapters/couchdb.md rename to cloudevents/adapters/couchdb.md diff --git a/adapters/github.md b/cloudevents/adapters/github.md similarity index 100% rename from adapters/github.md rename to cloudevents/adapters/github.md diff --git a/adapters/gitlab.md b/cloudevents/adapters/gitlab.md similarity index 100% rename from adapters/gitlab.md rename to cloudevents/adapters/gitlab.md diff --git a/amqp-protocol-binding.md b/cloudevents/bindings/amqp-protocol-binding.md similarity index 100% rename from amqp-protocol-binding.md rename to cloudevents/bindings/amqp-protocol-binding.md diff --git a/http-protocol-binding.md b/cloudevents/bindings/http-protocol-binding.md similarity index 100% rename from http-protocol-binding.md rename to cloudevents/bindings/http-protocol-binding.md diff --git a/kafka-protocol-binding.md b/cloudevents/bindings/kafka-protocol-binding.md similarity index 98% rename from kafka-protocol-binding.md rename to cloudevents/bindings/kafka-protocol-binding.md index f3ad407af..369fa52fa 100644 --- a/kafka-protocol-binding.md +++ b/cloudevents/bindings/kafka-protocol-binding.md @@ -121,7 +121,7 @@ _structured_ mode with the JSON event format. The 'key' attribute is populated by a partitionKeyExtractor function. The partitionKeyExtractor is a protocol specific function that contains bespoke logic to extract and populate the value. A default implementation of the -extractor will use the [Partitioning](extensions/partitioning.md) extension +extractor will use the [Partitioning](../extensions/partitioning.md) extension value. ### 3.2. Binary Content Mode @@ -142,7 +142,7 @@ message. #### 3.2.3. Metadata Headers All [CloudEvents][ce] attributes and -[CloudEvent Attributes Extensions](primer.md#cloudevent-attribute-extensions) +[CloudEvent Attributes Extensions](../primer.md#cloudevent-attribute-extensions) with exception of `data` MUST be individually mapped to and from the Header fields in the Kafka message. diff --git a/mqtt-protocol-binding.md b/cloudevents/bindings/mqtt-protocol-binding.md similarity index 100% rename from mqtt-protocol-binding.md rename to cloudevents/bindings/mqtt-protocol-binding.md diff --git a/nats-protocol-binding.md b/cloudevents/bindings/nats-protocol-binding.md similarity index 100% rename from nats-protocol-binding.md rename to cloudevents/bindings/nats-protocol-binding.md diff --git a/spec.avsc b/cloudevents/cloudevents.avsc similarity index 100% rename from spec.avsc rename to cloudevents/cloudevents.avsc diff --git a/spec.json b/cloudevents/cloudevents.json similarity index 100% rename from spec.json rename to cloudevents/cloudevents.json diff --git a/documented-extensions.md b/cloudevents/documented-extensions.md similarity index 96% rename from documented-extensions.md rename to cloudevents/documented-extensions.md index 9acfaaf98..9545ceb36 100644 --- a/documented-extensions.md +++ b/cloudevents/documented-extensions.md @@ -19,7 +19,7 @@ might be changed, or removed, at any time. As such, inclusion of an attribute in this document does not need to meet the same level of maturity, or popularity, as attributes defined in the [CloudEvents specification](spec.md). To be included in this document, aside from the normal PR review process, the -attribute needs to have at least two [Voting](GOVERNANCE.md#membership) member +attribute needs to have at least two [Voting](../community/GOVERNANCE.md#membership) member organizations stating their support for its inclusion as comments in the PR. If the author of the PR is also a Voting member, then they are allowed to be one of two. diff --git a/extensions/dataref.md b/cloudevents/extensions/dataref.md similarity index 100% rename from extensions/dataref.md rename to cloudevents/extensions/dataref.md diff --git a/extensions/distributed-tracing.md b/cloudevents/extensions/distributed-tracing.md similarity index 100% rename from extensions/distributed-tracing.md rename to cloudevents/extensions/distributed-tracing.md diff --git a/extensions/partitioning.md b/cloudevents/extensions/partitioning.md similarity index 100% rename from extensions/partitioning.md rename to cloudevents/extensions/partitioning.md diff --git a/extensions/sampled-rate.md b/cloudevents/extensions/sampled-rate.md similarity index 100% rename from extensions/sampled-rate.md rename to cloudevents/extensions/sampled-rate.md diff --git a/extensions/sequence.md b/cloudevents/extensions/sequence.md similarity index 100% rename from extensions/sequence.md rename to cloudevents/extensions/sequence.md diff --git a/avro-format.md b/cloudevents/formats/avro-format.md similarity index 99% rename from avro-format.md rename to cloudevents/formats/avro-format.md index 22b8982fe..9013c7a5f 100644 --- a/avro-format.md +++ b/cloudevents/formats/avro-format.md @@ -71,7 +71,7 @@ Example: ### 2.4 Definition Users of Avro MUST use a message whose binary encoding is identical to the one -described by the [CloudEvent Avro Schema](./spec.avsc): +described by the [CloudEvent Avro Schema](../cloudevents.avsc): ```json { diff --git a/json-format.md b/cloudevents/formats/json-format.md similarity index 98% rename from json-format.md rename to cloudevents/formats/json-format.md index 064bdf998..8a0e1adc9 100644 --- a/json-format.md +++ b/cloudevents/formats/json-format.md @@ -44,7 +44,7 @@ specification defined attributes. This includes their syntax and placement within the JSON object. In particular, extensions are placed as top-level JSON properties. Extensions MUST be serialized as a top-level JSON property. There were many reasons for this design decision and they are covered in more detail -in the [Primer](primer.md#json-extensions). +in the [Primer](../primer.md#json-extensions). ### 2.1. Base Type System @@ -101,7 +101,7 @@ The following table shows exemplary attribute mappings: ### 2.4. JSONSchema Validation The CloudEvents [JSONSchema](http://json-schema.org) for the spec is located -[here](spec.json) and contains the definitions for validating events in JSON. +[here](../cloudevents.json) and contains the definitions for validating events in JSON. ## 3. Envelope diff --git a/http-webhook.md b/cloudevents/http-webhook.md similarity index 100% rename from http-webhook.md rename to cloudevents/http-webhook.md diff --git a/primer.md b/cloudevents/primer.md similarity index 98% rename from primer.md rename to cloudevents/primer.md index 367262195..1439bdb02 100644 --- a/primer.md +++ b/cloudevents/primer.md @@ -143,7 +143,7 @@ by those new to the concepts of CloudEvents. After much deliberation, the working group has come to the conclusion that routing is unnecessary in the spec: any protocol (e.g. HTTP, MQTT, XMPP, or a Pub/Sub bus) already defines semantics for routing. For example, the CloudEvents -[HTTP binding](http-protocol-binding.md) dictates headers and request body +[HTTP binding](bindings/http-protocol-binding.md) dictates headers and request body contents. CloudEvents don't need to include a destination URL in the spec to be HTTP compatible; the HTTP spec already includes one in the [Request-Line](https://tools.ietf.org/html/rfc2616#section-5.1). @@ -181,11 +181,11 @@ elements that form a layered architecture model. 2. The [extensions](./spec.md#extension-context-attributes) add use-case specific and potentially overlapping sets of extension attributes and associated rules, e.g. to support different tracing standards. -3. The event format encodings, e.g. [JSON](json-format.md), define how the +3. The event format encodings, e.g. [JSON](formats/json-format.md), define how the information model of the base specification together with the chosen extensions is encoded for mapping it to header and payload elements of an application protocol. -4. The protocol bindings, e.g. [HTTP](http-protocol-binding.md), defines how +4. The protocol bindings, e.g. [HTTP](bindings/http-protocol-binding.md), defines how the CloudEvent is bound to an application protocol's transport frame, in the case of HTTP to the HTTP message. The protocol binding does not constrain how the transport frame is used, meaning that the HTTP binding can be used @@ -292,7 +292,7 @@ Extension attributes should be kept minimal to ensure the CloudEvent can be properly serialized and transported. For example, the Event producers should consider the technical limitations that might be encountered when adding extensions to a CloudEvent. For example, the -[HTTP Binary Mode](http-protocol-binding.md#31-binary-content-mode) uses HTTP +[HTTP Binary Mode](bindings/http-protocol-binding.md#31-binary-content-mode) uses HTTP headers to transport metadata; most HTTP servers will reject requests with excessive HTTP header data, with limits as low as 8kb. Therefore, the aggregate size and number of extension attributes should be kept minimal. @@ -304,8 +304,8 @@ formally adding them to the specification. ### JSON Extensions -As mentioned in the [Attributes](json-format.md#2-attributes) section of the -[JSON Event Format for CloudEvents](json-format.md) specification, CloudEvent +As mentioned in the [Attributes](formats/json-format.md#2-attributes) section of the +[JSON Event Format for CloudEvents](formats/json-format.md) specification, CloudEvent extension attributes are serialized as siblings to the specification defined attributes - meaning, at the top-level of the JSON object. The authors of the specification spent a long time considering all options and decided that this diff --git a/proprietary-specs.md b/cloudevents/proprietary-specs.md similarity index 100% rename from proprietary-specs.md rename to cloudevents/proprietary-specs.md diff --git a/source-event-action.png b/cloudevents/source-event-action.png similarity index 100% rename from source-event-action.png rename to cloudevents/source-event-action.png diff --git a/spec.md b/cloudevents/spec.md similarity index 98% rename from spec.md rename to cloudevents/spec.md index 5d3899541..2aa70d1ee 100644 --- a/spec.md +++ b/cloudevents/spec.md @@ -32,7 +32,7 @@ provide interoperability across services, platforms and systems. Event Formats specify how to serialize a CloudEvent with certain encoding formats. Compliant CloudEvents implementations that support those encodings MUST adhere to the encoding rules specified in the respective event format. All -implementations MUST support the [JSON format](json-format.md). +implementations MUST support the [JSON format](formats/json-format.md). For more information on the history, development and design rationale behind the specification, see the [CloudEvents Primer](primer.md) document. @@ -118,7 +118,7 @@ information. #### Event Format An Event Format specifies how to serialize a CloudEvent as a sequence of bytes. -Stand-alone event formats, such as the [JSON format](json-format.md), specify +Stand-alone event formats, such as the [JSON format](formats/json-format.md), specify serialization independent of any protocol or storage medium. Protocol Bindings MAY define formats that are dependent on the protocol. @@ -329,12 +329,12 @@ on the definition of OPTIONAL. - Description: Content type of `data` value. This attribute enables `data` to carry any type of content, whereby format and encoding might differ from that of the chosen event format. For example, an event rendered using the - [JSON envelope](./json-format.md#3-envelope) format might carry an XML payload + [JSON envelope](formats/json-format.md#3-envelope) format might carry an XML payload in `data`, and the consumer is informed by this attribute being set to "application/xml". The rules for how `data` content is rendered for different `datacontenttype` values are defined in the event format specifications; for example, the JSON event format defines the relationship in - [section 3.1](./json-format.md#31-handling-of-data). + [section 3.1](formats/json-format.md#31-handling-of-data). For some binary mode protocol bindings, this field is directly mapped to the respective protocol's content-type metadata property. Normative rules for the diff --git a/CONTRIBUTING.md b/community/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to community/CONTRIBUTING.md diff --git a/GOVERNANCE.md b/community/GOVERNANCE.md similarity index 94% rename from GOVERNANCE.md rename to community/GOVERNANCE.md index fd0f94897..3c2e87519 100644 --- a/GOVERNANCE.md +++ b/community/GOVERNANCE.md @@ -45,7 +45,7 @@ There are three categories of project membership: administrative actions on behalf of the group. For example, manage the website, github repos and moderate the meetings. Their actions should be done with the knowledge and consent of the group. They also have the ability to - merge/close PRs, but only per the group's approval. See the [OWNERS](OWNERS) + merge/close PRs, but only per the group's approval. See the [OWNERS](../OWNERS) file for the current list of Admins. ## PRs @@ -73,7 +73,7 @@ If a vote is taken during a meeting, the follow rules will be followed: meeting, not during. - A "primary" or "alternate" member may request a leave-of-absence via an e-mail to the mailing list, or a message to the - [public slack channel](README.md#communications), prior to the absence. + [public slack channel](../README.md#communications), prior to the absence. An acceptable absence would include situations where the person is not officially working at all, such as being on vacation, taking a sabbatical or there is a public holiday. However, situations such as a scheduling conflict @@ -107,22 +107,22 @@ The specifications produced will adhere to the following: during the release cycle. Note that these rules do not apply to the -[documented extensions](documented-extensions.md). +[documented extensions](../cloudevents/documented-extensions.md). To create a new release: -- Create a PR that modifies the [README](README.md), and all specifications (ie. +- Create a PR that modifies the [README](../README.md), and all specifications (ie. \*.md files) that include a version string, to the new release version string. Make sure to remove `-wip` from all of the version strings. - Merge the PR. - Create a [new release](https://github.com/cloudevents/spec/releases/new): - Choose a "Tag version" of the form: `vX.Y`, e.g. `v0.1` - - Target should be `master`, the default value + - Target should be `main`, the default value - Release title should be the same as the Tag - `vX.Y` - Add some descriptive text, or the list of PRs that have been merged since the previous release. The git query to get the list commits since the last release is: - `git log --pretty=format:%s master...v0.1 | grep -v "Merge pull"`. + `git log --pretty=format:%s main...v0.1 | grep -v "Merge pull"`. Just replace "v0.1" with the name of the previous release. - Press `Publish release` button - Create a PR that modifies the version string in all of the files diff --git a/community/open-source.md b/community/open-source.md index 7b1efafa2..ca545b04a 100644 --- a/community/open-source.md +++ b/community/open-source.md @@ -2,8 +2,8 @@ If you have created (or know of) an open source library or product that uses CloudEvents, please include in the list below. - [CloudEvents.NET](https://github.com/aliencube/CloudEvents.NET): is a .NET - implementation of the CloudEvents [spec](../spec.md) and - [HTTP protocol binding](../http-protocol-binding.md). It has been released + implementation of the CloudEvents [spec](../cloudevents/spec.md) and + [HTTP protocol binding](../cloudevents/bindings/http-protocol-binding.md). It has been released to [nuget.org](https://www.nuget.org/packages?q=Aliencube.CloudEventsNet). It also contains some app [samples](https://github.com/aliencube/CloudEvents.NET/tree/master/sample) diff --git a/misc/Makefile b/misc/Makefile new file mode 100644 index 000000000..db2a25309 --- /dev/null +++ b/misc/Makefile @@ -0,0 +1,19 @@ +all: verify + +verify: + @echo Running href checker: + @# Use "-x" if you want to skip external links + @misc/tools/verify-links.sh -v . + @echo Running the spec phrase checker: + @misc/tools/verify-specs.sh -v + cloudevents/spec.md \ + cloudevents/documented-extensions.md \ + cloudevents/formats/json-format.md \ + cloudevnets/bindings/http-protocol-binding.md \ + cloudevents/http-webhook.md \ + cloudevents/bindings/mqtt-protocol-binding.md \ + cloudevents/bindings/nats-protocol-binding.md \ + cloudevents/bindings/kafka-protocol-binding.md \ + cloudevents/formats/avro-format.md + @echo Running the doc phrase checker: + @misc/tools/verify-docs.sh -v . diff --git a/artwork/README.md b/misc/artwork/README.md similarity index 100% rename from artwork/README.md rename to misc/artwork/README.md diff --git a/roadmap.md b/misc/roadmap.md similarity index 95% rename from roadmap.md rename to misc/roadmap.md index e3e0f9e7a..30c99d864 100644 --- a/roadmap.md +++ b/misc/roadmap.md @@ -29,16 +29,16 @@ _0.1_ - Completed - 2018/04/20 1. Have at least 2 implementations of the specification that can demonstrate interoperability. 1. Include a specification for mapping the CloudEvents specification to - [HTTP](http-protocol-binding.md). + [HTTP](../cloudevents/bindings/http-protocol-binding.md). 1. Include a specification for mapping the CloudEvents specification to - [JSON](json-format.md). + [JSON](../cloudevents/formats/json-format.md). 1. Changes to the spec to facilitate adoption. 1. Publicize at conferences ([CloudNativeCon Europe](https://events.linuxfoundation.org/events/kubecon-cloudnativecon-north-america-2018/)). 1. Interoperability demo. 1. At least one open source implementation of sending and receiving events, see - [community open source](https://github.com/cloudevents/spec/blob/master/community/open-source.md). + [community open source](https://github.com/cloudevents/spec/blob/main/community/open-source.md). 1. Events are sent by code written by Developer1 and received by code written by Developer2, where Developer1 has no knowledge of Developer2. diff --git a/share/2018-02-22-CloudEvents-Routing.pptx b/misc/share/2018-02-22-CloudEvents-Routing.pptx similarity index 100% rename from share/2018-02-22-CloudEvents-Routing.pptx rename to misc/share/2018-02-22-CloudEvents-Routing.pptx diff --git a/share/2018-02-22-CloudEvents.pdf b/misc/share/2018-02-22-CloudEvents.pdf similarity index 100% rename from share/2018-02-22-CloudEvents.pdf rename to misc/share/2018-02-22-CloudEvents.pdf diff --git a/share/2018-03-22-TopicsAndSubjects.pptx b/misc/share/2018-03-22-TopicsAndSubjects.pptx similarity index 100% rename from share/2018-03-22-TopicsAndSubjects.pptx rename to misc/share/2018-03-22-TopicsAndSubjects.pptx diff --git a/share/2018-11-14-KubeCon-Intro-DeepDive.pdf b/misc/share/2018-11-14-KubeCon-Intro-DeepDive.pdf similarity index 100% rename from share/2018-11-14-KubeCon-Intro-DeepDive.pdf rename to misc/share/2018-11-14-KubeCon-Intro-DeepDive.pdf diff --git a/share/README.md b/misc/share/README.md similarity index 100% rename from share/README.md rename to misc/share/README.md diff --git a/tools/verify-docs.sh b/misc/tools/verify-docs.sh similarity index 100% rename from tools/verify-docs.sh rename to misc/tools/verify-docs.sh diff --git a/tools/verify-links.sh b/misc/tools/verify-links.sh similarity index 100% rename from tools/verify-links.sh rename to misc/tools/verify-links.sh diff --git a/tools/verify-specs.sh b/misc/tools/verify-specs.sh similarity index 100% rename from tools/verify-specs.sh rename to misc/tools/verify-specs.sh