From 0551f81dae72444cb896bf3c10b51f7055ace253 Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Thu, 8 Aug 2019 13:10:58 -0700 Subject: [PATCH] fix broken links (#1666) * fix broken links * set to branch release * fix image URLs too --- docs/eventing/README.md | 2 +- docs/eventing/channels/channels-crds.md | 2 +- docs/eventing/channels/channels.yaml | 4 ++-- docs/eventing/debugging/README.md | 2 +- docs/eventing/event-registry.md | 2 +- docs/install/Knative-with-Gardener.md | 4 ++-- docs/install/check-install-version.md | 4 ++-- docs/serving/accessing-metrics.md | 2 +- docs/serving/debugging-performance-issues.md | 10 +++++----- docs/serving/samples/autoscale-go/README.md | 4 ++-- docs/serving/samples/knative-routing-go/README.md | 5 +++-- 11 files changed, 21 insertions(+), 20 deletions(-) diff --git a/docs/eventing/README.md b/docs/eventing/README.md index 5ce5bcc32..660a92b04 100644 --- a/docs/eventing/README.md +++ b/docs/eventing/README.md @@ -336,7 +336,7 @@ to be installed into the current namespace. development purposes. See the -[CamelSource](https://github.com/knative/eventing-contrib/blob/master/contrib/camel/samples/README.md) +[CamelSource](https://github.com/knative/eventing-contrib/blob/master/contrib/camel/samples/) example. ## Getting Started diff --git a/docs/eventing/channels/channels-crds.md b/docs/eventing/channels/channels-crds.md index afa7c325c..29f14117f 100644 --- a/docs/eventing/channels/channels-crds.md +++ b/docs/eventing/channels/channels-crds.md @@ -31,7 +31,7 @@ Notes: | -------------------------------------------------------------------------------------------------------------- | ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------- | | [CCP - Apache Kafka](https://github.com/knative/eventing-contrib/tree/master/kafka/channel/config/provisioner) | Proof of Concept | None | Deprecated: Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. | | [CCP - GCP PubSub](https://github.com/knative/eventing/tree/master/contrib/gcppubsub/config) | Proof of Concept | None | Deprecated: Channels are backed by [GCP PubSub](https://cloud.google.com/pubsub/). | -| [CCP - In-Memory](https://github.com/knative/eventing/tree/master/config/provisioners/in-memory-channel) | Proof of Concept | None | Deprecated: In-memory channels are a best effort Channel. They should NOT be used in Production. They are useful for development. | +| [CCP - In-Memory](https://github.com/knative/eventing/tree/v0.8.0/config/provisioners/in-memory-channel) | Proof of Concept | None | Deprecated: In-memory channels are a best effort Channel. They should NOT be used in Production. They are useful for development. | | [CCP - Natss](https://github.com/knative/eventing/tree/master/contrib/natss/config/provisioner) | Proof of Concept | None | Deprecated: Channels are backed by [NATS Streaming](https://github.com/nats-io/nats-streaming-server#configuring). | | [CRD - InMemoryChannel](https://github.com/knative/eventing/tree/master/config/channels/in-memory-channel) | Proof of Concept | None | In-memory channels are a best effort Channel. They should NOT be used in Production. They are useful for development. | | [CRD - KafkaChannel](https://github.com/knative/eventing-contrib/tree/master/kafka/channel/config) | Proof of Concept | None | Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. | diff --git a/docs/eventing/channels/channels.yaml b/docs/eventing/channels/channels.yaml index 6d18ea13c..98d7ca1c0 100644 --- a/docs/eventing/channels/channels.yaml +++ b/docs/eventing/channels/channels.yaml @@ -1,7 +1,7 @@ # List of available Channel implementation for persistence of the events associated with a given channel channels: - - name: CCP - In-Memory - url: https://github.com/knative/eventing/tree/master/config/provisioners/in-memory-channel + - name: In-Memory + url: https://github.com/knative/eventing/tree/v0.8.0/config/provisioners/in-memory-channel status: Proof of Concept support: None description: > diff --git a/docs/eventing/debugging/README.md b/docs/eventing/debugging/README.md index 0a93e451a..8597f80b0 100644 --- a/docs/eventing/debugging/README.md +++ b/docs/eventing/debugging/README.md @@ -144,7 +144,7 @@ This should return a single Pod, which if you inspect is the one generated by ##### `chan` `chan` uses the -[`in-memory-channel`](https://github.com/knative/eventing/tree/master/config/provisioners/in-memory-channel) +[`in-memory-channel`](https://github.com/knative/eventing/tree/v0.8.0/config/provisioners/in-memory-channel) as its `ClusterChannelProvisioner`. This is a very basic provisioner and has few failure modes that will be exhibited in `chan`'s `status`. diff --git a/docs/eventing/event-registry.md b/docs/eventing/event-registry.md index 6b7e5ac5f..ee008f57c 100644 --- a/docs/eventing/event-registry.md +++ b/docs/eventing/event-registry.md @@ -258,7 +258,7 @@ the next topic: How do we actually populate the registry in the first place? If you are interested in more information regarding configuration options of a KafkaSource, please refer to the - [KafKaSource example](https://github.com/knative/eventing-contrib/tree/master/contrib/kafka/samples). + [KafKaSource example](https://github.com/knative/eventing-contrib/tree/master/kafka/source/samples). For this discussion, the relevant information from the yaml above are the `sink` and the `topics`. We observe that the `sink` is of kind `Broker`. We diff --git a/docs/install/Knative-with-Gardener.md b/docs/install/Knative-with-Gardener.md index 412e57fcc..801f7c99c 100644 --- a/docs/install/Knative-with-Gardener.md +++ b/docs/install/Knative-with-Gardener.md @@ -40,7 +40,7 @@ Knative requires a Kubernetes cluster v1.11 or newer. your project. You can skip this step if you create your cluster using the user interface; it is only needed for programmatic access, make sure you set `export KUBECONFIG=garden-my-project.yaml` in your shell. - ![Download kubeconfig for Gardener](../images/gardener_service_account.png "downloading the kubeconfig using a service account") + ![Download kubeconfig for Gardener](./images/gardener_service_account.png "downloading the kubeconfig using a service account") ### Creating a Kubernetes cluster @@ -56,7 +56,7 @@ kubectl apply --filename my-cluster.yaml The easier alternative is to create the cluster following the cluster creation wizard in the Gardener dashboard: -![shoot creation](../images/gardener_shoot_creation.png "shoot creation via the dashboard") +![shoot creation](./images/gardener_shoot_creation.png "shoot creation via the dashboard") ### Configure kubectl for your cluster diff --git a/docs/install/check-install-version.md b/docs/install/check-install-version.md index 22cea2a29..e42f1c52a 100644 --- a/docs/install/check-install-version.md +++ b/docs/install/check-install-version.md @@ -62,7 +62,7 @@ classification," and in that section is a list of tags. The versions of Knative you have installed will appear in the list as `v0.1.1`, or whatever version you have installed: -![Shows list of tags on container details page; v0.1.1 is the Knative version and is the first tag.](../../images/knative-version.png) +![Shows list of tags on container details page; v0.1.1 is the Knative version and is the first tag.](../images/knative-version.png) ## Knative Eventing @@ -98,4 +98,4 @@ classification," and in that section is a list of tags. The versions of Knative you have installed will appear in the list as `v0.1.1`, or whatever version you have installed: -![Shows list of tags on container details page; v0.1.1 is the Knative version and is the first tag.](../../images/knative-version.png) +![Shows list of tags on container details page; v0.1.1 is the Knative version and is the first tag.](../images/knative-version.png) diff --git a/docs/serving/accessing-metrics.md b/docs/serving/accessing-metrics.md index f1dbb6054..7b6d39dd1 100644 --- a/docs/serving/accessing-metrics.md +++ b/docs/serving/accessing-metrics.md @@ -26,7 +26,7 @@ $(kubectl get pods --namespace knative-monitoring \ 3. Select the **Home** button on the top of the page to see the list of pre-installed dashboards (screenshot below): - ![Knative Dashboards](../images/grafana1.png) + ![Knative Dashboards](./images/grafana1.png) The following dashboards are pre-installed with Knative Serving: diff --git a/docs/serving/debugging-performance-issues.md b/docs/serving/debugging-performance-issues.md index 46180806d..4e84e5265 100644 --- a/docs/serving/debugging-performance-issues.md +++ b/docs/serving/debugging-performance-issues.md @@ -21,7 +21,7 @@ Start your investigation with the "Revision - HTTP Requests" dashboard. 1. Select your configuration and revision from the menu on top left of the page. You will see a page like this: - ![Knative Serving - Revision HTTP Requests](../images/request_dash1.png) + ![Knative Serving - Revision HTTP Requests](./images/request_dash1.png) This dashboard gives visibility into the following for each revision: @@ -47,7 +47,7 @@ request. 1. Select your revision from the "Service Name" dropdown, and then click the "Find Traces" button. You'll get a view that looks like this: - ![Zipkin - Trace Overview](../images/zipkin1.png) + ![Zipkin - Trace Overview](./images/zipkin1.png) In this example, you can see that the request spent most of its time in the [span](https://github.com/opentracing/specification/blob/master/specification.md#the-opentracing-data-model) @@ -55,7 +55,7 @@ request. 1. Click that span to see a view like the following: - ![Zipkin - Span Details](../images/zipkin2.png) + ![Zipkin - Span Details](./images/zipkin2.png) This view shows detailed information about the specific span, such as the micro service or external URL that was called. In this example, the call to @@ -71,7 +71,7 @@ next. 1. To open the autoscaler dashboard, open Grafana UI and select "Knative Serving - Autoscaler" dashboard, which looks like this: - ![Knative Serving - Autoscaler](../images/autoscaler_dash1.png) + ![Knative Serving - Autoscaler](./images/autoscaler_dash1.png) This view shows 4 key metrics from the Knative Serving autoscaler: @@ -99,7 +99,7 @@ the traffic but was only granted 8 pods because the cluster is out of resources. You can access total CPU and memory usage of your revision from the "Knative Serving - Revision CPU and Memory Usage" dashboard, which looks like this: -![Knative Serving - Revision CPU and Memory Usage](../images/cpu_dash1.png) +![Knative Serving - Revision CPU and Memory Usage](./images/cpu_dash1.png) The first chart shows rate of the CPU usage across all pods serving the revision. The second chart shows total memory consumed across all pods serving diff --git a/docs/serving/samples/autoscale-go/README.md b/docs/serving/samples/autoscale-go/README.md index af7d56784..89557d541 100644 --- a/docs/serving/samples/autoscale-go/README.md +++ b/docs/serving/samples/autoscale-go/README.md @@ -256,9 +256,9 @@ View the Knative Serving Scaling and Request dashboards (if configured). kubectl port-forward --namespace knative-monitoring $(kubectl get pods --namespace knative-monitoring --selector=app=grafana --output=jsonpath="{.items..metadata.name}") 3000 ``` -![scale dashboard](scale-dashboard.png) +![scale dashboard](./scale-dashboard.png) -![request dashboard](request-dashboard.png) +![request dashboard](./request-dashboard.png) ### Other Experiments diff --git a/docs/serving/samples/knative-routing-go/README.md b/docs/serving/samples/knative-routing-go/README.md index 0bf47f0c2..885f2bf1b 100644 --- a/docs/serving/samples/knative-routing-go/README.md +++ b/docs/serving/samples/knative-routing-go/README.md @@ -274,13 +274,14 @@ with updated host will be forwarded to `knative-ingress-gateway` Gateway again. The Gateway proxy checks the updated host, and forwards it to `Search` or `Login` service according to its host setting. -![Object model](images/knative-routing-sample-flow.png) +![Object model](./images/knative-routing-sample-flow.png) ## Clean Up To clean up the sample resources: -``` +```shell kubectl delete --filename docs/serving/samples/knative-routing-go/sample.yaml kubectl delete --filename docs/serving/samples/knative-routing-go/routing.yaml ``` +