knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix broken links (from link checking report tool testing) (#1974) 

* fix more broken links

* fix markdown only link errors
This commit is contained in:
RichieEscarez 2019-11-12 16:37:27 -08:00 committed by Knative Prow Robot
parent 81720b70e3
commit 64e6495497
26 changed files with 49 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
community/samples/README.md
View File

@ -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

2
community/samples/serving/helloworld-clojure/README.md
View File

@ -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).

6
community/samples/serving/helloworld-dart/README.md
View File

@ -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

2
community/samples/serving/helloworld-haskell/README.md
View File

@ -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).

2
community/samples/serving/helloworld-java-micronaut/README.md
View File

@ -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).

2
community/samples/serving/helloworld-r/README.md
View File

@ -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).

2
community/samples/serving/helloworld-rserver/README.md
View File

@ -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).

2
community/samples/serving/helloworld-rust/README.md
View File

@ -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).

2
community/samples/serving/helloworld-swift/README.md
View File

@ -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).

2
community/samples/serving/helloworld-vertx/README.md
View File

@ -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).

1
docs/README.md
View File

@ -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)

2
docs/eventing/event-registry.md
View File

@ -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

4
docs/eventing/getting-started.md
View File

@ -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)

6
docs/eventing/samples/README.md Normal file
View File

@ -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)

7
docs/eventing/samples/_index.md
View File

@ -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" %}}

2
docs/eventing/samples/helloworld/README.md
View File

@ -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

4
docs/eventing/samples/iot-core/README.md
View File

@ -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
```

2
docs/eventing/samples/kafka/channel/README.md
View File

@ -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 -

20
docs/install/Knative-custom-install.md
View File

@ -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

2
docs/install/Knative-with-Ambassador.md
View File

@ -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/).

2
docs/install/Knative-with-GKE.md
View File

@ -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

6
docs/install/Knative-with-Gloo.md
View File

@ -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

6
docs/install/README.md
View File

@ -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

4
docs/install/installing-istio.md
View File

@ -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]:

2
docs/serving/cluster-local-route.md
View File

@ -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

6
docs/serving/samples/blue-green-deployment.md
View File

@ -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