diff --git a/community/samples/_index.md b/community/samples/_index.md index 72187cda7c6..6060e06eed5 100644 --- a/community/samples/_index.md +++ b/community/samples/_index.md @@ -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) -[**See all Knative code samples**](../../docs/samples.md) +[**See all Knative code samples**](../../docs/samples) ### Interactive serving sample @@ -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 @@ -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. | - diff --git a/community/samples/serving/helloworld-clojure/index.md b/community/samples/serving/helloworld-clojure/index.md index f9dabb47e79..9e36b6d7fe3 100644 --- a/community/samples/serving/helloworld-clojure/index.md +++ b/community/samples/serving/helloworld-clojure/index.md @@ -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). @@ -160,4 +160,3 @@ To remove the sample app from your cluster, delete the service record: ```shell kubectl delete --filename service.yaml ``` - diff --git a/community/samples/serving/helloworld-dart/index.md b/community/samples/serving/helloworld-dart/index.md index c87ca8e35ab..bdb59c2735b 100644 --- a/community/samples/serving/helloworld-dart/index.md +++ b/community/samples/serving/helloworld-dart/index.md @@ -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). diff --git a/community/samples/serving/helloworld-deno/index.md b/community/samples/serving/helloworld-deno/index.md index d58fe6840f4..511677e9a81 100644 --- a/community/samples/serving/helloworld-deno/index.md +++ b/community/samples/serving/helloworld-deno/index.md @@ -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). @@ -147,4 +147,3 @@ To remove the sample app from your cluster, delete the service record: ```shell kubectl delete --filename service.yaml ``` - diff --git a/community/samples/serving/helloworld-haskell/index.md b/community/samples/serving/helloworld-haskell/index.md index aabfd2de795..b0c5f272f81 100644 --- a/community/samples/serving/helloworld-haskell/index.md +++ b/community/samples/serving/helloworld-haskell/index.md @@ -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). @@ -186,4 +186,3 @@ To remove the sample app from your cluster, delete the service record: ```shell kubectl delete --filename service.yaml ``` - diff --git a/community/samples/serving/helloworld-java-micronaut/index.md b/community/samples/serving/helloworld-java-micronaut/index.md index b02c18233c2..4aead9ed533 100644 --- a/community/samples/serving/helloworld-java-micronaut/index.md +++ b/community/samples/serving/helloworld-java-micronaut/index.md @@ -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). diff --git a/community/samples/serving/helloworld-java-quarkus/index.md b/community/samples/serving/helloworld-java-quarkus/index.md index 6ea760aec73..9ac9e2123b1 100644 --- a/community/samples/serving/helloworld-java-quarkus/index.md +++ b/community/samples/serving/helloworld-java-quarkus/index.md @@ -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/). - An installed version of the following tools: - [Docker](https://www.docker.com) - [Java SE 8 or later JDK](https://www.eclipse.org/openj9/) diff --git a/community/samples/serving/helloworld-r/index.md b/community/samples/serving/helloworld-r/index.md index 19230c91aca..1f95323fa17 100644 --- a/community/samples/serving/helloworld-r/index.md +++ b/community/samples/serving/helloworld-r/index.md @@ -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). @@ -195,4 +195,3 @@ To remove the sample app from your cluster, delete the service record: ```shell kubectl delete --filename service.yaml ``` - diff --git a/community/samples/serving/helloworld-rserver/index.md b/community/samples/serving/helloworld-rserver/index.md index 4c87f2a3710..d0a41718a05 100644 --- a/community/samples/serving/helloworld-rserver/index.md +++ b/community/samples/serving/helloworld-rserver/index.md @@ -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). diff --git a/community/samples/serving/helloworld-rust/index.md b/community/samples/serving/helloworld-rust/index.md index 27dee0f5e1f..bb099b48a25 100644 --- a/community/samples/serving/helloworld-rust/index.md +++ b/community/samples/serving/helloworld-rust/index.md @@ -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). diff --git a/community/samples/serving/helloworld-swift/index.md b/community/samples/serving/helloworld-swift/index.md index 5ea4b7c1dcb..cd95d3f7706 100644 --- a/community/samples/serving/helloworld-swift/index.md +++ b/community/samples/serving/helloworld-swift/index.md @@ -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). diff --git a/community/samples/serving/helloworld-vertx/index.md b/community/samples/serving/helloworld-vertx/index.md index afe70544fc8..7e155cbdd97 100644 --- a/community/samples/serving/helloworld-vertx/index.md +++ b/community/samples/serving/helloworld-vertx/index.md @@ -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). diff --git a/community/samples/serving/machinelearning-python-bentoml/index.md b/community/samples/serving/machinelearning-python-bentoml/index.md index 6c867e0ab74..cc7f2a3b86b 100644 --- a/community/samples/serving/machinelearning-python-bentoml/index.md +++ b/community/samples/serving/machinelearning-python-bentoml/index.md @@ -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). diff --git a/docs/eventing/event-registry.md b/docs/eventing/event-registry.md index 433c065fc1a..8171676fbac 100644 --- a/docs/eventing/event-registry.md +++ b/docs/eventing/event-registry.md @@ -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 @@ -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). diff --git a/docs/eventing/getting-started.md b/docs/eventing/getting-started.md index da81c25f344..5ef0c7e7823 100644 --- a/docs/eventing/getting-started.md +++ b/docs/eventing/getting-started.md @@ -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: @@ -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 @@ -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. @@ -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 diff --git a/docs/install/install-eventing-with-yaml.md b/docs/install/install-eventing-with-yaml.md index 6f4de792989..0b5b5b99b74 100644 --- a/docs/install/install-eventing-with-yaml.md +++ b/docs/install/install-eventing-with-yaml.md @@ -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 @@ -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 @@ -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: @@ -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 >}} @@ -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 >}} @@ -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" %}} @@ -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) diff --git a/docs/install/install-extensions.md b/docs/install/install-extensions.md index 4609e21f04c..3fb552f0c0b 100644 --- a/docs/install/install-extensions.md +++ b/docs/install/install-extensions.md @@ -10,14 +10,14 @@ To add extra features to your Knative Serving or Eventing installation, you can by applying YAML files using the `kubectl` CLI. For information about the YAML files in the Knative Serving and Eventing releases, see -[Installation files](./installation-files.md). +[Installation files](./installation-files). # Prerequisites Before you install any optional extensions, you must install Knative Serving or Eventing. -See [Installing Serving using YAML files](./install-serving-with-yaml.md) -and [Installing Eventing using YAML files](./install-eventing-with-yaml.md). +See [Installing Serving using YAML files](./install-serving-with-yaml) +and [Installing Eventing using YAML files](./install-eventing-with-yaml). ## Install optional Serving extensions @@ -48,7 +48,7 @@ install the components needed to support the provisioning of TLS certificates via cert-manager. 1. First, install - [cert-manager version `0.12.0` or higher](../serving/installing-cert-manager.md) + [cert-manager version `0.12.0` or higher](../serving/installing-cert-manager) 2. Next, install the component that integrates Knative with cert-manager: @@ -57,7 +57,7 @@ via cert-manager. ``` 3. Now configure Knative to - [automatically configure TLS certificates](../serving/using-auto-tls.md). + [automatically configure TLS certificates](../serving/using-auto-tls). {{< /tab >}} {{% tab name="TLS via HTTP01" %}} @@ -144,7 +144,7 @@ The tabs below expand to show instructions for installing each Eventing extensio kubectl apply -f {{< artifact org="knative-sandbox" repo="eventing-kafka-broker" file="eventing-kafka-sink.yaml" >}} ``` -For more information, see the [Kafka Sink](./../eventing/sink/kafka-sink.md) documentation. +For more information, see the [Kafka Sink](./../eventing/sink/kafka-sink) documentation. {{< /tab >}} @@ -197,7 +197,7 @@ GitHub sources in the cluster. This source does not support logging or tracing configuration yet. To learn more about the Github source, try -[our sample](../eventing/samples/github-source/README.md) +[our sample](../eventing/samples/github-source/) {{< /tab >}} @@ -210,7 +210,7 @@ kubectl apply -f {{< artifact org="knative-sandbox" repo="eventing-camel" file=" ``` To learn more about the Apache Camel-K source, try -[our sample](../eventing/samples/apache-camel-source/README.md) +[our sample](../eventing/samples/apache-camel-source/) {{< /tab >}} @@ -223,7 +223,7 @@ kubectl apply -f {{< artifact org="knative-sandbox" repo="eventing-kafka" file=" ``` To learn more about the Apache Kafka source, try -[our sample](../eventing/samples/kafka/source/README.md) +[our sample](../eventing/samples/kafka/source/) {{< /tab >}} @@ -237,16 +237,16 @@ kubectl apply -f {{< artifact org="google" repo="knative-gcp" file="cloud-run-ev ``` To learn more about the Cloud Pub/Sub source, try -[our sample](../eventing/samples/cloud-pubsub-source/README.md). +[our sample](../eventing/samples/cloud-pubsub-source/). To learn more about the Cloud Storage source, try -[our sample](../eventing/samples/cloud-storage-source/README.md). +[our sample](../eventing/samples/cloud-storage-source/). To learn more about the Cloud Scheduler source, try -[our sample](../eventing/samples/cloud-scheduler-source/README.md). +[our sample](../eventing/samples/cloud-scheduler-source/). To learn more about the Cloud Audit Logs source, try -[our sample](../eventing/samples/cloud-audit-logs-source/README.md). +[our sample](../eventing/samples/cloud-audit-logs-source/). {{< /tab >}} @@ -258,7 +258,7 @@ The following command installs the Apache CouchDB Source: kubectl apply -f {{< artifact org="knative-sandbox" repo="eventing-couchdb" file="couchdb.yaml" >}} ``` -To learn more about the Apache CouchDB source, read the [documentation](https://github.com/knative-sandbox/eventing-couchdb/blob/main/source/README.md). +To learn more about the Apache CouchDB source, read the [documentation](https://github.com/knative-sandbox/eventing-couchdb/blob/main/source/). {{< /tab >}} @@ -271,7 +271,7 @@ kubectl apply -f {{< artifact org="vmware-tanzu" repo="sources-for-knative" file ``` To learn more about the VMware sources and bindings, try -[our samples](https://github.com/vmware-tanzu/sources-for-knative/tree/master/samples/README.md). +[our samples](https://github.com/vmware-tanzu/sources-for-knative/tree/master/samples/). {{< /tab >}} @@ -279,4 +279,4 @@ To learn more about the VMware sources and bindings, try ## Next steps -- To easily interact with Knative Services and Eventing components, [install the `kn` CLI](/docs/client/install-kn.md) +- To easily interact with Knative Services and Eventing components, [install the `kn` CLI](/docs/client/install-kn) diff --git a/docs/install/installing-istio.md b/docs/install/installing-istio.md index 3969a20274e..2ca65297725 100644 --- a/docs/install/installing-istio.md +++ b/docs/install/installing-istio.md @@ -211,10 +211,7 @@ See the [Uninstall Istio](https://istio.io/docs/setup/install/istioctl/#uninstal ## What's next -- [Install Knative](./README.md). -- Try the - [Getting Started with App Deployment guide](../serving/getting-started-knative-app.md) - for Knative serving. +- Try the [Getting Started with App Deployment guide](../serving/getting-started-knative-app) for Knative serving. [1]: https://istio.io/docs/setup/kubernetes/additional-setup/sidecar-injection/#manual-sidecar-injection diff --git a/docs/samples.md b/docs/samples.md index 00dd6fc916b..91431105176 100755 --- a/docs/samples.md +++ b/docs/samples.md @@ -16,11 +16,11 @@ closer with your goals. View the set of Knative code samples that are actively tested and maintained: - [Eventing and Eventing Sources code samples](./eventing/samples/) -- [Serving code samples](./serving/samples/README.md) +- [Serving code samples](./serving/samples/) ### Community owned and maintained -[View code samples that are contributed and maintained by the community](../community/samples/README.md). +[View code samples that are contributed and maintained by the community](../community/samples/). ### External code samples @@ -29,7 +29,7 @@ A list of links to Knative code samples that live outside of - [Image processing using Knative Eventing, Cloud Run on GKE (Knative Serving implementation) and Google Cloud Vision API](https://github.com/akashrv/knative-samples/blob/master/docs/image-processing.md) - [A potpourri of Knative Eventing Examples](https://github.com/lionelvillard/knative-examples) -- [Knfun - a complete Knative example of three functions using Twitter and Watson API that use kn to deploy and manage functions](https://github.com/maximilien/knfun/blob/master/README.md) +- [Knfun - a complete Knative example of three functions using Twitter and Watson API that use kn to deploy and manage functions](https://github.com/maximilien/knfun/blob/master/) - [Knative Eventing (Cloud Events) example using spring-boot and spring-cloud-streams + Kafka](https://salaboy.com/2020/02/20/getting-started-with-knative-2020/) - [Image processing pipeline using Knative Eventing on GKE, Google Cloud Vision API and ImageSharp library](https://github.com/meteatamel/knative-tutorial/blob/master/docs/image-processing-pipeline.md) - [BigQuery processing pipeline using Knative Eventing on GKE, Cloud Scheduler, BigQuery, mathplotlib and SendGrid](https://github.com/meteatamel/knative-tutorial/blob/master/docs/bigquery-processing-pipeline.md) diff --git a/docs/serving/_index.md b/docs/serving/_index.md index d4bcdc96d73..9744d1eddb2 100644 --- a/docs/serving/_index.md +++ b/docs/serving/_index.md @@ -22,22 +22,22 @@ Knative Serving defines a set of objects as Kubernetes Custom Resource Definitions (CRDs). These objects are used to define and control how your serverless workload behaves on the cluster: -- [Service](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#service): +- [Service](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0#service): The `service.serving.knative.dev` resource automatically manages the whole lifecycle of your workload. It controls the creation of other objects to ensure that your app has a route, a configuration, and a new revision for each update of the service. Service can be defined to always route traffic to the latest revision or to a pinned revision. -- [Route](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#route): +- [Route](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0#route): The `route.serving.knative.dev` resource maps a network endpoint to one or more revisions. You can manage the traffic in several ways, including fractional traffic and named routes. -- [Configuration](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#configuration): +- [Configuration](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0#configuration): The `configuration.serving.knative.dev` resource maintains the desired state for your deployment. It provides a clean separation between code and configuration and follows the Twelve-Factor App methodology. Modifying a configuration creates a new revision. -- [Revision](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0.md#revision): +- [Revision](https://github.com/knative/docs/blob/main/docs/serving/spec/knative-api-specification-1.0#revision): The `revision.serving.knative.dev` resource is a point-in-time snapshot of the code and configuration for each modification made to the workload. Revisions are immutable objects and can be retained for as long as useful. Knative @@ -59,27 +59,27 @@ matching route and configuration created. Each time the `Service` is updated, a new revision is created. For more information on the resources and their interactions, see the -[Resource Types Overview](https://github.com/knative/serving/blob/main/docs/spec/overview.md) +[Resource Types Overview](https://github.com/knative/specs/blob/main/specs/serving/overview.md) in the Knative Serving repository. ## More samples and demos -- [Knative Serving code samples](./samples/README.md) +- [Knative Serving code samples](./samples/) ## Debugging Knative Serving issues -- [Debugging Application Issues](./debugging-application-issues.md) +- [Debugging Application Issues](./debugging-application-issues) ## Configuration and Networking -- [Configuring cluster local routes](./cluster-local-route.md) -- [Using a custom domain](./using-a-custom-domain.md) -- [Assigning a static IP address for Knative on Google Kubernetes Engine](./gke-assigning-static-ip-address.md) -- [Using subroutes](./using-subroutes.md) +- [Configuring cluster local routes](./cluster-local-route) +- [Using a custom domain](./using-a-custom-domain) +- [Assigning a static IP address for Knative on Google Kubernetes Engine](./gke-assigning-static-ip-address) +- [Using subroutes](./using-subroutes) ## Observability -- [Serving Metrics API](./metrics.md) +- [Serving Metrics API](./metrics) ## Known Issues diff --git a/docs/serving/autoscaling/_index.md b/docs/serving/autoscaling/_index.md index c9b70869621..1c4208a0d89 100644 --- a/docs/serving/autoscaling/_index.md +++ b/docs/serving/autoscaling/_index.md @@ -14,16 +14,16 @@ The Autoscaler component watches traffic flow to the application, and scales rep Knative services default to using autoscaling settings that are suitable for the majority of use cases. However, some workloads may require a custom, more finely-tuned configuration. This guide provides information about configuration options that you can modify to fit the requirements of your workload. -For more information about how autoscaling for Knative works, see the [Autoscaling concepts](./autoscaling-concepts.md) documentation. +For more information about how autoscaling for Knative works, see the [Autoscaling concepts](./autoscaling-concepts) documentation. -For more information about which metrics can be used to control the Autoscaler, see the [metrics](./autoscaling-metrics.md) documentation. +For more information about which metrics can be used to control the Autoscaler, see the [metrics](./autoscaling-metrics) documentation. ## Optional autoscaling configuration tasks * Configure your Knative deployment to use the Kubernetes Horizontal Pod Autoscaler (HPA) instead of the default KPA. -For how to install HPA, see [Install optional Eventing extensions](../../install/install-extensions.md#install-optional-serving-extensions). -* Disable scale to zero functionality for your cluster ([global configuration only](./scale-to-zero.md)). -* Configure the [type of metrics](./autoscaling-metrics.md) your Autoscaler consumes. -* Configure [concurrency limits](./concurrency.md) for applications. -* Try out the [Go Autoscale Sample App](./autoscale-go/README.md). +For how to install HPA, see [Install optional Eventing extensions](../../install/install-extensions#install-optional-serving-extensions). +* Disable scale to zero functionality for your cluster ([global configuration only](./scale-to-zero)). +* Configure the [type of metrics](./autoscaling-metrics) your Autoscaler consumes. +* Configure [concurrency limits](./concurrency) for applications. +* Try out the [Go Autoscale Sample App](./autoscale-go/). diff --git a/docs/serving/autoscaling/autoscale-go/index.md b/docs/serving/autoscaling/autoscale-go/index.md index 2faf813a8e2..465f688b549 100644 --- a/docs/serving/autoscaling/autoscale-go/index.md +++ b/docs/serving/autoscaling/autoscale-go/index.md @@ -11,7 +11,7 @@ A demonstration of the autoscaling capabilities of a Knative Serving Revision. ## Prerequisites -1. A Kubernetes cluster with [Knative Serving](../../../install/README.md) +1. A Kubernetes cluster with [Knative Serving](../../../install/) installed. 1. The `hey` load generator installed (`go get -u github.com/rakyll/hey`). 1. Clone this repository, and move into the sample directory: diff --git a/docs/serving/deploying/private-registry.md b/docs/serving/deploying/private-registry.md index 06254cc4a97..54aaa12285c 100644 --- a/docs/serving/deploying/private-registry.md +++ b/docs/serving/deploying/private-registry.md @@ -5,10 +5,10 @@ weight: 10 type: "docs" --- -Learn how to configure your Knative cluster to deploy images from a private +Learn how to configure your Knative cluster to deploy images from a private container registry. -To share access to your private container images across multiple services and +To share access to your private container images across multiple services and revisions, you create a list of Kubernetes secrets ([`imagePullSecrets`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#pod-v1-core)) using your registry credentials, add that `imagePullSecrets` to your default @@ -19,7 +19,7 @@ and then deploy those configurations to your Knative cluster. You need: -- A Kubernetes cluster with [Knative Serving installed](../../install/README.md). +- A Kubernetes cluster with [Knative Serving installed](../../install/). - The credentials to the private container registry where your container images are stored. ## Configuring your credentials in Knative @@ -39,7 +39,7 @@ You need: (`imagePullSecrets` object). For example, `container-registry`. - `[PRIVATE_REGISTRY_SERVER_URL]` is the URL to the private - registry where your container images are stored. + registry where your container images are stored. Examples: - Google Container Registry: [https://gcr.io/](https://gcr.io/) @@ -53,9 +53,9 @@ You need: * `[PRIVATE_REGISTRY_PASSWORD]` is the password that you use to access the private container registry. - + Example: - + ```shell kubectl create secret `container-registry` \ --docker-server=https://gcr.io/ \ @@ -63,20 +63,20 @@ You need: --docker-username=my-grc-username \ --docker-password=my-gcr-password ``` - + Tip: After creating the `imagePullSecrets`, you can view those secret's by running: - + ```shell kubectl get secret [REGISTRY-CRED-SECRETS] --output=yaml ``` 1. Add the `imagePullSecrets` to your `default` service account in the `default` namespace. - - Note: By default, the `default` service account in each of the - [namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) - of your Knative cluster are use by your revisions unless - [`serviceAccountName`](../spec/knative-api-specification-1.0.md) is specified. + + Note: By default, the `default` service account in each of the + [namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) + of your Knative cluster are use by your revisions unless + [`serviceAccountName`](../spec/knative-api-specification-1.0) is specified. Run the following command to modify your `default` service account, assuming you named your secrets `container-registry`: @@ -90,5 +90,5 @@ your credentials and have access to your container images in the private registr ## What's next -You can now create a service that uses your container images from the private registry. -[Learn how to create a Knative service](../getting-started-knative-app.md). +You can now create a service that uses your container images from the private registry. +[Learn how to create a Knative service](../getting-started-knative-app). diff --git a/docs/serving/feature-flags.md b/docs/serving/feature-flags.md index e2bffb8ad1e..3e44f54ce60 100644 --- a/docs/serving/feature-flags.md +++ b/docs/serving/feature-flags.md @@ -286,4 +286,4 @@ they are no longer active. * **Type**: extension * **ConfigMap key:** `tag-header-based-routing` -This flags controls whether [tag header based routing](./samples/tag-header-based-routing/README.md) is enabled. +This flags controls whether [tag header based routing](./samples/tag-header-based-routing/) is enabled. diff --git a/docs/serving/getting-started-knative-app.md b/docs/serving/getting-started-knative-app.md index 169e63aaa00..626dc48e949 100644 --- a/docs/serving/getting-started-knative-app.md +++ b/docs/serving/getting-started-knative-app.md @@ -14,7 +14,7 @@ using cURL requests. You need: -- A Kubernetes cluster with [Knative Serving installed](../install/README.md). +- A Kubernetes cluster with [Knative Serving installed](../install/). - An image of the app that you'd like to deploy available on a container registry. The image of the sample app used in this guide is available on Google Container Registry. @@ -33,7 +33,7 @@ To deploy a local container image, you need to disable image tag resolution by r docker tag local-image dev.local/local-image ``` -[Learn more about image tag resolution.](./tag-resolution.md) +[Learn more about image tag resolution.](./tag-resolution) The Hello World sample app reads in an `env` variable, `TARGET`, then prints "Hello World: \${TARGET}!". If `TARGET` isn't defined, it will print "NOT SPECIFIED". @@ -41,7 +41,7 @@ The Hello World sample app reads in an `env` variable, `TARGET`, then prints "He The easiest way to deploy a Knative Service is by using the Knative CLI [kn](https://github.com/knative/client). -**Prerequisite:** Install the `kn` binary as described in [Installing the Knative CLI](../install/install-kn.md) +**Prerequisite:** Install the `kn` binary as described in [Installing the Knative CLI](../install/install-kn) It will create a corresponding resource description internally as when using a YAML file directly. `kn` provides a command-line mechanism for managing Services. @@ -69,12 +69,12 @@ Now that you have deployed the service, Knative will perform the following steps ## Creating your Deployment with YAML Alternatively, to deploy an app using Knative, you can also create the configuration in a YAML file that defines a service. For more information about the Service object, see the -[Resource Types documentation](https://github.com/knative/serving/blob/main/docs/spec/overview.md#service). +[Resource Types documentation](https://github.com/knative/serving/blob/main/docs/spec/overview#service). This configuration file specifies metadata about the application, points to the hosted image of the app for deployment, and allows the deployment to be configured. For more information about what configuration options are available, -see the [Serving spec documentation](https://github.com/knative/serving/blob/main/docs/spec/spec.md). +see the [Serving spec documentation](https://github.com/knative/serving/blob/main/docs/spec/spec). To create the same application as in the previous `kn` example, create a new file named `service.yaml`, then copy and paste the following content into it: @@ -162,7 +162,7 @@ To see if your app has been deployed successfully, you need the URL created by K {{< /tabs >}} > Note: If your URL includes `example.com` then consult the setup instructions for - > configuring DNS (e.g. with `xip.io`), or [using a Custom Domain](../serving/using-a-custom-domain.md). + > configuring DNS (e.g. with `xip.io`), or [using a Custom Domain](../serving/using-a-custom-domain). If you changed the name from `helloworld-go` to something else when creating the `.yaml` file, replace `helloworld-go` in the above commands with the name you entered. diff --git a/docs/serving/samples/_index.md b/docs/serving/samples/_index.md index 9fc07cd49c4..71de1688862 100644 --- a/docs/serving/samples/_index.md +++ b/docs/serving/samples/_index.md @@ -7,20 +7,19 @@ type: "docs" Use the following code samples to help you understand the various Knative Serving resources and how they can be applied across common use cases. -[Learn more about Knative Serving resources](../README.md). -[**See all Knative code samples**](../../samples.md) +[**See all Knative code samples**](../../samples) | Name | Description | Languages | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| Hello World | A quick introduction that highlights how to deploy an app using Knative Serving. | [C#](./hello-world/helloworld-csharp/README.md), [Go](./hello-world/helloworld-go/README.md), [Java (Spark)](./hello-world/helloworld-java-spark/README.md), [Java (Spring)](./hello-world/helloworld-java-spring/README.md), [Kotlin](./hello-world/helloworld-kotlin/README.md), [Node.js](./hello-world/helloworld-nodejs/README.md), [PHP](./hello-world/helloworld-php/README.md), [Python](./hello-world/helloworld-python/README.md), [Ruby](./hello-world/helloworld-ruby/README.md), [Scala](./hello-world/helloworld-scala/README.md), [Shell](./hello-world/helloworld-shell/README.md) | -| Cloud Events | A quick introduction that highlights how to send and receive Cloud Events. | [C#](./cloudevents/cloudevents-dotnet/README.md), [Go](./cloudevents/cloudevents-go/README.md), [Node.js](./cloudevents/cloudevents-nodejs/README.md), [Rust](./cloudevents/cloudevents-rust/README.md), [Java (Vert.x)](./cloudevents/cloudevents-vertx/README.md) | -| Advanced Deployment | Simple blue/green-like application deployment pattern illustrating the process of updating a live application without dropping any traffic. | [YAML](./blue-green-deployment.md) | -| Autoscale | A demonstration of the autoscaling capabilities of Knative. | [Go](../autoscaling/autoscale-go/README.md) | -| Github Webhook | A simple webhook handler that demonstrates interacting with Github. | [Go](./gitwebhook-go/README.md) | -| gRPC | A simple gRPC server. | [Go](./grpc-ping-go/README.md) | -| Knative Routing | An example of mapping multiple Knative services to different paths under a single domain name using the Istio VirtualService concept. | [Go](./knative-routing-go/README.md) | -| Knative Secrets | A simple app that demonstrates how to use a Kubernetes secret as a Volume in Knative. | [Go](./secrets-go/README.md) | -| REST API | A simple Restful service that exposes an endpoint defined by an environment variable described in the Knative Configuration. | [Go](./rest-api-go/README.md) | -| Traffic Splitting | This samples builds off the [Creating a RESTful Service](./rest-api-go) sample to illustrate applying a revision, then using that revision for manual traffic splitting. | [YAML](./traffic-splitting/README.md) | -| Multi Container | A quick introduction that highlights how to build and deploy an app using Knative Serving for multiple containers. | [Go](./multi-container/README.md) | +| Hello World | A quick introduction that highlights how to deploy an app using Knative Serving. | [C#](./hello-world/helloworld-csharp/), [Go](./hello-world/helloworld-go/), [Java (Spark)](./hello-world/helloworld-java-spark/), [Java (Spring)](./hello-world/helloworld-java-spring/), [Kotlin](./hello-world/helloworld-kotlin/), [Node.js](./hello-world/helloworld-nodejs/), [PHP](./hello-world/helloworld-php/), [Python](./hello-world/helloworld-python/), [Ruby](./hello-world/helloworld-ruby/), [Scala](./hello-world/helloworld-scala/), [Shell](./hello-world/helloworld-shell/) | +| Cloud Events | A quick introduction that highlights how to send and receive Cloud Events. | [C#](./cloudevents/cloudevents-dotnet/), [Go](./cloudevents/cloudevents-go/), [Node.js](./cloudevents/cloudevents-nodejs/), [Rust](./cloudevents/cloudevents-rust/), [Java (Vert.x)](./cloudevents/cloudevents-vertx/) | +| Advanced Deployment | Simple blue/green-like application deployment pattern illustrating the process of updating a live application without dropping any traffic. | [YAML](./blue-green-deployment) | +| Autoscale | A demonstration of the autoscaling capabilities of Knative. | [Go](../autoscaling/autoscale-go/) | +| Github Webhook | A simple webhook handler that demonstrates interacting with Github. | [Go](./gitwebhook-go/) | +| gRPC | A simple gRPC server. | [Go](./grpc-ping-go/) | +| Knative Routing | An example of mapping multiple Knative services to different paths under a single domain name using the Istio VirtualService concept. | [Go](./knative-routing-go/) | +| Knative Secrets | A simple app that demonstrates how to use a Kubernetes secret as a Volume in Knative. | [Go](./secrets-go/) | +| REST API | A simple Restful service that exposes an endpoint defined by an environment variable described in the Knative Configuration. | [Go](./rest-api-go/) | +| Traffic Splitting | This samples builds off the [Creating a RESTful Service](./rest-api-go) sample to illustrate applying a revision, then using that revision for manual traffic splitting. | [YAML](./traffic-splitting/) | +| Multi Container | A quick introduction that highlights how to build and deploy an app using Knative Serving for multiple containers. | [Go](./multi-container/) | diff --git a/docs/serving/samples/cloudevents/cloudevents-dotnet/index.md b/docs/serving/samples/cloudevents/cloudevents-dotnet/index.md index 8dcf8ef7d6f..f766aa2dbc7 100644 --- a/docs/serving/samples/cloudevents/cloudevents-dotnet/index.md +++ b/docs/serving/samples/cloudevents/cloudevents-dotnet/index.md @@ -32,7 +32,7 @@ cd knative-docs/docs/serving/samples/cloudevents/cloudevents-dotnet ## 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/cloudevents/cloudevents-go/index.md b/docs/serving/samples/cloudevents/cloudevents-go/index.md index 790e1875700..c8c58613d23 100644 --- a/docs/serving/samples/cloudevents/cloudevents-go/index.md +++ b/docs/serving/samples/cloudevents/cloudevents-go/index.md @@ -32,7 +32,7 @@ cd knative-docs/docs/serving/samples/cloudevents/cloudevents-go ## 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/cloudevents/cloudevents-nodejs/index.md b/docs/serving/samples/cloudevents/cloudevents-nodejs/index.md index e2f6db983d0..1e5d5ffb121 100644 --- a/docs/serving/samples/cloudevents/cloudevents-nodejs/index.md +++ b/docs/serving/samples/cloudevents/cloudevents-nodejs/index.md @@ -32,7 +32,7 @@ cd knative-docs/docs/serving/samples/cloudevents/cloudevents-nodejs ## 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/cloudevents/cloudevents-rust/index.md b/docs/serving/samples/cloudevents/cloudevents-rust/index.md index 4735b0cca5b..ee6289ec4da 100644 --- a/docs/serving/samples/cloudevents/cloudevents-rust/index.md +++ b/docs/serving/samples/cloudevents/cloudevents-rust/index.md @@ -34,7 +34,7 @@ cd knative-docs/docs/serving/samples/cloudevents/cloudevents-rust ## 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/cloudevents/cloudevents-spring/index.md b/docs/serving/samples/cloudevents/cloudevents-spring/index.md index 8592c87c731..318739a0d16 100644 --- a/docs/serving/samples/cloudevents/cloudevents-spring/index.md +++ b/docs/serving/samples/cloudevents/cloudevents-spring/index.md @@ -34,7 +34,7 @@ cd knative-docs/docs/serving/samples/cloudevents/cloudevents-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/cloudevents/cloudevents-vertx/index.md b/docs/serving/samples/cloudevents/cloudevents-vertx/index.md index 019f0edc023..536129c6e1c 100644 --- a/docs/serving/samples/cloudevents/cloudevents-vertx/index.md +++ b/docs/serving/samples/cloudevents/cloudevents-vertx/index.md @@ -34,7 +34,7 @@ cd knative-docs/docs/serving/samples/cloudevents/cloudevents-vertx ## 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). @@ -156,4 +156,3 @@ kn service delete cloudevents-vertx ``` {{< /tab >}} - diff --git a/docs/serving/samples/hello-world/helloworld-csharp/index.md b/docs/serving/samples/hello-world/helloworld-csharp/index.md index 768e7ef50cd..6abe43feb0c 100644 --- a/docs/serving/samples/hello-world/helloworld-csharp/index.md +++ b/docs/serving/samples/hello-world/helloworld-csharp/index.md @@ -21,7 +21,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-csharp ## 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). @@ -83,7 +83,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-csharp # Use Microsoft's official build .NET image. FROM mcr.microsoft.com/dotnet/core/sdk:3.1 AS build WORKDIR /app - + # Install production dependencies. # Copy csproj and restore as distinct layers. COPY *.csproj ./ diff --git a/docs/serving/samples/hello-world/helloworld-go/index.md b/docs/serving/samples/hello-world/helloworld-go/index.md index 0046b977e30..d624169a8f9 100644 --- a/docs/serving/samples/hello-world/helloworld-go/index.md +++ b/docs/serving/samples/hello-world/helloworld-go/index.md @@ -13,7 +13,7 @@ If `TARGET` is not specified, `World` is used as the default value. ## Prerequisites You will need: -- A Kubernetes cluster with [Knative installed and DNS configured](../../../../install/README.md). +- A Kubernetes cluster with [Knative installed and DNS configured](../../../../install/). - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured. - Optional: You can use the Knative CLI client [`kn`](https://github.com/knative/client/releases) to simplify resource creation and deployment. Alternatively, you can use `kubectl` to apply resource files directly. diff --git a/docs/serving/samples/hello-world/helloworld-java-spark/index.md b/docs/serving/samples/hello-world/helloworld-java-spark/index.md index 497a49c4726..83d739880c0 100644 --- a/docs/serving/samples/hello-world/helloworld-java-spark/index.md +++ b/docs/serving/samples/hello-world/helloworld-java-spark/index.md @@ -12,7 +12,7 @@ This guide describes the steps required to to create the `helloworld-java` sampl ## Prerequisites You will need: -- A Kubernetes cluster with [Knative installed and DNS configured](../../../../install/README.md). +- A Kubernetes cluster with [Knative installed and DNS configured](../../../../install/). - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured. - [Java SE 8 or later JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html). diff --git a/docs/serving/samples/hello-world/helloworld-java-spring/index.md b/docs/serving/samples/hello-world/helloworld-java-spring/index.md index b2b345cd182..e819c7a5cdc 100644 --- a/docs/serving/samples/hello-world/helloworld-java-spring/index.md +++ b/docs/serving/samples/hello-world/helloworld-java-spring/index.md @@ -19,7 +19,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-java-spring ## Prerequisites - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md). + [installation instructions](../../../../install/). - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured. - (optional) The Knative CLI client [kn](https://github.com/knative/client/releases) can be used to simplify the deployment. Alternatively, you can use `kubectl`, and apply resource files directly. diff --git a/docs/serving/samples/hello-world/helloworld-kotlin/index.md b/docs/serving/samples/hello-world/helloworld-kotlin/index.md index 12e5eea5e8d..11e05870504 100644 --- a/docs/serving/samples/hello-world/helloworld-kotlin/index.md +++ b/docs/serving/samples/hello-world/helloworld-kotlin/index.md @@ -21,7 +21,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-kotlin ## 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/hello-world/helloworld-nodejs/index.md b/docs/serving/samples/hello-world/helloworld-nodejs/index.md index a7458e5548a..d6d40e4a767 100644 --- a/docs/serving/samples/hello-world/helloworld-nodejs/index.md +++ b/docs/serving/samples/hello-world/helloworld-nodejs/index.md @@ -21,7 +21,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-nodejs ## 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/hello-world/helloworld-php/index.md b/docs/serving/samples/hello-world/helloworld-php/index.md index 1e6da2e4fd5..8c3361ce8bf 100644 --- a/docs/serving/samples/hello-world/helloworld-php/index.md +++ b/docs/serving/samples/hello-world/helloworld-php/index.md @@ -21,7 +21,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-php ## 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/hello-world/helloworld-python/index.md b/docs/serving/samples/hello-world/helloworld-python/index.md index fad48a98e59..5bbacafc9d9 100644 --- a/docs/serving/samples/hello-world/helloworld-python/index.md +++ b/docs/serving/samples/hello-world/helloworld-python/index.md @@ -23,7 +23,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-python ## Prerequisites - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md). + [installation instructions](../../../../install/). - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured. - (optional) The Knative CLI client @@ -172,7 +172,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-python 1. Run one of the followings commands to find the domain URL for your service. > Note: If your URL includes `example.com` then consult the setup instructions for - > configuring DNS (e.g. with `xip.io`), or [using a Custom Domain](../serving/using-a-custom-domain.md). + > configuring DNS (e.g. with `xip.io`), or [using a Custom Domain](../serving/using-a-custom-domain). {{< tabs name="service_url" default="kn" >}} {{% tab name="kubectl" %}} diff --git a/docs/serving/samples/hello-world/helloworld-ruby/index.md b/docs/serving/samples/hello-world/helloworld-ruby/index.md index ef8065e2d90..7b27f55fe1c 100644 --- a/docs/serving/samples/hello-world/helloworld-ruby/index.md +++ b/docs/serving/samples/hello-world/helloworld-ruby/index.md @@ -21,7 +21,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-ruby ## Prerequisites - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md). + [installation instructions](../../../../install/). - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured. - (optional) The Knative CLI client [kn](https://github.com/knative/client/releases) that simplifies the deployment. Alternative you can also use [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/) and apply resource files directly. @@ -245,4 +245,4 @@ To remove the sample app from your cluster, delete the service record. ``` {{< /tab >}} -{{< /tabs >}} \ No newline at end of file +{{< /tabs >}} diff --git a/docs/serving/samples/hello-world/helloworld-scala/index.md b/docs/serving/samples/hello-world/helloworld-scala/index.md index 5ac4efbc26a..a39b14cbf1f 100644 --- a/docs/serving/samples/hello-world/helloworld-scala/index.md +++ b/docs/serving/samples/hello-world/helloworld-scala/index.md @@ -22,7 +22,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-scala ## Before you begin -- A Kubernetes cluster [installation](../../../../install/README.md) with +- A Kubernetes cluster [installation](../../../../install/) with Knative Serving up and running. - [Docker](https://www.docker.com) installed locally, and running, optionally a Docker Hub account configured or some other Docker Repository installed diff --git a/docs/serving/samples/hello-world/helloworld-shell/index.md b/docs/serving/samples/hello-world/helloworld-shell/index.md index 22740caa9f3..064e5ab237a 100644 --- a/docs/serving/samples/hello-world/helloworld-shell/index.md +++ b/docs/serving/samples/hello-world/helloworld-shell/index.md @@ -22,7 +22,7 @@ cd knative-docs/docs/serving/samples/hello-world/helloworld-shell ## Prerequisites - A Kubernetes cluster with Knative installed and DNS configured. Follow the - [installation instructions](../../../../install/README.md). + [installation instructions](../../../../install/). - [Docker](https://www.docker.com) installed and running on your local machine, and a Docker Hub account configured. - Optional: You can use the Knative CLI client [`kn`](https://github.com/knative/client/releases) to simplify resource creation and deployment. Alternatively, you can use `kubectl` to apply resource files directly. diff --git a/docs/serving/using-a-custom-domain.md b/docs/serving/using-a-custom-domain.md index 3203ac5c4b9..8aef325def9 100644 --- a/docs/serving/using-a-custom-domain.md +++ b/docs/serving/using-a-custom-domain.md @@ -88,7 +88,7 @@ You can also apply an updated domain configuration: > deployed services and routes. Deploy an app (for example, -[`helloworld-go`](./samples/hello-world/helloworld-go/README.md)), to your +[`helloworld-go`](./samples/hello-world/helloworld-go/)), to your cluster as normal. You can retrieve the URL in Knative Route "helloworld-go" with the following command: @@ -139,7 +139,7 @@ Follow these steps to make your domain publicly accessible: ### Set static IP for Knative Gateway You might want to -[set a static IP for your Knative gateway](./gke-assigning-static-ip-address.md), +[set a static IP for your Knative gateway](./gke-assigning-static-ip-address), so that the gateway IP does not change each time your cluster is restarted. ### Update your DNS records diff --git a/docs/serving/using-external-dns-on-gcp.md b/docs/serving/using-external-dns-on-gcp.md index 46294c8d6ea..62f31fc859e 100644 --- a/docs/serving/using-external-dns-on-gcp.md +++ b/docs/serving/using-external-dns-on-gcp.md @@ -116,7 +116,7 @@ permission to get the credential secret can access your Cloud DNS. ## Set up Knative -1. Follow the [instruction](../install/README.md) to install Knative on your +1. Follow the [instruction](../install/) to install Knative on your cluster. 1. Configure Knative to use your custom domain. diff --git a/hack/__pycache__/macros.cpython-36.pyc b/hack/__pycache__/macros.cpython-36.pyc new file mode 100644 index 00000000000..1d3d410e3e9 Binary files /dev/null and b/hack/__pycache__/macros.cpython-36.pyc differ diff --git a/template-docs-page.md b/template-docs-page.md index 769050ddf86..2066a80d833 100644 --- a/template-docs-page.md +++ b/template-docs-page.md @@ -84,7 +84,7 @@ Knative-specific stuff below. For example: ``` To complete the steps in this task, you must ..... meet/have/install/create/? the following: -- A Kubernetes cluster with [Knative installed](./docs/install/README.md). +- A Kubernetes cluster with [Knative installed](./docs/install/). - The latest version of ... running? - Privileges to ..... @@ -225,7 +225,7 @@ This is where you get past any of the non-Knative items so that you can focus on To complete the steps in this task, you must ..... meet/have/install/create/? the following: -- A Kubernetes cluster with [Knative installed](./docs/install/README.md). +- A Kubernetes cluster with [Knative installed](./docs/install/). - The latest version of ... running? - Privileges to .....