knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed few broken cloudevents links in the documentation (#4445) 

* Fixed few broken cloudevents links in the documentation

* Fixed more broken CloudEvent docs links in the documentation. Updated links to CloudEvents v1.0 documentation to CloudEvents v1.0.1 documentation
This commit is contained in:
Maciej Chyczewski 2021-11-12 16:43:36 +01:00 committed by GitHub
parent 31a4740480
commit 79e4639009
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
archived/v0.23-docs/eventing/broker/index.xml generated
View File

@ -504,7 +504,7 @@ with Apache Kafka for the Knative Broker and Trigger model.</p>
<li>Control plane High Availability</li> <li>Control plane High Availability</li>
<li>Horizontally scalable data plane</li> <li>Horizontally scalable data plane</li>
<li><a href="#kafka-producer-and-consumer-configurations">Extensively configurable</a></li> <li><a href="#kafka-producer-and-consumer-configurations">Extensively configurable</a></li>
<li>Ordered delivery of events based on <a href="https://github.com/cloudevents/spec/blob/master/extensions/partitioning.md">CloudEvents partitioning extension</a></li> <li>Ordered delivery of events based on <a href="https://github.com/cloudevents/spec/blob/v1.0.1/extensions/partitioning.md">CloudEvents partitioning extension</a></li>
<li>Support any Kafka version, see <a href="https://cwiki.apache.org/confluence/display/KAFKA/Compatibility+Matrix">compatibility matrix</a></li> <li>Support any Kafka version, see <a href="https://cwiki.apache.org/confluence/display/KAFKA/Compatibility+Matrix">compatibility matrix</a></li>
</ul> </ul>
<h2 id="prerequisites">Prerequisites</h2> <h2 id="prerequisites">Prerequisites</h2>

2
archived/v0.23-docs/eventing/broker/kafka-broker/index.html generated
View File

@ -2130,7 +2130,7 @@ with Apache Kafka for the Knative Broker and Trigger model.</p>
<li>Control plane High Availability</li> <li>Control plane High Availability</li>
<li>Horizontally scalable data plane</li> <li>Horizontally scalable data plane</li>
<li><a href="#kafka-producer-and-consumer-configurations">Extensively configurable</a></li> <li><a href="#kafka-producer-and-consumer-configurations">Extensively configurable</a></li>
<li>Ordered delivery of events based on <a href="https://github.com/cloudevents/spec/blob/master/extensions/partitioning.md">CloudEvents partitioning extension</a></li> <li>Ordered delivery of events based on <a href="https://github.com/cloudevents/spec/blob/v1.0.1/extensions/partitioning.md">CloudEvents partitioning extension</a></li>
<li>Support any Kafka version, see <a href="https://cwiki.apache.org/confluence/display/KAFKA/Compatibility+Matrix">compatibility matrix</a></li> <li>Support any Kafka version, see <a href="https://cwiki.apache.org/confluence/display/KAFKA/Compatibility+Matrix">compatibility matrix</a></li>
</ul> </ul>
<h2 id="prerequisites">Prerequisites</h2> <h2 id="prerequisites">Prerequisites</h2>

4
archived/v0.23-docs/eventing/event-registry/index.html generated
View File

@ -2125,9 +2125,9 @@ type information in the cluster data store.</p>
<ol> <ol>
<li>Read about the <a href="../broker/">broker</a> and <a href="../broker/triggers/">trigger</a> objects.</li> <li>Read about the <a href="../broker/">broker</a> and <a href="../broker/triggers/">trigger</a> objects.</li>
<li>Be familiar with the <li>Be familiar with the
<a href="https://github.com/cloudevents/spec/blob/master/spec.md">CloudEvents spec</a>, <a href="https://github.com/cloudevents/spec/blob/v1.0.1/spec.md">CloudEvents spec</a>,
particularly the particularly the
<a href="https://github.com/cloudevents/spec/blob/master/spec.md#context-attributes">Context Attributes</a> <a href="https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#context-attributes">Context Attributes</a>
section.</li> section.</li>
<li>Be familiar with <a href="../sources">event sources</a>.</li> <li>Be familiar with <a href="../sources">event sources</a>.</li>
</ol> </ol>

2
archived/v0.23-docs/eventing/index.html generated
View File

@ -2146,7 +2146,7 @@ consumer.</li>
</li> </li>
<li>Ensure cross-service interoperability. Knative Eventing is consistent with <li>Ensure cross-service interoperability. Knative Eventing is consistent with
the the
<a href="https://github.com/cloudevents/spec/blob/master/spec.md#design-goals">CloudEvents</a> <a href="https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#design-goals">CloudEvents</a>
specification that is developed by the specification that is developed by the
<a href="https://lists.cncf.io/g/cncf-wg-serverless">CNCF Serverless WG</a>.</li> <a href="https://lists.cncf.io/g/cncf-wg-serverless">CNCF Serverless WG</a>.</li>
</ol> </ol>

4
archived/v0.23-docs/eventing/index.xml generated
View File

@ -741,9 +741,9 @@ type information in the cluster data store.&lt;/p&gt;
&lt;ol&gt; &lt;ol&gt;
&lt;li&gt;Read about the &lt;a href=&#34;../broker/&#34;&gt;broker&lt;/a&gt; and &lt;a href=&#34;../broker/triggers/&#34;&gt;trigger&lt;/a&gt; objects.&lt;/li&gt; &lt;li&gt;Read about the &lt;a href=&#34;../broker/&#34;&gt;broker&lt;/a&gt; and &lt;a href=&#34;../broker/triggers/&#34;&gt;trigger&lt;/a&gt; objects.&lt;/li&gt;
&lt;li&gt;Be familiar with the &lt;li&gt;Be familiar with the
&lt;a href=&#34;https://github.com/cloudevents/spec/blob/master/spec.md&#34;&gt;CloudEvents spec&lt;/a&gt;, &lt;a href=&#34;https://github.com/cloudevents/spec/blob/v1.0.1/spec.md&#34;&gt;CloudEvents spec&lt;/a&gt;,
particularly the particularly the
&lt;a href=&#34;https://github.com/cloudevents/spec/blob/master/spec.md#context-attributes&#34;&gt;Context Attributes&lt;/a&gt; &lt;a href=&#34;https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#context-attributes&#34;&gt;Context Attributes&lt;/a&gt;
section.&lt;/li&gt; section.&lt;/li&gt;
&lt;li&gt;Be familiar with &lt;a href=&#34;../sources&#34;&gt;event sources&lt;/a&gt;.&lt;/li&gt; &lt;li&gt;Be familiar with &lt;a href=&#34;../sources&#34;&gt;event sources&lt;/a&gt;.&lt;/li&gt;
&lt;/ol&gt; &lt;/ol&gt;

2
archived/v0.23-docs/eventing/samples/container-source/index.html generated
View File

@ -2237,7 +2237,7 @@ variables.</li>
<code>K_SINK</code> and <code>K_CE_OVERRIDES</code>, resolved from <code>spec.sink</code> and <code>spec.ceOverrides</code> respectively.</li> <code>K_SINK</code> and <code>K_CE_OVERRIDES</code>, resolved from <code>spec.sink</code> and <code>spec.ceOverrides</code> respectively.</li>
<li>The event messages shall be sent to the sink URI specified in <code>K_SINK</code>. The message can be any <li>The event messages shall be sent to the sink URI specified in <code>K_SINK</code>. The message can be any
format. format.
<a href="https://github.com/cloudevents/spec/blob/master/spec.md#design-goals">CloudEvents</a> <a href="https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#design-goals">CloudEvents</a>
format is recommended.</li> format is recommended.</li>
</ul> </ul>
<p><a href="https://github.com/knative/eventing/blob/main/cmd/heartbeats/main.go">heartbeats</a> <p><a href="https://github.com/knative/eventing/blob/main/cmd/heartbeats/main.go">heartbeats</a>

2
archived/v0.23-docs/eventing/samples/index.xml generated
View File

@ -232,7 +232,7 @@ variables.&lt;/li&gt;
&lt;code&gt;K_SINK&lt;/code&gt; and &lt;code&gt;K_CE_OVERRIDES&lt;/code&gt;, resolved from &lt;code&gt;spec.sink&lt;/code&gt; and &lt;code&gt;spec.ceOverrides&lt;/code&gt; respectively.&lt;/li&gt; &lt;code&gt;K_SINK&lt;/code&gt; and &lt;code&gt;K_CE_OVERRIDES&lt;/code&gt;, resolved from &lt;code&gt;spec.sink&lt;/code&gt; and &lt;code&gt;spec.ceOverrides&lt;/code&gt; respectively.&lt;/li&gt;
&lt;li&gt;The event messages shall be sent to the sink URI specified in &lt;code&gt;K_SINK&lt;/code&gt;. The message can be any &lt;li&gt;The event messages shall be sent to the sink URI specified in &lt;code&gt;K_SINK&lt;/code&gt;. The message can be any
format. format.
&lt;a href=&#34;https://github.com/cloudevents/spec/blob/master/spec.md#design-goals&#34;&gt;CloudEvents&lt;/a&gt; &lt;a href=&#34;https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#design-goals&#34;&gt;CloudEvents&lt;/a&gt;
format is recommended.&lt;/li&gt; format is recommended.&lt;/li&gt;
&lt;/ul&gt; &lt;/ul&gt;
&lt;p&gt;&lt;a href=&#34;https://github.com/knative/eventing/blob/main/cmd/heartbeats/main.go&#34;&gt;heartbeats&lt;/a&gt; &lt;p&gt;&lt;a href=&#34;https://github.com/knative/eventing/blob/main/cmd/heartbeats/main.go&#34;&gt;heartbeats&lt;/a&gt;

2
archived/v0.23-docs/eventing/samples/writing-event-source/index.xml generated
View File

@ -45,7 +45,7 @@
&lt;/ul&gt; &lt;/ul&gt;
&lt;h1 id=&#34;theory&#34;&gt;Theory&lt;/h1&gt; &lt;h1 id=&#34;theory&#34;&gt;Theory&lt;/h1&gt;
&lt;p&gt;Quick Introduction to Knative Eventing Sources &lt;p&gt;Quick Introduction to Knative Eventing Sources
A Knative Source is Kubernetes Custom Resource that generates or imports an event and pushes that event to another endpoint on the cluster via a &lt;a href=&#34;https://github.com/cloudevents/spec/blob/v1.0/primer.md&#34;&gt;CloudEvents&lt;/a&gt;.&lt;/p&gt; A Knative Source is Kubernetes Custom Resource that generates or imports an event and pushes that event to another endpoint on the cluster via a &lt;a href=&#34;https://github.com/cloudevents/spec/blob/v1.0.1/primer.md&#34;&gt;CloudEvents&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;a href=&#34;https://github.com/knative/eventing/blob/master/docs/spec/sources.md&#34;&gt;The specification&lt;/a&gt; &lt;p&gt;&lt;a href=&#34;https://github.com/knative/eventing/blob/master/docs/spec/sources.md&#34;&gt;The specification&lt;/a&gt;
for Knative Eventing Sources contains a number of requirements that for Knative Eventing Sources contains a number of requirements that
together define a well-behaved Knative Source.&lt;/p&gt; together define a well-behaved Knative Source.&lt;/p&gt;

2
archived/v0.23-docs/eventing/sources/creating-event-sources/writing-event-source/01-theory/index.html generated
View File

@ -2166,7 +2166,7 @@ if (!doNotTrack) {
</ul> </ul>
<h1 id="theory">Theory</h1> <h1 id="theory">Theory</h1>
<p>Quick Introduction to Knative Eventing Sources <p>Quick Introduction to Knative Eventing Sources
A Knative Source is Kubernetes Custom Resource that generates or imports an event and pushes that event to another endpoint on the cluster via a <a href="https://github.com/cloudevents/spec/blob/v1.0/primer.md">CloudEvents</a>.</p> A Knative Source is Kubernetes Custom Resource that generates or imports an event and pushes that event to another endpoint on the cluster via a <a href="https://github.com/cloudevents/spec/blob/v1.0.1/primer.md">CloudEvents</a>.</p>
<p><a href="https://github.com/knative/eventing/blob/main/docs/spec/sources.md">The specification</a> <p><a href="https://github.com/knative/eventing/blob/main/docs/spec/sources.md">The specification</a>
for Knative Eventing Sources contains a number of requirements that for Knative Eventing Sources contains a number of requirements that
together define a well-behaved Knative Source.</p> together define a well-behaved Knative Source.</p>

2
archived/v0.23-docs/eventing/sources/creating-event-sources/writing-event-source/index.xml generated
View File

@ -45,7 +45,7 @@
&lt;/ul&gt; &lt;/ul&gt;
&lt;h1 id=&#34;theory&#34;&gt;Theory&lt;/h1&gt; &lt;h1 id=&#34;theory&#34;&gt;Theory&lt;/h1&gt;
&lt;p&gt;Quick Introduction to Knative Eventing Sources &lt;p&gt;Quick Introduction to Knative Eventing Sources
A Knative Source is Kubernetes Custom Resource that generates or imports an event and pushes that event to another endpoint on the cluster via a &lt;a href=&#34;https://github.com/cloudevents/spec/blob/v1.0/primer.md&#34;&gt;CloudEvents&lt;/a&gt;.&lt;/p&gt; A Knative Source is Kubernetes Custom Resource that generates or imports an event and pushes that event to another endpoint on the cluster via a &lt;a href=&#34;https://github.com/cloudevents/spec/blob/v1.0.1/primer.md&#34;&gt;CloudEvents&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;a href=&#34;https://github.com/knative/eventing/blob/main/docs/spec/sources.md&#34;&gt;The specification&lt;/a&gt; &lt;p&gt;&lt;a href=&#34;https://github.com/knative/eventing/blob/main/docs/spec/sources.md&#34;&gt;The specification&lt;/a&gt;
for Knative Eventing Sources contains a number of requirements that for Knative Eventing Sources contains a number of requirements that
together define a well-behaved Knative Source.&lt;/p&gt; together define a well-behaved Knative Source.&lt;/p&gt;

2
docs/eventing/broker/kafka-broker/README.md
View File

@ -9,7 +9,7 @@ Notable features are:
- Control plane High Availability - Control plane High Availability
- Horizontally scalable data plane - Horizontally scalable data plane
- [Extensively configurable](#kafka-producer-and-consumer-configurations) - [Extensively configurable](#kafka-producer-and-consumer-configurations)
- Ordered delivery of events based on [CloudEvents partitioning extension](https://github.com/cloudevents/spec/blob/master/extensions/partitioning.md) - Ordered delivery of events based on [CloudEvents partitioning extension](https://github.com/cloudevents/spec/blob/v1.0.1/extensions/partitioning.md)
- Support any Kafka version, see [compatibility matrix](https://cwiki.apache.org/confluence/display/KAFKA/Compatibility+Matrix) - Support any Kafka version, see [compatibility matrix](https://cwiki.apache.org/confluence/display/KAFKA/Compatibility+Matrix)
## Prerequisites ## Prerequisites

8
docs/eventing/event-registry.md
View File

@ -14,9 +14,9 @@ It's recommended that you have a basic understanding of the following:
- [Brokers](broker/README.md) - [Brokers](broker/README.md)
- [Triggers](broker/triggers/README.md) - [Triggers](broker/triggers/README.md)
- The [CloudEvents spec](https://github.com/cloudevents/spec/blob/master/spec.md), - The [CloudEvents spec](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md),
particularly the particularly the
[Context Attributes](https://github.com/cloudevents/spec/blob/master/spec.md#context-attributes) [Context Attributes](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#context-attributes)
section section
- [Event sources](sources/README.md) - [Event sources](sources/README.md)
@ -71,8 +71,8 @@ EventType objects:
| Field | Description | Required or optional | | Field | Description | Required or optional |
|-------|-------------|----------------------| |-------|-------------|----------------------|
| `spec.type` | Refers to the [CloudEvent type](https://github.com/cloudevents/spec/blob/master/spec.md#type) as it enters into the event mesh. Event consumers can create Triggers filtering on this attribute. This field is authoritative. | Required | | `spec.type` | Refers to the [CloudEvent type](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#type) as it enters into the event mesh. Event consumers can create Triggers filtering on this attribute. This field is authoritative. | Required |
| `spec.source` | Refers to the [CloudEvent source](https://github.com/cloudevents/spec/blob/master/spec.md#source-1) as it enters into the event mesh. Event consumers can create Triggers filtering on this attribute. | Required | | `spec.source` | Refers to the [CloudEvent source](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#source-1) as it enters into the event mesh. Event consumers can create Triggers filtering on this attribute. | Required |
| `spec.schema` | A valid URI with the EventType schema such as a JSON schema or a protobuf schema. | Optional | | `spec.schema` | A valid URI with the EventType schema such as a JSON schema or a protobuf schema. | Optional |
| `spec.description` | A string describing what the EventType is about. | Optional | | `spec.description` | A string describing what the EventType is about. | Optional |
| `spec.broker` | Refers to the Broker that can provide the EventType. | Required | | `spec.broker` | Refers to the Broker that can provide the EventType. | Required |

6
docs/eventing/sinks/kafka-sink.md
View File

@ -89,9 +89,9 @@ spec:
# default: structured. # default: structured.
# #
# CloudEvent spec references: # CloudEvent spec references:
# - https://github.com/cloudevents/spec/blob/v1.0/spec.md#message # - https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#message
# - https://github.com/cloudevents/spec/blob/v1.0/kafka-protocol-binding.md#33-structured-content-mode # - https://github.com/cloudevents/spec/blob/v1.0.1/kafka-protocol-binding.md#33-structured-content-mode
# - https://github.com/cloudevents/spec/blob/v1.0/kafka-protocol-binding.md#32-binary-content-mode # - https://github.com/cloudevents/spec/blob/v1.0.1/kafka-protocol-binding.md#32-binary-content-mode
contentMode: binary # or structured contentMode: binary # or structured
``` ```

2
docs/getting-started/first-broker.md
View File

@ -17,7 +17,7 @@ Let's take a look at how these components interact:
### CloudEvents ### CloudEvents
Knative Eventing uses Knative Eventing uses
[CloudEvents](https://github.com/cloudevents/spec/blob/master/primer.md){target=blank_} to send [CloudEvents](https://github.com/cloudevents/spec/blob/v1.0.1/primer.md){target=blank_} to send
information back and forth between your Services and these components. information back and forth between your Services and these components.
??? question "What are CloudEvents?" ??? question "What are CloudEvents?"

4
vendor/github.com/cloudevents/sdk-go/v2/binding/encoding.go generated vendored
View File

@ -6,9 +6,9 @@ import "errors"
type Encoding int type Encoding int
const ( const (
// Binary encoding as specified in https://github.com/cloudevents/spec/blob/master/spec.md#message // Binary encoding as specified in https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#message
EncodingBinary Encoding = iota EncodingBinary Encoding = iota
// Structured encoding as specified in https://github.com/cloudevents/spec/blob/master/spec.md#message // Structured encoding as specified in https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#message
EncodingStructured EncodingStructured
// Message is an instance of EventMessage or it contains EventMessage nested (through MessageWrapper) // Message is an instance of EventMessage or it contains EventMessage nested (through MessageWrapper)
EncodingEvent EncodingEvent

2
vendor/github.com/cloudevents/sdk-go/v2/event/eventcontext_v03.go generated vendored
View File

@ -157,7 +157,7 @@ func (ec EventContextV03) AsV1() *EventContextV1 {
} }
// Validate returns errors based on requirements from the CloudEvents spec. // Validate returns errors based on requirements from the CloudEvents spec.
// For more details, see https://github.com/cloudevents/spec/blob/master/spec.md // For more details, see https://github.com/cloudevents/spec/blob/v1.0.1/spec.md
// As of Feb 26, 2019, commit 17c32ea26baf7714ad027d9917d03d2fff79fc7e // As of Feb 26, 2019, commit 17c32ea26baf7714ad027d9917d03d2fff79fc7e
// + https://github.com/cloudevents/spec/pull/387 -> datacontentencoding // + https://github.com/cloudevents/spec/pull/387 -> datacontentencoding
// + https://github.com/cloudevents/spec/pull/406 -> subject // + https://github.com/cloudevents/spec/pull/406 -> subject

2
vendor/github.com/cloudevents/sdk-go/v2/event/eventcontext_v1.go generated vendored
View File

@ -163,7 +163,7 @@ func (ec EventContextV1) AsV1() *EventContextV1 {
} }
// Validate returns errors based on requirements from the CloudEvents spec. // Validate returns errors based on requirements from the CloudEvents spec.
// For more details, see https://github.com/cloudevents/spec/blob/v1.0/spec.md. // For more details, see https://github.com/cloudevents/spec/blob/v1.0.1/spec.md.
func (ec EventContextV1) Validate() ValidationError { func (ec EventContextV1) Validate() ValidationError {
errors := map[string]error{} errors := map[string]error{}

2
vendor/github.com/cloudevents/sdk-go/v2/protocol/http/protocol.go generated vendored
View File

@ -37,7 +37,7 @@ type Protocol struct {
// OptionsHandlerFn handles the OPTIONS method requests and is intended to // OptionsHandlerFn handles the OPTIONS method requests and is intended to
// implement the abuse protection spec: // implement the abuse protection spec:
// https://github.com/cloudevents/spec/blob/v1.0/http-webhook.md#4-abuse-protection // https://github.com/cloudevents/spec/blob/v1.0.1/http-webhook.md#4-abuse-protection
OptionsHandlerFn http.HandlerFunc OptionsHandlerFn http.HandlerFunc
WebhookConfig *WebhookConfig WebhookConfig *WebhookConfig