diff --git a/docs/eventing/accessing-traces.md b/docs/eventing/accessing-traces.md index a5138ed229c..ff8f79cb0fe 100644 --- a/docs/eventing/accessing-traces.md +++ b/docs/eventing/accessing-traces.md @@ -11,7 +11,7 @@ visualize and trace your requests. ## Before you begin -You must have a Knative cluster running with the Eventing component installed. [Learn more](../install/README.md) +You must have a Knative cluster running with the Eventing component installed. [Learn more](../install/) ## Configuring tracing diff --git a/docs/eventing/channels/channel-types-defaults.md b/docs/eventing/channels/channel-types-defaults.md index f30f1e0b163..d37d1ae87c7 100644 --- a/docs/eventing/channels/channel-types-defaults.md +++ b/docs/eventing/channels/channel-types-defaults.md @@ -10,7 +10,7 @@ Knative provides the InMemoryChannel channel implementation by default. This def **NOTE:** InMemoryChannel channels should not be used in production environments. The default channel implementation is specified in the `default-ch-webhook` ConfigMap in the `knative-eventing` namespace. -For more information about modifying ConfigMaps, see [Configuring the Eventing Operator custom resource](./docs/install/configuring-eventing-cr/). +For more information about modifying ConfigMaps, see [Configuring the Eventing Operator custom resource](../../../docs/install/operator/configuring-eventing-cr). In the following example, the cluster default channel implementation is InMemoryChannel, while the namespace default channel implementation for the `example-namespace` is KafkaChannel. diff --git a/docs/eventing/debugging/index.md b/docs/eventing/debugging/index.md index 2699dfabe62..cf7b8f226e7 100644 --- a/docs/eventing/debugging/index.md +++ b/docs/eventing/debugging/index.md @@ -11,12 +11,12 @@ setup. ## Audience This document is intended for people that are familiar with the object model of -[Knative Eventing](../README.md). You don't need to be an expert, but do need to +[Knative Eventing](../). You don't need to be an expert, but do need to know roughly how things fit together. ## Prerequisites -1. Setup [Knative Eventing and an Eventing-contrib resource](../README.md). +1. Setup [Knative Eventing and an Eventing-contrib resource](../). ## Example diff --git a/docs/eventing/flows/parallel.md b/docs/eventing/flows/parallel.md index aa1a93ffd6e..91077506272 100644 --- a/docs/eventing/flows/parallel.md +++ b/docs/eventing/flows/parallel.md @@ -44,4 +44,4 @@ Parallel has three parts for the Status: ## Examples -Learn how to use Parallel by following the [examples](../samples/parallel/README.md) +Learn how to use Parallel by following the [examples](../samples/parallel/) diff --git a/docs/eventing/samples/_index.md b/docs/eventing/samples/_index.md index 1a5edfd5806..8a41bdea10d 100644 --- a/docs/eventing/samples/_index.md +++ b/docs/eventing/samples/_index.md @@ -8,6 +8,6 @@ showlandingtoc: "true" Use the following code samples to help you understand the various use cases for Knative Eventing and Event Sources. -[Learn more about Knative Eventing and Eventing Sources](../README.md). +[Learn more about Knative Eventing and Eventing Sources](../). [**See all Knative code samples**](../../samples.md) diff --git a/docs/eventing/samples/gitlab-source/index.md b/docs/eventing/samples/gitlab-source/index.md index 7fa67edc3e0..3cb33bcd33c 100644 --- a/docs/eventing/samples/gitlab-source/index.md +++ b/docs/eventing/samples/gitlab-source/index.md @@ -15,7 +15,7 @@ Knative Service. You will need: 1. An internet-accessible Kubernetes cluster with Knative Serving installed. - Follow the [installation instructions](../../../install/README.md) if you + Follow the [installation instructions](../../../install/) if you need to create one. 1. Ensure Knative Serving is [configured with a domain name](../../../serving/using-a-custom-domain.md) diff --git a/docs/eventing/samples/helloworld/_index.md b/docs/eventing/samples/helloworld/_index.md index 329afa5a118..60727434e50 100644 --- a/docs/eventing/samples/helloworld/_index.md +++ b/docs/eventing/samples/helloworld/_index.md @@ -13,13 +13,13 @@ We will deploy the app as a [Kubernetes Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) along with a [Kubernetes Service](https://kubernetes.io/docs/concepts/services-networking/service/). -However, you can also deploy the app as a [Knative Serving Service](../../../serving/README.md) +However, you can also deploy the app as a [Knative Serving Service](../../../serving/) ## Prerequisites - A Kubernetes cluster with [Knative Eventing](../../getting-started.md#installing-knative-eventing) installed. - If you decide to deploy the app as a Knative Serving Service then you will have to install - [Knative Serving](../../../install/README.md). + [Knative Serving](../../../install/). - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). diff --git a/docs/eventing/samples/helloworld/helloworld-go/_index.md b/docs/eventing/samples/helloworld/helloworld-go/_index.md index 519e1e71afd..c9918e6a749 100644 --- a/docs/eventing/samples/helloworld/helloworld-go/_index.md +++ b/docs/eventing/samples/helloworld/helloworld-go/_index.md @@ -16,7 +16,7 @@ We will deploy the app as a along with a [Kubernetes Service](https://kubernetes.io/docs/concepts/services-networking/service/). However, you can also deploy the app as a -[Knative Serving Service](../../../../serving/README.md). +[Knative Serving Service](../../../../serving/). Follow the steps below to create the sample code and then deploy the app to your cluster. You can also download a working copy of the sample, by running the @@ -280,7 +280,7 @@ application and trigger are ready, let's send a CloudEvent. ### Send CloudEvent to the Broker -We can send an http request directly to the [Broker](../../../broker/README.md) +We can send an http request directly to the [Broker](../../../broker/) with correct CloudEvent headers set. 1. Deploy a curl pod and SSH into it diff --git a/docs/eventing/samples/helloworld/helloworld-python/_index.md b/docs/eventing/samples/helloworld/helloworld-python/_index.md index 11a89102394..ca0720b8625 100644 --- a/docs/eventing/samples/helloworld/helloworld-python/_index.md +++ b/docs/eventing/samples/helloworld/helloworld-python/_index.md @@ -8,7 +8,7 @@ type: "docs" A simple web app written in Python that you can use to test knative eventing. It shows how to consume a [CloudEvent](https://cloudevents.io/) in Knative eventing, and optionally how to respond back with another CloudEvent in the http response, by adding the Cloud Eventing headers outlined in the Cloud Events standard definition. We will deploy the app as a [Kubernetes Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) along with a [Kubernetes Service](https://kubernetes.io/docs/concepts/services-networking/service/). -However, you can also deploy the app as a [Knative Serving Service](../../../../serving/README.md). +However, you can also deploy the app as a [Knative Serving Service](../../../../serving/). Follow the steps below to create the sample code and then deploy the app to your cluster. You can also download a working copy of the sample, by running the diff --git a/docs/eventing/samples/kafka/_index.md b/docs/eventing/samples/kafka/_index.md index 4702fb6d20f..1cd3bc864a6 100644 --- a/docs/eventing/samples/kafka/_index.md +++ b/docs/eventing/samples/kafka/_index.md @@ -97,6 +97,6 @@ $ ./kafka_setup.sh A number of different examples, showing the `KafkaSource`, `KafkaChannel` and `KafkaBinding` can be found here: -- [`KafkaSource` to `Service`](./source/README.md) -- [`KafkaChannel` and Broker](./channel/README.md) -- [`KafkaBinding`](./binding/README.md) +- [`KafkaSource` to `Service`](./source/) +- [`KafkaChannel` and Broker](./channel/) +- [`KafkaBinding`](./binding/) diff --git a/docs/eventing/samples/kafka/binding/index.md b/docs/eventing/samples/kafka/binding/index.md index 80ab6573e53..bf83321ea81 100644 --- a/docs/eventing/samples/kafka/binding/index.md +++ b/docs/eventing/samples/kafka/binding/index.md @@ -18,7 +18,7 @@ via Kafka Source ### Prerequisites 1. You must ensure that you meet the - [prerequisites listed in the Apache Kafka overview](../README.md). + [prerequisites listed in the Apache Kafka overview](../). 2. This feature is available from Knative Eventing 0.15+ ### Creating a `KafkaSource` source CRD diff --git a/docs/eventing/samples/kafka/channel/index.md b/docs/eventing/samples/kafka/channel/index.md index aa0d3b8cb85..db813a9e014 100644 --- a/docs/eventing/samples/kafka/channel/index.md +++ b/docs/eventing/samples/kafka/channel/index.md @@ -11,9 +11,9 @@ default channel configuration in Knative Eventing. ## Prerequisites - Ensure that you meet the - [prerequisites listed in the Apache Kafka overview](../README.md). + [prerequisites listed in the Apache Kafka overview](../). - A Kubernetes cluster with - [Knative Kafka Channel installed](../../../../install/README.md). + [Knative Kafka Channel installed](../../../../install/). ## Creating a `KafkaChannel` channel CRD diff --git a/docs/eventing/samples/kafka/source/index.md b/docs/eventing/samples/kafka/source/index.md index 34ae9f005a5..d6654261454 100644 --- a/docs/eventing/samples/kafka/source/index.md +++ b/docs/eventing/samples/kafka/source/index.md @@ -9,8 +9,8 @@ Tutorial on how to build and deploy a `KafkaSource` [Eventing source](../../../s ## Prerequisites -- Ensure that you meet the [prerequisites listed in the Apache Kafka overview](../README.md). -- A Kubernetes cluster with [Knative Kafka Source installed](../../../../install/README.md). +- Ensure that you meet the [prerequisites listed in the Apache Kafka overview](../). +- A Kubernetes cluster with [Knative Kafka Source installed](../../../../install/). ## Apache Kafka Topic (Optional) diff --git a/docs/eventing/samples/parallel/_index.md b/docs/eventing/samples/parallel/_index.md index fcc74e21f0c..4174bdf4536 100644 --- a/docs/eventing/samples/parallel/_index.md +++ b/docs/eventing/samples/parallel/_index.md @@ -17,7 +17,7 @@ All examples require: - Knative Serving All examples are using the -[default channel template](../../channels/default-channels.md). +[default channel template](../../channels/create-default-channel.md). ## Examples @@ -30,5 +30,5 @@ trivial filtering, transformation and routing of the incoming events. The examples are: -- [Parallel with multiple branches and global reply](./multiple-branches/README.md) -- [Parallel with mutually exclusive cases](./mutual-exclusivity/README.md) +- [Parallel with multiple branches and global reply](./multiple-branches/) +- [Parallel with mutually exclusive cases](./mutual-exclusivity/) diff --git a/docs/eventing/samples/parallel/multiple-branches/_index.md b/docs/eventing/samples/parallel/multiple-branches/_index.md index b8a0331afa8..6da37e5353d 100644 --- a/docs/eventing/samples/parallel/multiple-branches/_index.md +++ b/docs/eventing/samples/parallel/multiple-branches/_index.md @@ -14,7 +14,7 @@ The events produced by each branch are then sent to the `event-display` service. ## Prerequisites -Please refer to the sample overview for the [prerequisites](../README.md). +Please refer to the sample overview for the [prerequisites](../). ### Create the Knative Services diff --git a/docs/eventing/samples/parallel/mutual-exclusivity/_index.md b/docs/eventing/samples/parallel/mutual-exclusivity/_index.md index 0ee357781fb..4d20a7f7597 100644 --- a/docs/eventing/samples/parallel/mutual-exclusivity/_index.md +++ b/docs/eventing/samples/parallel/mutual-exclusivity/_index.md @@ -9,7 +9,7 @@ In this example, we are going to see how we can create a Parallel with mutually exclusive branches. This example is the same as the -[multiple branches example](../multiple-branches/README.md) except that we are +[multiple branches example](../multiple-branches/) except that we are now going to rely on the Knative [switch](https://github.com/lionelvillard/knative-functions#switch) function to provide a soft mutual exclusivity guarantee. @@ -18,7 +18,7 @@ NOTE: this example must be deployed in the default namespace. ## Prerequisites -Please refer to the sample overview for the [prerequisites](../README.md). +Please refer to the sample overview for the [prerequisites](../). ### Create the Knative Services diff --git a/docs/serving/samples/blue-green-deployment.md b/docs/serving/samples/blue-green-deployment.md index 8d035c59773..37e8ebc43ad 100644 --- a/docs/serving/samples/blue-green-deployment.md +++ b/docs/serving/samples/blue-green-deployment.md @@ -14,7 +14,7 @@ configuration. You need: -- A Kubernetes cluster with [Knative installed](../../install/README.md). +- A Kubernetes cluster with [Knative installed](../../install/). - (Optional) [A custom domain configured](../using-a-custom-domain.md) for use with Knative. diff --git a/docs/serving/samples/gitwebhook-go/index.md b/docs/serving/samples/gitwebhook-go/index.md index 03779fce5c4..ffce20ce584 100644 --- a/docs/serving/samples/gitwebhook-go/index.md +++ b/docs/serving/samples/gitwebhook-go/index.md @@ -16,7 +16,7 @@ You must meet the following requirements to run this sample: [Google Domains](https://domains.google/). - A Kubernetes cluster running with the following: - Knative Serving must be installed. For details about setting up a Knative - cluster, see the [installation guides](../../../install/README.md). + cluster, see the [installation guides](../../../install/). - Your Knative cluster must be [configured to use your custom domain](../../using-a-custom-domain.md). - You must ensure that your Knative cluster uses a static IP address: diff --git a/docs/serving/samples/grpc-ping-go/index.md b/docs/serving/samples/grpc-ping-go/index.md index ab77d2c0761..745ff7dff70 100644 --- a/docs/serving/samples/grpc-ping-go/index.md +++ b/docs/serving/samples/grpc-ping-go/index.md @@ -16,7 +16,7 @@ for production containers. ## Prerequisites -- [Install the latest version of Knative Serving](../../../install/README.md). +- [Install the latest version of Knative Serving](../../../install/). - Install [docker](https://www.docker.com/). diff --git a/docs/serving/samples/hello-world/helloworld-java-spring/README.md b/docs/serving/samples/hello-world/helloworld-java-spring/README.md index 7b81304d312..69eac6043b7 100644 --- a/docs/serving/samples/hello-world/helloworld-java-spring/README.md +++ b/docs/serving/samples/hello-world/helloworld-java-spring/README.md @@ -14,7 +14,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-java-spring ## Before you begin - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md) if you need to + [installation instructions](../../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). diff --git a/docs/serving/samples/knative-routing-go/index.md b/docs/serving/samples/knative-routing-go/index.md index 4152ebbf60f..e85aa99e7bf 100644 --- a/docs/serving/samples/knative-routing-go/index.md +++ b/docs/serving/samples/knative-routing-go/index.md @@ -20,7 +20,7 @@ the Login service. ## Prerequisites -1. A Kubernetes cluster with [Knative Serving](../../../install/README.md) +1. A Kubernetes cluster with [Knative Serving](../../../install/) installed. 2. Install [Docker](https://docs.docker.com/get-started/#prepare-your-docker-environment). diff --git a/docs/serving/samples/multi-container/index.md b/docs/serving/samples/multi-container/index.md index 898edb99625..4fffb1b30e7 100644 --- a/docs/serving/samples/multi-container/index.md +++ b/docs/serving/samples/multi-container/index.md @@ -10,7 +10,7 @@ A simple web app written in Go that you can use for multi container testing. ## Prerequisites - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../install/README.md) if you need to + [installation instructions](../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry). diff --git a/docs/serving/samples/rest-api-go/index.md b/docs/serving/samples/rest-api-go/index.md index 116f291e709..1b3e342a604 100644 --- a/docs/serving/samples/rest-api-go/index.md +++ b/docs/serving/samples/rest-api-go/index.md @@ -12,7 +12,7 @@ like `AAPL`,`AMZN`, `GOOG`, `MSFT`, etc. ## Prerequisites -1. A Kubernetes cluster with [Knative Serving](../../../install/README.md) installed +1. A Kubernetes cluster with [Knative Serving](../../../install/) installed and DNS configured. 1. [Docker](https://docs.docker.com/get-started/#prepare-your-docker-environment) installed locally. @@ -202,7 +202,7 @@ and then you run `curl` commands to send request with your stock symbol. ## Next Steps -The [traffic splitting example](../traffic-splitting/README.md) continues from +The [traffic splitting example](../traffic-splitting/) continues from here to walk you through how to create new Revisions and then use traffic splitting between those Revisions. diff --git a/docs/serving/samples/secrets-go/index.md b/docs/serving/samples/secrets-go/index.md index 31ba508d3d5..ab891ea4332 100644 --- a/docs/serving/samples/secrets-go/index.md +++ b/docs/serving/samples/secrets-go/index.md @@ -22,7 +22,7 @@ cd knative-docs/docs/serving/samples/secrets-go ## Before you begin - A Kubernetes cluster with Knative installed. Follow the - [installation instructions](../../../install/README.md) if you need to create + [installation instructions](../../../install/) if you need to create one. - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry).