From 64e649549795e535bbbc32b3b47363b24e640b30 Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Tue, 12 Nov 2019 16:37:27 -0800 Subject: [PATCH] fix broken links (from link checking report tool testing) (#1974) * fix more broken links * fix markdown only link errors --- community/samples/README.md | 4 ++-- .../serving/helloworld-clojure/README.md | 2 +- .../samples/serving/helloworld-dart/README.md | 6 +++--- .../serving/helloworld-haskell/README.md | 2 +- .../helloworld-java-micronaut/README.md | 2 +- .../samples/serving/helloworld-r/README.md | 2 +- .../serving/helloworld-rserver/README.md | 2 +- .../samples/serving/helloworld-rust/README.md | 2 +- .../serving/helloworld-swift/README.md | 2 +- .../serving/helloworld-vertx/README.md | 2 +- docs/README.md | 1 - docs/eventing/event-registry.md | 2 +- docs/eventing/getting-started.md | 4 +--- docs/eventing/samples/README.md | 6 ++++++ docs/eventing/samples/_index.md | 7 ++----- docs/eventing/samples/helloworld/README.md | 2 +- docs/eventing/samples/iot-core/README.md | 4 ++-- docs/eventing/samples/kafka/channel/README.md | 2 +- docs/install/Knative-custom-install.md | 20 ++++++++----------- docs/install/Knative-with-Ambassador.md | 2 +- docs/install/Knative-with-GKE.md | 2 +- docs/install/Knative-with-Gloo.md | 6 +++--- docs/install/README.md | 6 +++--- docs/install/installing-istio.md | 4 ++-- docs/serving/cluster-local-route.md | 2 +- docs/serving/samples/blue-green-deployment.md | 6 +++--- 26 files changed, 49 insertions(+), 53 deletions(-) create mode 100644 docs/eventing/samples/README.md diff --git a/community/samples/README.md b/community/samples/README.md index 106bfa7f8..d3a0fccf4 100644 --- a/community/samples/README.md +++ b/community/samples/README.md @@ -6,7 +6,7 @@ original author is unable to maintain their contribution. If you find that something isn't working, lend a helping hand and fix it in a PR. [Learn more about the lifespan of samples](../../contributing/DOCS-CONTRIBUTING.md). -[**See all Knative code samples**](../../docs/samples/) +[**See all Knative code samples**](../../docs/samples.md) ### Serving samples @@ -14,7 +14,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), [R](./serving/hellowolrd-rserver/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/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) | #### Eventing and Eventing Resources samples diff --git a/community/samples/serving/helloworld-clojure/README.md b/community/samples/serving/helloworld-clojure/README.md index 327278b35..16c7af06c 100644 --- a/community/samples/serving/helloworld-clojure/README.md +++ b/community/samples/serving/helloworld-clojure/README.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](../../../install/README.md) if you need to create + [installation instructions](../../../../docs/install/README.md) 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-dart/README.md b/community/samples/serving/helloworld-dart/README.md index 47afed5d8..a71a2f586 100644 --- a/community/samples/serving/helloworld-dart/README.md +++ b/community/samples/serving/helloworld-dart/README.md @@ -5,7 +5,7 @@ weight: 1 type: "docs" --- -A simple web app written in the [Dart](www.dartlang.org) programming language +A simple web app written in the [Dart](https://www.dart.dev) programming language that you can use for testing. It reads in the env variable `TARGET` and prints `"Hello $TARGET"`. If `TARGET` is not specified, it will use `"World"` as `TARGET`. @@ -13,11 +13,11 @@ 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](../../../install/README.md) if you need to create + [installation instructions](../../../../docs/install/README.md) 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). -- [dart-sdk](https://www.dartlang.org/tools/sdk#install) installed and +- [dart-sdk](https://www.dart.dev/tools/sdk#install) installed and configured if you want to run the program locally. ## Recreating the sample code diff --git a/community/samples/serving/helloworld-haskell/README.md b/community/samples/serving/helloworld-haskell/README.md index 458d74bc3..bc4b88333 100644 --- a/community/samples/serving/helloworld-haskell/README.md +++ b/community/samples/serving/helloworld-haskell/README.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](../../../install/README.md) if you need to create + [installation instructions](../../../../docs/install/README.md) 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-java-micronaut/README.md b/community/samples/serving/helloworld-java-micronaut/README.md index 13877bdb2..05a83a31d 100644 --- a/community/samples/serving/helloworld-java-micronaut/README.md +++ b/community/samples/serving/helloworld-java-micronaut/README.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](../../../../install/README.md) if you need + [Knative installation instructions](../../../../docs/install/README.md) 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-r/README.md b/community/samples/serving/helloworld-r/README.md index 4bcc1b0e7..688bd71ac 100644 --- a/community/samples/serving/helloworld-r/README.md +++ b/community/samples/serving/helloworld-r/README.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](../../../../install/README.md) if you need to + [installation instructions](../../../../docs/install/README.md) 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-rserver/README.md b/community/samples/serving/helloworld-rserver/README.md index 0aa8a1edf..4c87f2a37 100644 --- a/community/samples/serving/helloworld-rserver/README.md +++ b/community/samples/serving/helloworld-rserver/README.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](../../../../install/README.md) if you need to + [installation instructions](../../../../docs/install/README.md) 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/README.md b/community/samples/serving/helloworld-rust/README.md index e50333785..0dd7ed040 100644 --- a/community/samples/serving/helloworld-rust/README.md +++ b/community/samples/serving/helloworld-rust/README.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](../../../install/README.md) if you need to create + [installation instructions](../../../../docs/install/README.md) 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/README.md b/community/samples/serving/helloworld-swift/README.md index 167bae6ed..5ea4b7c1d 100644 --- a/community/samples/serving/helloworld-swift/README.md +++ b/community/samples/serving/helloworld-swift/README.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](../../../install/README.md). + [installation instructions](../../../../docs/install/README.md). - 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/README.md b/community/samples/serving/helloworld-vertx/README.md index b98c35fca..afe70544f 100644 --- a/community/samples/serving/helloworld-vertx/README.md +++ b/community/samples/serving/helloworld-vertx/README.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](../../../install/README.md) if you need to + [Knative installation instructions](../../../../docs/install/README.md) 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/docs/README.md b/docs/README.md index 6a38a99e8..ae48c5a9d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -82,7 +82,6 @@ Follow the links below to learn more about Knative. ### Configuration and networking -- [Configuring outbound network access](./serving/outbound-network-access.md) - [Using a custom domain](./serving/using-a-custom-domain.md) - [Assigning a static IP address for Knative on Google Kubernetes Engine](./serving/gke-assigning-static-ip-address.md) - [Configuring HTTPS with a custom certificate](./serving/using-a-tls-cert.md) diff --git a/docs/eventing/event-registry.md b/docs/eventing/event-registry.md index f064a3468..82a030bb9 100644 --- a/docs/eventing/event-registry.md +++ b/docs/eventing/event-registry.md @@ -276,7 +276,7 @@ the next topic: How do we actually populate the registry in the first place? 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 +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. [Knative code samples](./samples/) is a useful resource to better understand diff --git a/docs/eventing/getting-started.md b/docs/eventing/getting-started.md index 8de735b2e..c2ce8bccd 100644 --- a/docs/eventing/getting-started.md +++ b/docs/eventing/getting-started.md @@ -514,6 +514,4 @@ This removes the namespace and all of its resources from your cluster. You've learned the basics of the Knative Eventing workflow. Here are some additional resources to help you continue to build with the Knative Eventing component. - [Broker and Trigger](./broker-trigger.md) -- [Eventing with a GitHub source](./samples/github-source.md) - - +- [Eventing with a GitHub source](./samples/github-source/README.md) diff --git a/docs/eventing/samples/README.md b/docs/eventing/samples/README.md new file mode 100644 index 000000000..de8ae6360 --- /dev/null +++ b/docs/eventing/samples/README.md @@ -0,0 +1,6 @@ + +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). + +[**See all Knative code samples**](../../samples.md) diff --git a/docs/eventing/samples/_index.md b/docs/eventing/samples/_index.md index 11e5a6b82..ced31b7ba 100644 --- a/docs/eventing/samples/_index.md +++ b/docs/eventing/samples/_index.md @@ -3,10 +3,7 @@ title: "Knative Eventing code samples" linkTitle: "Code samples" weight: 90 type: "docs" +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](../index.html). - -[**See all Knative code samples**](../../samples/) +{{% readfile file="README.md" %}} diff --git a/docs/eventing/samples/helloworld/README.md b/docs/eventing/samples/helloworld/README.md index 2439b2f01..ccf46cb49 100644 --- a/docs/eventing/samples/helloworld/README.md +++ b/docs/eventing/samples/helloworld/README.md @@ -1,6 +1,6 @@ Following examples include a simple web app written in the language of your choice 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. -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) +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) ## Prerequisites diff --git a/docs/eventing/samples/iot-core/README.md b/docs/eventing/samples/iot-core/README.md index 9e59a0039..e57985f6f 100644 --- a/docs/eventing/samples/iot-core/README.md +++ b/docs/eventing/samples/iot-core/README.md @@ -87,7 +87,7 @@ export IOTCORE_TOPIC_DEVICE="iot-demo-device-pubsub-topic" controller. ```shell - kubectl apply --filename https://github.com/knative/eventing-contrib/releases/download/{{< version >}}/gcppubsub.yaml + kubectl apply --filename https://github.com/knative/eventing-contrib/releases/download/v0.8.2/gcppubsub.yaml ``` ### Deploying @@ -214,5 +214,5 @@ To cleanup the knative resources: 1. Remove the `GcpPubSubSource` controller: ```shell - kubectl delete --filename https://github.com/knative/eventing-contrib/releases/download/{{< version >}}/gcppubsub.yaml + kubectl delete --filename https://github.com/knative/eventing-contrib/releases/download/v0.8.2/gcppubsub.yaml ``` diff --git a/docs/eventing/samples/kafka/channel/README.md b/docs/eventing/samples/kafka/channel/README.md index 7a560f870..11cab8605 100644 --- a/docs/eventing/samples/kafka/channel/README.md +++ b/docs/eventing/samples/kafka/channel/README.md @@ -47,7 +47,7 @@ You can now set the `KafkaChannel` CRD as the default channel configuration. ## Specifying the default channel configuration -To configure the usage of the `KafkaChannel` CRD as the [default channel configuration](channels/default-channels.md), edit the `default-ch-webhook` ConfigMap as follows: +To configure the usage of the `KafkaChannel` CRD as the [default channel configuration](../../../channels/default-channels.md), edit the `default-ch-webhook` ConfigMap as follows: ``` cat <<-EOF | kubectl apply -f - diff --git a/docs/install/Knative-custom-install.md b/docs/install/Knative-custom-install.md index 75c0eb634..391ff9645 100644 --- a/docs/install/Knative-custom-install.md +++ b/docs/install/Knative-custom-install.md @@ -44,10 +44,8 @@ managed Istio installation, or if you're installing Knative locally using Minkube or similar, see the [Installing Istio for Knative guide](./installing-istio.md). -> Note: [Ambassador](https://www.getambassador.io/) and -> [Gloo](https://gloo.solo.io/) are available as an alternative to Istio. -> [Click here](./Knative-with-Ambassador.md) to install Knative with Ambassador. -> [Click here](./Knative-with-Gloo.md) to install Knative with Gloo. +> Note: [Ambassador](./Knative-with-Ambassador.md) and +> [Gloo](./Knative-with-Gloo.md) are available as an alternative to Istio. ## Installing Knative components @@ -83,8 +81,7 @@ The following Knative installation files are available: - **Eventing Resources**: - https://github.com/knative/eventing-contrib/releases/download/{{< version >}}/github.yaml - https://github.com/knative/eventing-contrib/releases/download/{{< version >}}/camel.yaml - - https://github.com/knative/eventing-contrib/releases/download/{{< version >}}/gcppubsub.yaml - - https://github.com/knative/eventing-contrib/releases/download/{{< version >}}/kafka.yaml + - https://github.com/knative/eventing-contrib/releases/download/{{< version >}}/kafka-source.yaml - https://github.com/knative/eventing-contrib/releases/download/{{< version >}}/kafka-channel.yaml #### Install details and options @@ -110,14 +107,14 @@ files from the Knative repositories: | [`monitoring-tracing-zipkin.yaml`][1.80] | Installs only [Zipkin][2.30].**\*** | Serving or Eventing component, ELK stack (monitoring-logs-elasticsearch.yaml) | | [`monitoring-tracing-zipkin-in-mem.yaml`][1.90] | Installs only [Zipkin in-memory][2.30]**\*** | Serving or Eventing component | | **knative/eventing** | | | -| [`release.yaml`][4.1]† | Installs the Eventing component. Includes [ContainerSource](../eventing#containersource), [CronJobSource][6.2], InMemoryChannel. | | -| [`eventing.yaml`][4.2] | Installs the Eventing component. Includes [ContainerSource](../eventing#containersource) and [CronJobSource][6.2]. Does not include any Channel. | | -| [`in-memory-channel.yaml`][4.3] | Installs only the InMemoryChannel. | Eventing component | +| [`release.yaml`][4.10]† | Installs the Eventing component. Includes [ContainerSource](../eventing#containersource), [CronJobSource][6.2], InMemoryChannel. | | +| [`eventing.yaml`][4.20] | Installs the Eventing component. Includes [ContainerSource](../eventing#containersource) and [CronJobSource][6.2]. Does not include any Channel. | | +| [`in-memory-channel.yaml`][4.30] | Installs only the InMemoryChannel. | Eventing component | | **knative/eventing-contrib** | | | | [`github.yaml`][5.10]† | Installs the [GitHub][6.10] source. | Eventing component | | [`camel.yaml`][5.40] | Installs the Apache Camel source. | Eventing component | | [`kafka-source.yaml`][5.50] | Installs the Apache Kafka source. | Eventing component | -| [`kafka-channel.yaml`][5.60] | Installs the KafkaChannel. | Eventing component | +| [`kafka-channel.yaml`][5.60] | Installs the Kafka channel. | Eventing component | | [`awssqs.yaml`][5.70] | Installs the AWS SQS source. | Eventing component | | [`event-display.yaml`][5.30] | Installs a Knative Service that logs events received for use in samples and debugging. | Serving component, Eventing component | | [`natss-channel.yaml`][5.80] | Installs the NATS streaming channel implementation. | Eventing component | @@ -161,7 +158,6 @@ for details about installing the various supported observability plugins. https://github.com/knative/eventing/releases/download/{{< version >}}/eventing.yaml [4.30]: https://github.com/knative/eventing/releases/download/{{< version >}}/in-memory-channel.yaml -[4.40]: https://github.com/knative/eventing/releases/download/{{< version >}}/kafka.yaml [5.0]: https://github.com/knative/eventing-contrib/releases/tag/{{< version >}} [5.10]: https://github.com/knative/eventing-contrib/releases/download/{{< version >}}/github.yaml @@ -176,7 +172,7 @@ for details about installing the various supported observability plugins. [5.70]: https://github.com/knative/eventing-contrib/releases/download/{{< version >}}/awssqs.yaml [5.80]: - https://github.com/knative/eventing-contrib/releases/download/{{< version >}}/natss.yaml + https://github.com/knative/eventing-contrib/releases/download/{{< version >}}/natss-channel.yaml [6.10]: https://developer.github.com/v3/activity/events/types/ [6.20]: https://github.com/knative/eventing-contrib/blob/master/samples/cronjob-source/README.md diff --git a/docs/install/Knative-with-Ambassador.md b/docs/install/Knative-with-Ambassador.md index dd62dc41c..48b14f388 100644 --- a/docs/install/Knative-with-Ambassador.md +++ b/docs/install/Knative-with-Ambassador.md @@ -159,7 +159,7 @@ manage and route to serverless applications! ## What's next - Try the - [Getting Started with App Deployment guide](../serving/getting-started-knative-app/) + [Getting Started with App Deployment guide](../serving/getting-started-knative-app.md) for Knative serving. - Get started with Knative Eventing by walking through one of the [Eventing Samples](../eventing/samples/). diff --git a/docs/install/Knative-with-GKE.md b/docs/install/Knative-with-GKE.md index 4f08c9ed6..6dd0a89a7 100644 --- a/docs/install/Knative-with-GKE.md +++ b/docs/install/Knative-with-GKE.md @@ -123,7 +123,7 @@ the recommended configuration for a cluster is: > Note: If you want to use [Auto TLS feature](../serving/using-auto-tls.md), you > need to remove the `--addons` line below, and follow the -> [instructions](../installing-istio.md) to install Istio with Secret Discovery +> [instructions](./installing-istio.md) to install Istio with Secret Discovery > Service. ```bash diff --git a/docs/install/Knative-with-Gloo.md b/docs/install/Knative-with-Gloo.md index 7272d347c..c8858f6c2 100644 --- a/docs/install/Knative-with-Gloo.md +++ b/docs/install/Knative-with-Gloo.md @@ -8,7 +8,7 @@ type: "docs" Learn how to deploy Gloo and Knative to your Kubernetes cluster using the Gloo command line tool `glooctl`. -[Gloo](https://gloo.solo.io) is a popular open-source Envoy control plane and API gateway built for Kubernetes (and other platforms). +[Gloo](https://docs.solo.io/gloo/latest/) is a popular open-source Envoy control plane and API gateway built for Kubernetes (and other platforms). Gloo provides a complete gateway replacement for Istio and supports the full Knative Ingress spec. Choose Gloo if you don't require a service mesh in your cluster and want a lightweight alternative that requires less resource usage and operational overhead. @@ -61,7 +61,7 @@ The `glooctl install knative` command can be customized with a variety of option See https://github.com/solo-io/gloo/blob/master/docs/cli/glooctl_install_knative.md for the full list of available options for installing Knative with `glooctl` > Note: `glooctl` generates a manifest which can be piped to stdout or a file using the `--dry-run` flag. Alternatively, -Gloo can be installed via its [Helm Chart](https://gloo.solo.io/installation/gateway/kubernetes/#installing-on-kubernetes-with-helm), which will permit fine-grained configuration of installation parameters. +Gloo can be installed via its [Helm Chart](https://docs.solo.io/gloo/latest/installation/gateway/kubernetes/#installing-on-kubernetes-with-helm), which will permit fine-grained configuration of installation parameters. Monitor the Gloo and Knative components until each one shows a `STATUS` of `Running` or `Completed`: @@ -179,7 +179,7 @@ Now that your cluster has Knative installed, you can see what Knative has to offer. Learn more about deploying apps to Knative with the -[Getting Started with Knative App Deployment](./getting-started-knative-app.md) +[Getting Started with Knative App Deployment](../serving/getting-started-knative-app.md) guide. To get started with Knative Eventing, pick one of the diff --git a/docs/install/README.md b/docs/install/README.md index 2b8477520..fc13e75a6 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -24,7 +24,7 @@ Knative Services. Currently, three options exist which provide this functionality: [Ambassador](https://www.getambassador.io/), an Envoy-based API Gateway, -[Gloo](https://gloo.solo.io), an Envoy-based API Gateway, and +[Gloo](https://docs.solo.io/gloo/latest/), an Envoy-based API Gateway, and [Istio](https://istio.io/), an Envoy-based Service Mesh. ## Installing Knative with Ambassador @@ -99,7 +99,7 @@ custom install guide: > **Note**: If need to set up a Kubernetes cluster with the correct > specifications to run Knative, you can follow any of the install instructions > through the creation of the cluster, then follow the -> [Performing a Custom Knative Installation](./knative-custom-install.md) guide. +> [Performing a Custom Knative Installation](./Knative-custom-install.md) guide. **Observability install guide** @@ -130,7 +130,7 @@ and set up TLS certificates to use HTTPS: - [Assign a static IP address](../serving/gke-assigning-static-ip-address.md) - [Configure a custom domain](../serving/using-a-custom-domain.md) -- [Configuring HTTPS with a custom certificate](../serving/using-an-ssl-cert.md) +- [Configuring HTTPS with a custom certificate](../serving/using-a-tls-cert.md) ## Checking the version of your Knative Serving installation diff --git a/docs/install/installing-istio.md b/docs/install/installing-istio.md index 209092dbe..8e6f70510 100644 --- a/docs/install/installing-istio.md +++ b/docs/install/installing-istio.md @@ -13,7 +13,7 @@ installation. If your cloud platform offers a managed Istio installation, the [install guide](./README.md) for your specific platform will have those instructions. -For example, the [GKE Install Guide](./knative-with-gke.md) includes the +For example, the [GKE Install Guide](./Knative-with-GKE.md) includes the instructions for installing Istio on your cluster using `gcloud`. ## Before you begin @@ -317,7 +317,7 @@ rm -rf istio-${ISTIO_VERSION} - [Install Knative](./README.md). - Try the - [Getting Started with App Deployment guide](../serving/getting-started-knative-app/) + [Getting Started with App Deployment guide](../serving/getting-started-knative-app.md) for Knative serving. [1]: diff --git a/docs/serving/cluster-local-route.md b/docs/serving/cluster-local-route.md index 18064082b..bf0d2e7ab 100644 --- a/docs/serving/cluster-local-route.md +++ b/docs/serving/cluster-local-route.md @@ -44,7 +44,7 @@ To label a route: kubectl label route ${ROUTE_NAME} serving.knative.dev/visibility=cluster-local ``` -For example, you can deploy the [Hello World sample](./samples/helloworld-go) +For example, you can deploy the [Hello World sample](./samples/hello-world/helloworld-go/README.md) and then convert it to be an cluster-local service by labeling the service: ```shell diff --git a/docs/serving/samples/blue-green-deployment.md b/docs/serving/samples/blue-green-deployment.md index 3cb9bd5d2..d9cf5b36e 100644 --- a/docs/serving/samples/blue-green-deployment.md +++ b/docs/serving/samples/blue-green-deployment.md @@ -169,7 +169,7 @@ route "blue-green-demo" configured Revision 2 of the app is staged at this point. That means: - No traffic will be routed to revision 2 at the main URL, - http://blue-green-demo.default.YOUR_CUSTOM_DOMAIN.com + `http://blue-green-demo.default.[YOUR_CUSTOM_DOMAIN].com` - Knative creates a new route named v2 for testing the newly deployed version. The URL of this can be seen in the status section of your Route. @@ -209,7 +209,7 @@ route "blue-green-demo" configured ``` Refresh the original route -(http://blue-green-demo.default.YOUR_CUSTOM_DOMAIN.com) a few times to see that +(`http://blue-green-demo.default.[YOUR_CUSTOM_DOMAIN].com`) a few times to see that some traffic now goes to version 2 of the app. > Note: This sample shows a 50/50 split to assure you don't have to refresh too @@ -246,7 +246,7 @@ route "blue-green-demo" configured ``` Refresh the original route -(http://blue-green-demo.default.YOUR_CUSTOM_DOMAIN.com) a few times to verify +(`http://blue-green-demo.default.[YOUR_CUSTOM_DOMAIN].com`) a few times to verify that no traffic is being routed to v1 of the app. We added a named route to v1 of the app, so you can now access it at the URL