Skip to content

Commit d46de88

Browse files
RichieEscarezknative-prow-robot
authored andcommitted
dynamically populate the correct repo branch (#1945)
1 parent 43bfc95 commit d46de88

File tree

15 files changed

+39
-36
lines changed

15 files changed

+39
-36
lines changed

docs/eventing/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ Knative Serving application so that they can be consumed.
307307
certificate.
308308

309309
See the
310-
[Kafka Source](https://github.com/knative/eventing-contrib/tree/master/kafka/source)
310+
[Kafka Source](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/kafka/source)
311311
example.
312312

313313
### CamelSource
@@ -337,7 +337,7 @@ to be installed into the current namespace.
337337
development purposes.
338338

339339
See the
340-
[CamelSource](https://github.com/knative/eventing-contrib/tree/master/camel/source/samples)
340+
[CamelSource](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/camel/source/samples)
341341
example.
342342

343343
## Getting Started

docs/eventing/broker-trigger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ to that `Broker`. If `spec.channelTemplateSpec` is not specified, then the
9090

9191
Have a `Channel` CRD installed and set as the default channel for the namespace
9292
you are interested in. For development, the
93-
[InMemoryChannel](https://github.com/knative/eventing/tree/master/config/channels/in-memory-channel)
93+
[InMemoryChannel](https://github.com/knative/eventing/tree/{{< branch >}}/config/channels/in-memory-channel)
9494
is normally used.
9595

9696
#### Changing

docs/eventing/channels/channels-crds.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Notes:
2727
Name | Status | Support | Description
2828
--- | --- | --- | ---
2929
[GCP PubSub](https://github.com/google/knative-gcp) | Proof of Concept | None | Channels are backed by [GCP PubSub](https://cloud.google.com/pubsub/).
30-
[InMemoryChannel](https://github.com/knative/eventing/tree/master/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.
31-
[KafkaChannel](https://github.com/knative/eventing-contrib/tree/master/kafka/channel/config) | Proof of Concept | None | Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics.
32-
[NatssChannel](https://github.com/knative/eventing/tree/master/contrib/natss/config) | Proof of Concept | None | Channels are backed by [NATS Streaming](https://github.com/nats-io/nats-streaming-server#configuring).
30+
[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.
31+
[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.
32+
[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).
3333

3434

docs/eventing/channels/channels.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# List of available Channel implementation for persistence of the events associated with a given channel
22
channels:
33
- name: InMemoryChannel
4-
url: https://github.com/knative/eventing/tree/master/config/channels/in-memory-channel
4+
url: https://github.com/knative/eventing/tree/{{< branch >}}/config/channels/in-memory-channel
55
status: Proof of Concept
66
support: None
77
description: >
88
In-memory channels are a best effort Channel. They should NOT be used in Production. They are useful for development.
99
- name: KafkaChannel
10-
url: https://github.com/knative/eventing-contrib/tree/master/kafka/channel/config
10+
url: https://github.com/knative/eventing-contrib/tree/{{< branch >}}/kafka/channel/config
1111
status: Proof of Concept
1212
support: None
1313
description: >
1414
Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics.
1515
- name: NatssChannel
16-
url: https://github.com/knative/eventing/tree/master/contrib/natss/config
16+
url: https://github.com/knative/eventing-contrib/tree/{{< branch >}}/natss/config
1717
status: Proof of Concept
1818
support: None
1919
description: >

docs/eventing/debugging/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ This should return a single Pod, which if you inspect is the one generated by
144144
##### `chan`
145145

146146
`chan` uses the
147-
[`in-memory-channel`]( https://github.com/knative/eventing/tree/master/config/channels/in-memory-channel).
147+
[`in-memory-channel`]( https://github.com/knative/eventing/tree/{{< branch >}}/config/channels/in-memory-channel).
148148
This is a very basic channel and has few
149149
failure modes that will be exhibited in `chan`'s `status`.
150150

docs/eventing/event-registry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ the next topic: How do we actually populate the registry in the first place?
258258

259259
If you are interested in more information regarding configuration options of a
260260
KafkaSource, please refer to the
261-
[KafKaSource example](https://github.com/knative/eventing-contrib/tree/master/kafka/source/samples).
261+
[KafKaSource example](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/kafka/source/samples).
262262

263263
For this discussion, the relevant information from the yaml above are the
264264
`sink` and the `topics`. We observe that the `sink` is of kind `Broker`. We

docs/eventing/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ If the `knative-eventing` namespace or the `imc-controller-*` does not exist, us
3434

3535
1. Make sure that you have a functioning Kubernetes cluster. See the [Comprehensive Install guide](../install) for more information.
3636
- Old versions of Knative Serving doesn't necessarily work well with latest Knative Eventing, so try to install the latest version of Knative Serving.
37-
- If your Kubernetes cluster comes with pre-installed Istio, make sure it has `cluster-local-gateway` [deployed](https://github.com/knative/serving/blob/master/DEVELOPMENT.md#deploy-istio). Depending on which Istio version you have, you'd need to apply the `istio-knative-extras.yaml` in the corresponding version folder at [here](https://github.com/knative/serving/tree/master/third_party).
37+
- If your Kubernetes cluster comes with pre-installed Istio, make sure it has `cluster-local-gateway` [deployed](https://github.com/knative/serving/blob/master/DEVELOPMENT.md#deploy-istio). Depending on which Istio version you have, you'd need to apply the `istio-knative-extras.yaml` in the corresponding version folder at [here](https://github.com/knative/serving/tree/{{< branch >}}/third_party).
3838
2. Install the Eventing CRDs by running the following command:
3939

4040
```sh

docs/eventing/samples/container-source/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,5 @@ event source is a sample for your reference.
175175

176176
When the container image is ready, a YAML file will be used to create a concrete
177177
ContainerSource. Use [heartbeats-source.yaml](./heartbeats-source.yaml) as a
178-
sample for reference. You can get more details about ContainerSource
179-
specification
180-
[here](https://github.com/knative/docs/tree/master/docs/eventing#containersource).
178+
sample for reference. [Learn more about the ContainerSource
179+
specification](../../../eventing#containersource).

docs/eventing/samples/kubernetes-event-source/README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,22 @@ weight: 50
55
type: "docs"
66
---
77

8-
Kubernetes Event Source example shows how to wire kubernetes cluster events for
9-
consumption by a function that has been implemented as a Knative Service. The
10-
code for the following files can be found in the
11-
[/kubernetes-event-source/](https://github.com/knative/docs/tree/master/docs/eventing/samples/kubernetes-event-source)
12-
directory.
8+
Kubernetes Event Source example shows how to wire Kubernetes cluster events for
9+
consumption by a function that has been implemented as a Knative Service.
1310

14-
## Deployment Steps
11+
## Before you begin
12+
13+
1. You must have a Knative cluster running both the Serving and Eventing components.
14+
To learn how to install the required components, see [Installing Knative](../../../install).
15+
1. You can follow the steps below to create new files, or you clone a copy from
16+
the repo by running:
1517

16-
### Prerequisites
18+
```shell
19+
git clone -b "release-0.9" https://github.com/knative/docs knative-docs
20+
cd knative-docs/docs/eventing/samples/kubernetes-event-source
21+
```
1722

18-
1. Setup [Knative Serving](../../../serving).
19-
1. Setup [Knative Eventing](../../../eventing).
23+
## Deployment Steps
2024

2125
### Broker
2226

docs/eventing/samples/writing-a-source/03-reconcile-sources.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,9 @@ string.
114114

115115
_After completing this tutorial, consider replacing the code below with existing
116116
sink resolution helpers provided by Knative: `AddressableType` from
117-
`[github.com/knative/pkg/apis/duck/v1alpha1](https://github.com/knative/pkg/tree/master/apis/duck/v1alpha1)`
117+
`[github.com/knative/pkg/apis/duck/v1alpha1](https://github.com/knative/pkg/tree/{{< branch >}}/apis/duck/v1alpha1)`
118118
and `GetSinkURI` from
119-
`[github.com/knative/eventing-contrib/pkg/controller/sinks](https://github.com/knative/eventing-contrib/tree/master/pkg/controller/sinks)`._
119+
`[github.com/knative/eventing-contrib/pkg/controller/sinks](https://github.com/knative/eventing-contrib/tree/{{< branch >}}/pkg/controller/sinks)`._
120120

121121
```go
122122
type addressableType struct {

0 commit comments

Comments
 (0)