From d69a6fb179ef4a699cee7923df776fa8c54521ee Mon Sep 17 00:00:00 2001 From: Lionel Villard Date: Wed, 18 Mar 2020 17:45:05 -0400 Subject: [PATCH] link to each channel documentation instead of the code (#2249) --- docs/eventing/channels/channels-crds.md | 6 +++--- docs/eventing/channels/channels.yaml | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/eventing/channels/channels-crds.md b/docs/eventing/channels/channels-crds.md index 04fdbddd1..7bddc16b4 100644 --- a/docs/eventing/channels/channels-crds.md +++ b/docs/eventing/channels/channels-crds.md @@ -27,8 +27,8 @@ Notes: Name | Status | Support | Description --- | --- | --- | --- [GCP PubSub](https://github.com/google/knative-gcp) | Proof of Concept | None | Channels are backed by [GCP PubSub](https://cloud.google.com/pubsub/). -[InMemoryChannel](https://github.com/knative/eventing/tree/{{< branch >}}/config/channels/in-memory-channel) | Proof of Concept | None | In-memory channels are a best effort Channel. They should NOT be used in Production. They are useful for development. -[KafkaChannel](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/kafka/channel/config) | Proof of Concept | None | Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. -[NatssChannel](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/natss/config) | Proof of Concept | None | Channels are backed by [NATS Streaming](https://github.com/nats-io/nats-streaming-server#configuring). +[InMemoryChannel](https://github.com/knative/eventing/tree/{{< branch >}}/config/channels/in-memory-channel/README.md) | Proof of Concept | None | In-memory channels are a best effort Channel. They should NOT be used in Production. They are useful for development. +[KafkaChannel](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/kafka/channel/README.md) | Proof of Concept | None | Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. +[NatssChannel](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/natss/config/README.md) | Proof of Concept | None | Channels are backed by [NATS Streaming](https://github.com/nats-io/nats-streaming-server#configuring). diff --git a/docs/eventing/channels/channels.yaml b/docs/eventing/channels/channels.yaml index bf92ac504..4f199272c 100644 --- a/docs/eventing/channels/channels.yaml +++ b/docs/eventing/channels/channels.yaml @@ -1,19 +1,19 @@ -# List of available Channel implementation for persistence of the events associated with a given channel +# List of available Channel implementation for persistence of the events associated with a given channel channels: - name: InMemoryChannel - url: https://github.com/knative/eventing/tree/{{< branch >}}/config/channels/in-memory-channel + url: https://github.com/knative/eventing/tree/{{< branch >}}/config/channels/in-memory-channel/README.md status: Proof of Concept support: None description: > In-memory channels are a best effort Channel. They should NOT be used in Production. They are useful for development. - name: KafkaChannel - url: https://github.com/knative/eventing-contrib/tree/{{< branch >}}/kafka/channel/config + url: https://github.com/knative/eventing-contrib/tree/{{< branch >}}/kafka/channel/README.md status: Proof of Concept support: None description: > Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. - name: NatssChannel - url: https://github.com/knative/eventing-contrib/tree/{{< branch >}}/natss/config + url: https://github.com/knative/eventing-contrib/tree/{{< branch >}}/natss/config/README.md status: Proof of Concept support: None description: >