From 63c6a0a672bc06eaf3d2900106e82a18d862455b Mon Sep 17 00:00:00 2001 From: Doug Davis Date: Fri, 4 Dec 2020 15:27:52 -0500 Subject: [PATCH] typos/cleanup in prep for v1.0.1 (#737) * typos/cleanup Signed-off-by: Doug Davis * more rfc Signed-off-by: Doug Davis --- Makefile | 19 +++++++++++++++---- README.md | 5 +---- SDK.md | 1 + amqp-protocol-binding.md | 2 +- community/SDK-GOVERNANCE.md | 14 +++++++------- protobuf-format.md | 14 +++++++------- websockets-protocol-binding.md | 2 +- 7 files changed, 33 insertions(+), 24 deletions(-) diff --git a/Makefile b/Makefile index 5fc0a9ec3..24638213a 100644 --- a/Makefile +++ b/Makefile @@ -5,11 +5,22 @@ verify: @# Use "-x" if you want to skip external links @tools/verify-links.sh -t -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 \ + @tools/verify-specs.sh -v \ + amqp-protocol-binding.md \ + avro-format.md \ + documented-extensions.md \ + http-protocol-binding.md \ + http-webhook.md \ + json-format.md \ + kafka-protocol-binding.md \ + mqtt-protocol-binding.md \ + nats-protocol-binding.md \ + protobuf-format.md \ + spec.md \ + websockets-protocol-binding.md \ \ discovery.md \ - subscriptions-api.md + pagination.md \ + subscriptions-api.md @echo Running the doc phrase checker: @tools/verify-docs.sh -v . diff --git a/README.md b/README.md index 0b95b1a48..cd6d83aaa 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ The following documents are available: | 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) | | WebSockets Protocol Binding | - | [master](https://github.com/cloudevents/spec/blob/master/websockets-protocol-binding.md) | -| Protobuf Event Format | | [master][proto-working] | +| Protobuf Event Format | | [master](https://github.com/cloudevents/spec/blob/master/protobuf-format.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) | | | | **Additional Documentation:** | @@ -134,6 +134,3 @@ Periodically, the group may have in-person meetings that coincide with a major conference. Please see the [meeting minutes doc](https://docs.google.com/document/d/1OVF68rpuPK5shIHILK9JOqlZBbfe91RNzQ7u_P7YCDE/edit#) for any future plans. - -[proto-working]: ./protobuf-format.md -[proto-latest]: ./protobuf-format.md diff --git a/SDK.md b/SDK.md index 51b49709d..53085ced9 100644 --- a/SDK.md +++ b/SDK.md @@ -10,6 +10,7 @@ following SDKs: - [Go SDK](https://github.com/cloudevents/sdk-go) - [Java SDK](https://github.com/cloudevents/sdk-java) - [JavaScript SDK](https://github.com/cloudevents/sdk-javascript) +- [PHP SDK](https://github.com/cloudevents/sdk-php) - [Python SDK](https://github.com/cloudevents/sdk-python) - [Ruby SDK](https://github.com/cloudevents/sdk-ruby) - [Rust SDK](https://github.com/cloudevents/sdk-rust) diff --git a/amqp-protocol-binding.md b/amqp-protocol-binding.md index 52d1bf137..493470310 100644 --- a/amqp-protocol-binding.md +++ b/amqp-protocol-binding.md @@ -173,7 +173,7 @@ time of the submission or revision. ##### 3.1.3.1 AMQP Application Property Names -Cloud Event attributes are prefixed with "cloudEvents:" for use in the +CloudEvent attributes are prefixed with "cloudEvents:" for use in the [application-properties][app-properties] section. Examples: diff --git a/community/SDK-GOVERNANCE.md b/community/SDK-GOVERNANCE.md index 770bdc03c..e56461820 100644 --- a/community/SDK-GOVERNANCE.md +++ b/community/SDK-GOVERNANCE.md @@ -29,9 +29,9 @@ projects. The purpose of these requirements are to demonstrate the person's expertise and regular commitment to the project - not simply to achieve a certain level of activity. -Each sdk project MAY define in the `CONTRIBUTING.md` (available at the root of -the Github Repository) stricter requirements, in order to meet the community -demands, e.g. _we require that the contributor submitted at least 20 PRs_. +Each sdk project may define in their `CONTRIBUTING.md` file stricter +requirements, in order to meet the community demands, e.g. _we require that +the contributor submitted at least 20 PRs_. If a contributor does not meet these criteria, they should not be considered for approval as a maintainer of the project, **unless** the situation defined in @@ -80,7 +80,7 @@ discussions". However, if the SDK is stable and does not need to be update then it might be determined that it current state is acceptable. To prevent the project from becoming _not actively maintained_, the community -MAY takes the following actions: +may takes the following actions: - Temporary security patches delivered by an _sdk maintainer_ not part of `sdk-x-maintainers` group @@ -108,7 +108,7 @@ enhancements. ### Handover to a new maintainer/group of maintainers -If a project is not meeting the criteria 1, 2, 4, 5, 6, 7, the community MAY +If a project is not meeting the criteria 1, 2, 4, 5, 6, 7, the community may decides to handover the project to a new maintainer/group of maintainers. The community can perform the handover to a new maintainer if all the following conditions are met: @@ -140,8 +140,8 @@ The voting criteria are: ### Archive a project -If a project is not following the criteria 1, 2, 4, 5, 6, 7, the community MAY -decides to archive the project. Prior to archiving, the community SHOULD first +If a project is not following the criteria 1, 2, 4, 5, 6, 7, the community may +decides to archive the project. Prior to archiving, the community should first consider performing a search for a new maintainer to [handover the project](#handover-to-a-new-maintainergroup-of-maintainers). diff --git a/protobuf-format.md b/protobuf-format.md index c6423391b..09a794dfb 100644 --- a/protobuf-format.md +++ b/protobuf-format.md @@ -64,13 +64,13 @@ The CloudEvents type system is mapped to protobuf as follows : | URI-reference | [string][proto-scalars] following [RFC 3986 ยง4.1][rfc3986-section41] | | Timestamp | [Timestamp][proto-timestamp] | -## 2.3 Required Attributes +## 2.3 REQUIRED Attributes -Required attributes are represented explicitly as protobuf fields. +REQUIRED attributes are represented explicitly as protobuf fields. -## 2.4 Optional Attributes & Extensions +## 2.4 OPTIONAL Attributes & Extensions -Optional and extension attributes are represented using a map construct enabling +OPTIONAL and extension attributes are represented using a map construct enabling direct support of the CloudEvent [type system][ce-types]. ```proto @@ -150,7 +150,7 @@ public static CloudEvent plainTextExample() { CloudEvent.Builder ceBuilder = CloudEvent.newBuilder(); ceBuilder - //-- Required Attributes. + //-- REQUIRED Attributes. .setId(UUID.randomUUID().toString()) .setSpecVersion("1.0") .setType("io.cloudevent.example") @@ -159,7 +159,7 @@ public static CloudEvent plainTextExample() { //-- Data. .setTextData("This is a plain text message"); - //-- Optional Attributes + //-- OPTIONAL Attributes withCurrentTime(ceBuilder, "time"); withAttribute(ceBuilder, "datacontenttype", "text/plain"); @@ -199,7 +199,7 @@ private static Spec.CloudEvent protoExample() { // Add the protto type URL withAttribute(ceBuilder, "dataschema", ceBuilder.getProtoData().getTypeUrl()); - // Set Content-Type (Optional) + // Set Content-Type (OPTIONAL) withAttribute(ceBuilder, "datacontenttype", "application/protobuf"); //-- Done. diff --git a/websockets-protocol-binding.md b/websockets-protocol-binding.md index 98537a8a2..cff498b01 100644 --- a/websockets-protocol-binding.md +++ b/websockets-protocol-binding.md @@ -81,7 +81,7 @@ subprotocols the client supports. The server MUST reply with the chosen CloudEvents subprotocol using the `Sec-WebSocket-Protocol` header. If the server doesn't support any of the -subprotocols included in the opening handshake, the server response should not +subprotocols included in the opening handshake, the server response SHOULD NOT contain any `Sec-WebSocket-Protocol` header. #### 1.4.1 Example