Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions community/samples/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ something isn't working, lend a helping hand and fix it in a PR.

[Learn more about the lifespan of samples](https://github.com/knative/docs/tree/main/CONTRIBUTING.md#user-focused-content)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a relative link?


[**See all Knative code samples**](../../docs/samples.md)
[**See all Knative code samples**](../../docs/samples)

### Interactive serving sample

Expand All @@ -30,7 +30,7 @@ Knative Serving sample apps.

| Sample Name | Description | Language(s) |
| ----------- | ----------- | ----------- |
| Hello World | A quick introduction to Knative Serving that highlights how to deploy an app. | [Clojure](./serving/helloworld-clojure/README.md), [Dart](./serving/helloworld-dart/README.md), [Elixir](./serving/helloworld-elixir/README.md), [Haskell](./serving/helloworld-haskell/README.md), [Java - Micronaut](./serving/helloworld-java-micronaut/README.md), [Java - Quarkus](./serving/helloworld-java-quarkus/README.md), [R - Go Server](./serving/helloworld-r/README.md), [Rust](./serving/helloworld-rust/README.md), [Swift](./serving/helloworld-swift/README.md), [Vertx](./serving/helloworld-vertx/README.md) |
| Hello World | A quick introduction to Knative Serving that highlights how to deploy an app. | [Clojure](./serving/helloworld-clojure/), [Dart](./serving/helloworld-dart/), [Elixir](./serving/helloworld-elixir/), [Haskell](./serving/helloworld-haskell/), [Java - Micronaut](./serving/helloworld-java-micronaut/), [Java - Quarkus](./serving/helloworld-java-quarkus/), [R - Go Server](./serving/helloworld-r/), [Rust](./serving/helloworld-rust/), [Swift](./serving/helloworld-swift/), [Vertx](./serving/helloworld-vertx/) |
| Machine Learning | A quick introduction to using Knative Serving to serve machine learning models | [Python - BentoML](./serving/machinelearning-python-bentoml)

#### Eventing and Eventing Resources samples
Expand All @@ -45,4 +45,3 @@ Knative `kn` Client sample workflows and apps.
| Sample Name | Description |
| ----------- | ----------- |
| [knfun](https://github.com/maximilien/knfun) | Knative micro-functions (Twitter and Watson APIs) demo using the `kn` client. |

3 changes: 1 addition & 2 deletions community/samples/serving/helloworld-clojure/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ specified, it will use "World" as the TARGET.
## Prerequisites

- A Kubernetes cluster with Knative installed and DNS configured. Follow the
[installation instructions](../../../../docs/install/README.md) if you need to create
[installation instructions](../../../../docs/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).
Expand Down Expand Up @@ -160,4 +160,3 @@ To remove the sample app from your cluster, delete the service record:
```shell
kubectl delete --filename service.yaml
```

2 changes: 1 addition & 1 deletion community/samples/serving/helloworld-dart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ that you can use for testing. It reads in the env variable `TARGET` and prints
## Prerequisites

- A Kubernetes cluster with Knative installed and DNS configured. Follow the
[installation instructions](../../../../docs/install/README.md) if you need to create
[installation instructions](../../../../docs/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).
Expand Down
3 changes: 1 addition & 2 deletions community/samples/serving/helloworld-deno/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-deno
## Before you begin

- A Kubernetes cluster with Knative installed. Follow the
[installation instructions](../../../../docs/install/README.md) if you need to
[installation instructions](../../../../docs/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).
Expand Down Expand Up @@ -147,4 +147,3 @@ To remove the sample app from your cluster, delete the service record:
```shell
kubectl delete --filename service.yaml
```

3 changes: 1 addition & 2 deletions community/samples/serving/helloworld-haskell/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ specified, it will use "World" as the TARGET.
## Prerequisites

- A Kubernetes cluster with Knative installed and DNS configured. Follow the
[installation instructions](../../../../docs/install/README.md) if you need to create
[installation instructions](../../../../docs/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).
Expand Down Expand Up @@ -186,4 +186,3 @@ To remove the sample app from your cluster, delete the service record:
```shell
kubectl delete --filename service.yaml
```

Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ deploying your app to your Knative cluster.
You must meet the following requirements to complete this sample:

- A version of the Knative Serving component installed and DNS configured. Follow the
[Knative installation instructions](../../../../docs/install/README.md) if you need
[Knative installation instructions](../../../../docs/install/) if you need
to create a Knative cluster.
- The following software downloaded and install on your loacal machine:
- [Java SE 8 or later JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
Expand Down
2 changes: 1 addition & 1 deletion community/samples/serving/helloworld-java-quarkus/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You must meet the following requirements to run this sample:

- Have a Kubernetes cluster running with the Knative Serving component
installed. For more information, see the
[Knative instruction guides](https://github.com/knative/docs/blob/main/docs/install/README.md).
[Knative instruction guides](https://github.com/knative/docs/blob/main/docs/install/).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be an absolute link? Other links are not.

- An installed version of the following tools:
- [Docker](https://www.docker.com)
- [Java SE 8 or later JDK](https://www.eclipse.org/openj9/)
Expand Down
3 changes: 1 addition & 2 deletions community/samples/serving/helloworld-r/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-r
## Before you begin

- A Kubernetes cluster with Knative installed. Follow the
[installation instructions](../../../../docs/install/README.md) if you need to
[installation instructions](../../../../docs/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).
Expand Down Expand Up @@ -195,4 +195,3 @@ To remove the sample app from your cluster, delete the service record:
```shell
kubectl delete --filename service.yaml
```

2 changes: 1 addition & 1 deletion community/samples/serving/helloworld-rserver/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-r
## Before you begin

- A Kubernetes cluster with Knative installed. Follow the
[installation instructions](../../../../docs/install/README.md) if you need to
[installation instructions](../../../../docs/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).
Expand Down
2 changes: 1 addition & 1 deletion community/samples/serving/helloworld-rust/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ TARGET is not specified, it will use "World" as the TARGET.
## Prerequisites

- A Kubernetes cluster with Knative installed and DNS configured. Follow the
[installation instructions](../../../../docs/install/README.md) if you need to create
[installation instructions](../../../../docs/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).
Expand Down
2 changes: 1 addition & 1 deletion community/samples/serving/helloworld-swift/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ specified, the app uses "World" as the TARGET.

- You must have a Kubernetes cluster with Knative installed and DNS configured.
If you need to create a cluster, follow the
[installation instructions](../../../../docs/install/README.md).
[installation instructions](../../../../docs/install/).
- You must have [Docker](https://www.docker.com) installed and running on your
local machine, and a Docker Hub account configured (used for container
registry).
Expand Down
2 changes: 1 addition & 1 deletion community/samples/serving/helloworld-vertx/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You must meet the following requirements to complete this sample:

- A version of the Knative Serving component installed and running on your
Kubernetes cluster. Follow the
[Knative installation instructions](../../../../docs/install/README.md) if you need to
[Knative installation instructions](../../../../docs/install/) if you need to
create a Knative cluster.
- The following software downloaded and install on your loacal machine:
- [Java SE 8 or later JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Knative deployment guide with BentoML is also available in the
## Before you begin

- A Kubernetes cluster with Knative installed. Follow the
[installation instructions](../../../../docs/install/README.md) if you need to
[installation instructions](../../../../docs/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. Docker Hub will be used for a container registry).
Expand Down
11 changes: 3 additions & 8 deletions docs/eventing/event-registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ type information in the cluster data store.

## Before you begin

1. Read about the [broker](./broker/) and [trigger](./triggers/) objects.
1. Read about the [broker](./broker/) and [trigger](./broker/triggers/) objects.
1. Be familiar with the
[CloudEvents spec](https://github.com/cloudevents/spec/blob/master/spec.md),
particularly the
Expand Down Expand Up @@ -279,14 +279,9 @@ the next topic: How do we actually populate the registry in the first place?
are two topics). You can see that in the registry example output from the
previous sections.

## What's next
## Next steps

To get started, install Knative Eventing if you haven't yet, and try
experimenting with different Event Sources in your Knative cluster.

1. [Installing Knative](../install/README.md) in case you haven't already done
so.
1. [Getting started with eventing](./README.md) in case you haven't read it.
1. [Installing Knative](../install/).
1. [Knative code samples](./samples/) is a useful resource to better understand
some of the Event Sources (remember to point them to a Broker if you want
automatic registration of EventTypes in the registry).
10 changes: 5 additions & 5 deletions docs/eventing/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ kubectl create namespace event-example

## Adding a broker to the namespace

The [broker](./broker/README.md#broker) allows you to route events to different event sinks or consumers.
The [broker](./broker) allows you to route events to different event sinks or consumers.

1. Add a broker named `default` to your namespace by entering the following command:

Expand Down Expand Up @@ -52,7 +52,7 @@ The [broker](./broker/README.md#broker) allows you to route events to different
```

If `READY` is `False`, wait a few moments and then run the command again.
If you continue to receive the `False` status, see the [Debugging Guide](./debugging/README.md) to troubleshoot the issue.
If you continue to receive the `False` status, see the [Debugging Guide](./debugging/) to troubleshoot the issue.

## Creating event consumers

Expand Down Expand Up @@ -148,11 +148,11 @@ demonstrate how you can configure your event producers to target a specific cons
goodbye-display 1/1 1 1 16s
```
The number of replicas in the **READY** column should match the number of replicas in the **AVAILABLE** column.
If the numbers do not match, see the [Debugging Guide](./debugging/README.md) to troubleshoot the issue.
If the numbers do not match, see the [Debugging Guide](./debugging/) to troubleshoot the issue.

## Creating triggers

A [trigger](./broker/README.md#trigger) defines the events that each event consumer receives.
A [trigger](./broker/triggers) defines the events that each event consumer receives.
Brokers use triggers to forward events to the correct consumers.
Each trigger can specify a filter that enables selection of relevant events based on the Cloud Event context attributes.

Expand Down Expand Up @@ -216,7 +216,7 @@ Each trigger can specify a filter that enables selection of relevant events base

The `SUBSCRIBER_URI` has a value similar to `triggerName.namespaceName.svc.cluster.local`.
The exact value depends on the broker implementation.
If this value looks incorrect, see the [Debugging Guide](./debugging/README.md) to troubleshoot the issue.
If this value looks incorrect, see the [Debugging Guide](./debugging/) to troubleshoot the issue.

## Creating a pod as an event producer

Expand Down
18 changes: 9 additions & 9 deletions docs/install/install-eventing-with-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This topic describes how to install Knative Eventing by applying YAML files usin
## Prerequisites

Before installation, you must meet the prerequisites.
See [Knative Prerequisites](./prerequisites.md).
See [Knative Prerequisites](./prerequisites).


## Install the Eventing component
Expand All @@ -32,7 +32,7 @@ To install the Eventing component:
```

For information about the YAML files in the Knative Serving and Eventing releases, see
[Installation files](./installation-files.md).
[Installation files](./installation-files).


## Verify the installation
Expand All @@ -55,7 +55,7 @@ Follow the procedure for the channel of your choice:
{{% tab name="Apache Kafka Channel" %}}

1. First,
[Install Apache Kafka for Kubernetes](../eventing/samples/kafka/README.md)
[Install Apache Kafka for Kubernetes](../eventing/samples/kafka/)

1. Then install the Apache Kafka channel:

Expand All @@ -66,7 +66,7 @@ Follow the procedure for the channel of your choice:
```

To learn more about the Apache Kafka channel, try
[our sample](../eventing/samples/kafka/channel/README.md)
[our sample](../eventing/samples/kafka/channel/)

{{< /tab >}}

Expand All @@ -80,7 +80,7 @@ To learn more about the Apache Kafka channel, try
```

To learn more about the Google Cloud Pub/Sub channel, try
[our sample](https://github.com/google/knative-gcp/blob/master/docs/examples/channel/README.md)
[our sample](https://github.com/google/knative-gcp/blob/master/docs/examples/channel/)

{{< /tab >}}

Expand Down Expand Up @@ -138,7 +138,7 @@ The following commands install the Apache Kafka broker, and run event routing in
kubectl apply -f {{< artifact org="knative-sandbox" repo="eventing-kafka-broker" file="eventing-kafka-broker.yaml" >}}
```

For more information, see the [Kafka broker](./../eventing/broker/kafka-broker.md) documentation.
For more information, see the [Kafka broker](./../eventing/broker/kafka-broker) documentation.
{{< /tab >}}

{{% tab name="MT-Channel-based" %}}
Expand Down Expand Up @@ -221,8 +221,8 @@ data:

After installing Knative Eventing:

- To easily interact with Knative Eventing components, [install the `kn` CLI](/docs/client/install-kn.md)
- To easily interact with Knative Eventing components, [install the `kn` CLI](/docs/client/install-kn)

- To add optional enhancements to your installation, see [Installing optional extensions](./install-extensions.md)
- To add optional enhancements to your installation, see [Installing optional extensions](./install-extensions)

- [Installing Knative Serving using YAML files](./install-serving-with-yaml.md)
- [Installing Knative Serving using YAML files](./install-serving-with-yaml)
Loading