Remove README.md from all links (#855)

* Remove README.md from all links

* mend

* mend

* mend
This commit is contained in:
Sam O'Dell 2019-02-01 17:08:37 -08:00 committed by Richie Escarez
parent 15dfa0f63e
commit 2029c8bccb
82 changed files with 103 additions and 102 deletions

View File

@ -61,7 +61,7 @@ efficient contributor workflow.
Knative is a diverse, open, and inclusive community. To get involved, see Knative is a diverse, open, and inclusive community. To get involved, see
[CONTRIBUTING.md](./community/CONTRIBUTING.md) and join the [CONTRIBUTING.md](./community/CONTRIBUTING.md) and join the
[Knative community](./community/README.md). [Knative community](./community/).
Your own path to becoming a Knative contributor can Your own path to becoming a Knative contributor can
[begin anywhere](https://github.com/knative/serving/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Akind%2Fgood-first-issue). [begin anywhere](https://github.com/knative/serving/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Akind%2Fgood-first-issue).
@ -74,7 +74,7 @@ Follow the links below to learn more about Knative.
### Getting started ### Getting started
- [Installing Knative](./install/README.md) - [Installing Knative](./install/)
- [Getting started with app deployment](./install/getting-started-knative-app.md) - [Getting started with app deployment](./install/getting-started-knative-app.md)
- [Getting started with serving](./serving) - [Getting started with serving](./serving)
- [Getting started with builds](./build) - [Getting started with builds](./build)
@ -89,11 +89,11 @@ Follow the links below to learn more about Knative.
### Samples and demos ### Samples and demos
- [Autoscaling](./serving/samples/autoscale-go/README.md) - [Autoscaling](./serving/samples/autoscale-go/)
- [Source-to-URL deployment](./serving/samples/source-to-url-go/README.md) - [Source-to-URL deployment](./serving/samples/source-to-url-go/)
- [Binding running services to eventing ecosystems](./eventing/samples/kubernetes-event-source) - [Binding running services to eventing ecosystems](./eventing/samples/kubernetes-event-source)
- [Telemetry](./serving/samples/telemetry-go/README.md) - [Telemetry](./serving/samples/telemetry-go/)
- [REST API sample](./serving/samples/rest-api-go/README.md) - [REST API sample](./serving/samples/rest-api-go/)
- [All samples for serving](./serving/samples/) - [All samples for serving](./serving/samples/)
- [All samples for eventing](./eventing/samples/) - [All samples for eventing](./eventing/samples/)

View File

@ -7,4 +7,4 @@ menu:
weight: 20 weight: 20
--- ---
{{% readfile file="docs/README.md" markdown="true" %}} {{% readfile file="docs/" markdown="true" %}}

View File

@ -12,7 +12,7 @@ action, you can define a Knative `Build` through a single configuration file.
Also consider using a Knative `Build` to build the source code of your apps into Also consider using a Knative `Build` to build the source code of your apps into
container images, which you can then run on container images, which you can then run on
[Knative `serving`](https://github.com/knative/docs/blob/master/serving/README.md). [Knative `serving`](https://github.com/knative/docs/blob/master/serving/).
More information about this use case is demonstrated in More information about this use case is demonstrated in
[this sample](https://github.com/knative/docs/blob/master/serving/samples/source-to-url-go). [this sample](https://github.com/knative/docs/blob/master/serving/samples/source-to-url-go).
@ -49,7 +49,7 @@ Before you can run a Knative Build, you must install the Knative Build component
in your Kubernetes cluster: in your Kubernetes cluster:
- For details about installing a new instance of Knative in your Kubernetes - For details about installing a new instance of Knative in your Kubernetes
cluster, see [Installing Knative](../install/README.md). cluster, see [Installing Knative](../install/).
- If you have a component of Knative installed and running, you can - If you have a component of Knative installed and running, you can
[add and install the Knative Build component](installing-build-component.md). [add and install the Knative Build component](installing-build-component.md).

View File

@ -4,4 +4,4 @@ linkTitle: "Build Component"
weight: 20 weight: 20
--- ---
{{% readfile file="docs/build/README.md" markdown="true" %}} {{% readfile file="docs/build/" markdown="true" %}}

View File

@ -24,7 +24,7 @@ Before you can run a Knative Build, you must have Knative installed in your
Kubernetes cluster, and it must include the Knative Build component: Kubernetes cluster, and it must include the Knative Build component:
- For details about installing a new instance of Knative in your Kubernetes - For details about installing a new instance of Knative in your Kubernetes
cluster, see [Installing Knative](../install/README.md). cluster, see [Installing Knative](../install/).
- If you have a component of Knative installed and running, you must - If you have a component of Knative installed and running, you must
[ensure that the Knative Build component is also installed](installing-build-component.md). [ensure that the Knative Build component is also installed](installing-build-component.md).

View File

@ -15,7 +15,7 @@ want, for example Knative serving is not required to create and run builds.
You must have a component of Knative installed and running in your Kubernetes You must have a component of Knative installed and running in your Kubernetes
cluster. For complete installation instructions, including how to install the cluster. For complete installation instructions, including how to install the
Knative Build component, see [Installing Knative](../install/README.md). Knative Build component, see [Installing Knative](../install/).
## Adding the Knative Build component ## Adding the Knative Build component

View File

@ -67,7 +67,7 @@ Learn more about Eventing development in the
Knative Eventing currently requires Knative Serving and Istio version 1.0 or Knative Eventing currently requires Knative Serving and Istio version 1.0 or
later installed. later installed.
[Follow the instructions to install on the platform of your choice](../install/README.md). [Follow the instructions to install on the platform of your choice](../install/).
Many of the sources require making outbound connections to create the event Many of the sources require making outbound connections to create the event
subscription, and if you have any functions that make use of any external (to subscription, and if you have any functions that make use of any external (to
@ -133,6 +133,7 @@ part of the `sources` category, so you can list all existing Sources with
_Want to implement your own source? Check out _Want to implement your own source? Check out
[the tutorial](samples/writing-a-source/README.md)._ [the tutorial](samples/writing-a-source/README.md)._
### KubernetesEventSource ### KubernetesEventSource
The KubernetesEventSource fires a new event each time a The KubernetesEventSource fires a new event each time a
@ -246,7 +247,7 @@ The CronJobSource fires events based on given
## Getting Started ## Getting Started
- [Setup Knative Serving](../install/README.md) - [Setup Knative Serving](../install/)
- [Install Eventing components](#installation) - [Install Eventing components](#installation)
- [Run samples](samples/) - [Run samples](samples/)

View File

@ -5,4 +5,4 @@ weight: 60
type: "docs" type: "docs"
--- ---
{{% readfile file="docs/eventing/README.md" markdown="true" %}} {{% readfile file="docs/eventing/" markdown="true" %}}

View File

@ -5,4 +5,4 @@ weight: 40
type: "docs" type: "docs"
--- ---
{{% readfile file="docs/eventing/channels/README.md" markdown="true" %}} {{% readfile file="docs/eventing/channels/" markdown="true" %}}

View File

@ -30,7 +30,7 @@ import (
var ( var (
yamlFile = flag.String("yaml", "eventing/channels/channels.yaml", "The YAML file to parse to generate the mark down.") yamlFile = flag.String("yaml", "eventing/channels/channels.yaml", "The YAML file to parse to generate the mark down.")
templateFile = flag.String("template", "eventing/channels/generator/ReadmeTemplate.gomd", "The template file to fill in.") templateFile = flag.String("template", "eventing/channels/generator/ReadmeTemplate.gomd", "The template file to fill in.")
mdFile = flag.String("md", "eventing/channels/README.md", "The mark down file to write to. Any existing file will be overwritten.") mdFile = flag.String("md", "eventing/channels/", "The mark down file to write to. Any existing file will be overwritten.")
) )
func main() { func main() {

View File

@ -5,4 +5,4 @@ weight: 80
type: "docs" type: "docs"
--- ---
{{% readfile file="docs/eventing/debugging/README.md" markdown="true" %}} {{% readfile file="docs/eventing/debugging/" markdown="true" %}}

View File

@ -5,4 +5,4 @@ weight: 10
type: "docs" type: "docs"
--- ---
{{% readfile file="docs/eventing/samples/cronjob-source/README.md" markdown="true" %}} {{% readfile file="docs/eventing/samples/cronjob-source/" markdown="true" %}}

View File

@ -5,4 +5,4 @@ weight: 20
type: "docs" type: "docs"
--- ---
{{% readfile file="docs/eventing/samples/gcp-pubsub-source/README.md" markdown="true" %}} {{% readfile file="docs/eventing/samples/gcp-pubsub-source/" markdown="true" %}}

View File

@ -10,7 +10,7 @@ You will need:
1. An internet-accessible Kubernetes cluster with Knative Serving 1. An internet-accessible Kubernetes cluster with Knative Serving
installed. Follow the [installation installed. Follow the [installation
instructions](https://github.com/knative/docs/blob/master/install/README.md) instructions](https://github.com/knative/docs/blob/master/install/)
if you need to create one. if you need to create one.
1. Ensure Knative Serving is [configured with a domain 1. Ensure Knative Serving is [configured with a domain
name](https://github.com/knative/docs/blob/master/serving/using-a-custom-domain.md) name](https://github.com/knative/docs/blob/master/serving/using-a-custom-domain.md)

View File

@ -5,4 +5,4 @@ weight: 30
type: "docs" type: "docs"
--- ---
{{% readfile file="docs/eventing/samples/github-source/README.md" markdown="true" %}} {{% readfile file="docs/eventing/samples/github-source/" markdown="true" %}}

View File

@ -5,4 +5,4 @@ weight: 40
type: "docs" type: "docs"
--- ---
{{% readfile file="docs/eventing/samples/iot-core/README.md" markdown="true" %}} {{% readfile file="docs/eventing/samples/iot-core/" markdown="true" %}}

View File

@ -5,4 +5,4 @@ weight: 50
type: "docs" type: "docs"
--- ---
{{% readfile file="docs/eventing/samples/kubernetes-event-source/README.md" markdown="true" %}} {{% readfile file="docs/eventing/samples/kubernetes-event-source/" markdown="true" %}}

View File

@ -5,4 +5,4 @@ weight: 60
type: "docs" type: "docs"
--- ---
{{% readfile file="docs/eventing/samples/writing-a-source/README.md" markdown="true" %}} {{% readfile file="docs/eventing/samples/writing-a-source/" markdown="true" %}}

View File

@ -5,4 +5,4 @@ weight: 20
type: "docs" type: "docs"
--- ---
{{% readfile file="docs/eventing/sources/README.md" markdown="true" %}} {{% readfile file="docs/eventing/sources/" markdown="true" %}}

View File

@ -30,7 +30,7 @@ import (
var ( var (
yamlFile = flag.String("yaml", "eventing/sources/sources.yaml", "The YAML file to parse to generate the mark down.") yamlFile = flag.String("yaml", "eventing/sources/sources.yaml", "The YAML file to parse to generate the mark down.")
templateFile = flag.String("template", "eventing/sources/generator/ReadmeTemplate.gomd", "The template file to fill in.") templateFile = flag.String("template", "eventing/sources/generator/ReadmeTemplate.gomd", "The template file to fill in.")
mdFile = flag.String("md", "eventing/sources/README.md", "The mark down file to write to. Any existing file will be overwritten.") mdFile = flag.String("md", "eventing/sources/", "The mark down file to write to. Any existing file will be overwritten.")
) )
func main() { func main() {

View File

@ -15,7 +15,7 @@ to run multiple installation commands.
## Before you begin ## Before you begin
- If you are new to Knative, you should instead - If you are new to Knative, you should instead
[follow one of the platform-specific installation guides](./README.md) to help [follow one of the platform-specific installation guides](./) to help
you get up and running quickly. you get up and running quickly.
- The steps in this guide use `bash` for the MacOS or Linux environment; for - The steps in this guide use `bash` for the MacOS or Linux environment; for
@ -344,12 +344,12 @@ guides to help you get started with Knative:
- [Getting Started with Knative App Deployment](./getting-started-knative-app.md) - [Getting Started with Knative App Deployment](./getting-started-knative-app.md)
- [Knative Serving sample apps](../serving/samples/README.md) - [Knative Serving sample apps](../serving/samples/)
- [Creating a simple Knative Build](../build/creating-builds.md) - [Creating a simple Knative Build](../build/creating-builds.md)
- [Knative Build templates](https://github.com/knative/build-templates) - [Knative Build templates](https://github.com/knative/build-templates)
- [Knative Eventing overview](../eventing/README.md) - [Knative Eventing overview](../eventing/)
- [Knative Eventing code samples](../eventing/samples) - [Knative Eventing code samples](../eventing/samples)

View File

@ -7,7 +7,7 @@ weight: 15
This guide walks you through the installation of the latest version of Knative This guide walks you through the installation of the latest version of Knative
using pre-built images. using pre-built images.
You can find [guides for other platforms here](README.md). You can find [guides for other platforms here](../).
## Before you begin ## Before you begin

View File

@ -9,7 +9,7 @@ This guide walks you through the installation of the latest version of
demonstrates creating and deploying an image of a sample "hello world" app onto demonstrates creating and deploying an image of a sample "hello world" app onto
the newly created Knative cluster. the newly created Knative cluster.
You can find [guides for other platforms here](README.md). You can find [guides for other platforms here](../).
## Before you begin ## Before you begin
@ -103,7 +103,7 @@ Knative, check out the
guide. guide.
If you'd like to view the available sample apps and deploy one of your choosing, If you'd like to view the available sample apps and deploy one of your choosing,
head to the [sample apps](../serving/samples/README.md) repo. head to the [sample apps](../serving/samples/) repo.
> Note: You can replace the {IP_ADDRESS} placeholder used in the samples with > Note: You can replace the {IP_ADDRESS} placeholder used in the samples with
> `localhost` as mentioned above. > `localhost` as mentioned above.

View File

@ -7,7 +7,7 @@ weight: 15
This guide walks you through the installation of the latest version of all This guide walks you through the installation of the latest version of all
Knative components using pre-built images. Knative components using pre-built images.
You can find [guides for other platforms here](README.md). You can find [guides for other platforms here](../).
## Before you begin ## Before you begin

View File

@ -7,13 +7,13 @@ weight: 10
This guide walks you through the installation of the latest version of Knative This guide walks you through the installation of the latest version of Knative
using pre-built images on a [Gardener](https://gardener.cloud) created cluster using pre-built images on a [Gardener](https://gardener.cloud) created cluster
environment. To set up your own Gardener, see the environment. To set up your own Gardener, see the
[documentation](https://github.com/gardener/gardener/blob/master/docs/README.md) [documentation](https://github.com/gardener/gardener/blob/master/docs/)
or have a look at the or have a look at the
[landscape-setup-template](https://github.com/gardener/landscape-setup-template) [landscape-setup-template](https://github.com/gardener/landscape-setup-template)
project. To learn more about this open source project, read the project. To learn more about this open source project, read the
[blog on kubernetes.io](https://kubernetes.io/blog/2018/05/17/gardener/). [blog on kubernetes.io](https://kubernetes.io/blog/2018/05/17/gardener/).
You can find [guides for other platforms here](README.md). You can find [guides for other platforms here](../).
## Before you begin ## Before you begin

View File

@ -11,7 +11,7 @@ demonstrates creating and deploying an image of a sample `hello world` app onto
the newly created Knative cluster on the newly created Knative cluster on
[IBM Cloud Private](https://www.ibm.com/cloud/private). [IBM Cloud Private](https://www.ibm.com/cloud/private).
You can find [guides for other platforms here](README.md). You can find [guides for other platforms here](../).
## Before you begin ## Before you begin

View File

@ -7,13 +7,13 @@ weight: 10
This guide walks you through the installation of the latest version of Knative This guide walks you through the installation of the latest version of Knative
using pre-built images. using pre-built images.
You may also have it all installed for you by clicking the button below: You may also have it all installed for you by clicking the button below:
[![Deploy to IBM Cloud](https://bluemix.net/deploy/button_x2.png)](https://console.bluemix.net/devops/setup/deploy?repository=https://git.ng.bluemix.net/start-with-knative/toolchain.git) [![Deploy to IBM Cloud](https://bluemix.net/deploy/button_x2.png)](https://console.bluemix.net/devops/setup/deploy?repository=https://git.ng.bluemix.net/start-with-knative/toolchain.git)
More More
[instructions on the deploy button here](https://git.ng.bluemix.net/start-with-knative/toolchain/blob/master/README.md). [instructions on the deploy button here](https://git.ng.bluemix.net/start-with-knative/toolchain/blob/master/).
You can find [guides for other platforms here](README.md). You can find [guides for other platforms here](../).
## Before you begin ## Before you begin

View File

@ -9,7 +9,7 @@ This guide walks you through the installation of the latest version of
demonstrates creating and deploying an image of a sample "hello world" app onto demonstrates creating and deploying an image of a sample "hello world" app onto
the newly created Knative cluster. the newly created Knative cluster.
You can find [guides for other platforms here](README.md). You can find [guides for other platforms here](../).
## Before you begin ## Before you begin
@ -130,7 +130,7 @@ Knative, check out the
guide. guide.
If you'd like to view the available sample apps and deploy one of your choosing, If you'd like to view the available sample apps and deploy one of your choosing,
head to the [sample apps](../serving/samples/README.md) repo. head to the [sample apps](../serving/samples/) repo.
> Note: When looking up the IP address to use for accessing your app, you need > Note: When looking up the IP address to use for accessing your app, you need
> to look up the NodePort for the `istio-ingressgateway` well as the IP address > to look up the NodePort for the `istio-ingressgateway` well as the IP address

View File

@ -10,7 +10,7 @@ This guide walks you through the installation of the latest version of
demonstrates creating and deploying an image of a sample "hello world" app onto demonstrates creating and deploying an image of a sample "hello world" app onto
the newly created Knative cluster. the newly created Knative cluster.
You can find [guides for other platforms here](README.md). You can find [guides for other platforms here](../).
## Minishift setup ## Minishift setup
@ -278,7 +278,7 @@ curl -H "Host: helloworld-go.myproject.example.com" http://$IP_ADDRESS
``` ```
If you'd like to view the available sample apps and deploy one of your choosing, If you'd like to view the available sample apps and deploy one of your choosing,
head to the [sample apps](../serving/samples/README.md) repository. head to the [sample apps](../serving/samples/) repository.
## Cleaning up ## Cleaning up

View File

@ -10,7 +10,7 @@ This guide walks you through the installation of the latest version of
demonstrates creating and deploying an image of a sample "hello world" app onto demonstrates creating and deploying an image of a sample "hello world" app onto
the newly created Knative cluster. the newly created Knative cluster.
You can find [guides for other platforms here](README.md). You can find [guides for other platforms here](../).
## Before you begin ## Before you begin
@ -217,7 +217,7 @@ Knative, check out the
guide. guide.
If you'd like to view the available sample apps and deploy one of your choosing, If you'd like to view the available sample apps and deploy one of your choosing,
head to the [sample apps](../serving/samples/README.md) repo. head to the [sample apps](../serving/samples/) repo.
> Note: When looking up the IP address to use for accessing your app, you need > Note: When looking up the IP address to use for accessing your app, you need
> to look up the NodePort for the `istio-ingressgateway` well as the IP address > to look up the NodePort for the `istio-ingressgateway` well as the IP address

View File

@ -7,7 +7,7 @@ weight: 10
This guide walks you through the installation of the latest version of Knative This guide walks you through the installation of the latest version of Knative
using pre-built images. using pre-built images.
You can find [guides for other platforms here](README.md). You can find [guides for other platforms here](../).
## Before you begin ## Before you begin

View File

@ -4,4 +4,4 @@ title: "Installing Knative"
weight: 20 weight: 20
--- ---
{{% readfile file="docs/install/README.md" markdown="true" %}} {{% readfile file="docs/install/" markdown="true" %}}

View File

@ -11,7 +11,7 @@ using cURL requests.
You need: You need:
- A Kubernetes cluster with [Knative installed](./README.md). - A Kubernetes cluster with [Knative installed](./).
- An image of the app that you'd like to deploy available on a container - 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 registry. The image of the sample app used in this guide is available on
Google Container Registry. Google Container Registry.

View File

@ -55,10 +55,10 @@ in the Knative Serving repository.
## More samples and demos ## More samples and demos
- [Autoscaling with Knative Serving](./samples/autoscale-go/README.md) - [Autoscaling with Knative Serving](./samples/autoscale-go/)
- [Source-to-URL with Knative Serving](./samples/source-to-url-go/README.md) - [Source-to-URL with Knative Serving](./samples/source-to-url-go/)
- [Telemetry with Knative Serving](./samples/telemetry-go/README.md) - [Telemetry with Knative Serving](./samples/telemetry-go/)
- [REST API sample](./samples/rest-api-go/README.md) - [REST API sample](./samples/rest-api-go/)
## Setting up Logging and Metrics ## Setting up Logging and Metrics

View File

@ -4,4 +4,4 @@ linkTitle: "Serving Component"
weight: 20 weight: 20
--- ---
{{% readfile file="docs/serving/README.md" markdown="true" %}} {{% readfile file="docs/serving/" markdown="true" %}}

View File

@ -88,7 +88,7 @@ kubernetes.labels.serving_knative_dev\/revision: <REVISION_NAME>
### Accessing build logs ### Accessing build logs
To access logs for a [Knative Build](../build/README.md): To access logs for a [Knative Build](../build/):
- Find the build's name in the specified in the `.yaml` file: - Find the build's name in the specified in the `.yaml` file:

View File

@ -6,4 +6,4 @@ weight: 10
{{% readfile file="docs/serving/fluentd/README.md" markdown="true" %}} {{% readfile file="docs/serving/fluentd/" markdown="true" %}}

View File

@ -5,7 +5,7 @@ weight: 40
--- ---
If you followed one of the If you followed one of the
[comprehensive install guides](../install/README.md#install-guides) or you [comprehensive install guides](../install/#install-guides) or you
performed a custom installation and included the `monitoring.yaml` file in your performed a custom installation and included the `monitoring.yaml` file in your
installation, all of the observability features are already installed and you installation, all of the observability features are already installed and you
can skip down to the can skip down to the

View File

@ -4,4 +4,4 @@ linkTitle: "Sample Apps"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/" markdown="true" %}}

View File

@ -4,7 +4,7 @@ A demonstration of the autoscaling capabilities of a Knative Serving Revision.
## Prerequisites ## Prerequisites
1. A Kubernetes cluster with 1. A Kubernetes cluster with
[Knative Serving](https://github.com/knative/docs/blob/master/install/README.md) [Knative Serving](https://github.com/knative/docs/blob/master/install/)
installed. installed.
1. A 1. A
[metrics installation](https://github.com/knative/docs/blob/master/serving/installing-logging-metrics-traces.md) [metrics installation](https://github.com/knative/docs/blob/master/serving/installing-logging-metrics-traces.md)

View File

@ -4,4 +4,4 @@ linkTitle: "Autoscaling - Go"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/autoscale-go/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/autoscale-go/" markdown="true" %}}

View File

@ -13,7 +13,7 @@ configuration.
You need: You need:
- A Kubernetes cluster with [Knative installed](../../install/README.md). - A Kubernetes cluster with [Knative installed](../../install/).
- (Optional) - (Optional)
[A custom domain configured](../../serving/using-a-custom-domain.md) for use [A custom domain configured](../../serving/using-a-custom-domain.md) for use
with Knative. with Knative.

View File

@ -8,7 +8,7 @@ This sample demonstrates:
## Before you begin ## Before you begin
- [Install Knative Serving](../../../install/README.md) - [Install Knative Serving](../../../install/)
- Create a local folder for this sample and download the files in this directory - Create a local folder for this sample and download the files in this directory
into it. into it.

View File

@ -4,4 +4,4 @@ linkTitle: "Private GitHub repo - Go"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/build-private-repo-go/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/build-private-repo-go/" markdown="true" %}}

View File

@ -9,7 +9,7 @@ sample app for Cloud Foundry.
## Prerequisites ## Prerequisites
- [Install Knative Serving](../../../install/README.md) - [Install Knative Serving](../../../install/)
## Running ## Running

View File

@ -4,4 +4,4 @@ linkTitle: "Buildpack app - .NET"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/buildpack-app-dotnet/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/buildpack-app-dotnet/" markdown="true" %}}

View File

@ -8,7 +8,7 @@ sample function for riff.
## Prerequisites ## Prerequisites
- [Install Knative Serving](../../../install/README.md) - [Install Knative Serving](../../../install/)
## Running ## Running

View File

@ -4,4 +4,4 @@ linkTitle: "Buildpack function - Node.js"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/buildpack-function-nodejs/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/buildpack-function-nodejs/" markdown="true" %}}

View File

@ -5,7 +5,7 @@ webhook.
## Prerequisites ## Prerequisites
- A Kubernetes cluster with Knative installed. Follow the - A Kubernetes cluster with Knative installed. Follow the
[installation instructions](https://github.com/knative/docs/blob/master/install/README.md) [installation instructions](https://github.com/knative/docs/blob/master/install/)
if you need to create one. if you need to create one.
- [Docker](https://www.docker.com) installed and running on your local machine, - [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). and a Docker Hub account configured (we'll use it for a container registry).

View File

@ -4,4 +4,4 @@ linkTitle: "GitHub Webhook - Go"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/gitwebhook-go/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/gitwebhook-go/" markdown="true" %}}

View File

@ -5,7 +5,7 @@ This sample requires knative/serving 0.4 or later.
## Prerequisites ## Prerequisites
1. [Install Knative](https://github.com/knative/docs/blob/master/install/README.md) 1. [Install Knative](https://github.com/knative/docs/blob/master/install/)
1. Install [docker](https://www.docker.com/) 1. Install [docker](https://www.docker.com/)
## Build and run the gRPC server ## Build and run the gRPC server

View File

@ -4,4 +4,4 @@ title: "gRPC server - Go"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/grpc-ping-go/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/grpc-ping-go/" markdown="true" %}}

View File

@ -6,7 +6,7 @@ is not specified, it will use "World" as the TARGET.
## Prerequisites ## Prerequisites
- A Kubernetes cluster with Knative installed. Follow the - A Kubernetes cluster with Knative installed. Follow the
[installation instructions](https://github.com/knative/docs/blob/master/install/README.md) [installation instructions](https://github.com/knative/docs/blob/master/install/)
if you need to create one. if you need to create one.
- [Docker](https://www.docker.com) installed and running on your local machine, - [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). and a Docker Hub account configured (we'll use it for a container registry).

View File

@ -4,4 +4,4 @@ linkTitle: ".NET"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/hello-world/helloworld-csharp/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/hello-world/helloworld-csharp/" markdown="true" %}}

View File

@ -6,7 +6,7 @@ it will use `World` as the `TARGET`.
## Prerequisites ## Prerequisites
- A Kubernetes cluster with Knative installed. Follow the - A Kubernetes cluster with Knative installed. Follow the
[installation instructions](https://github.com/knative/docs/blob/master/install/README.md) [installation instructions](https://github.com/knative/docs/blob/master/install/)
if you need to create one. if you need to create one.
- [Docker](https://www.docker.com) installed and running on your local machine, - [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). and a Docker Hub account configured (we'll use it for a container registry).

View File

@ -4,4 +4,4 @@ linkTitle: "Go"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/hello-world/helloworld-go/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/hello-world/helloworld-go/" markdown="true" %}}

View File

@ -6,7 +6,7 @@ TARGET is not specified, it will use "World" as the TARGET.
## Prerequisites ## Prerequisites
- A Kubernetes cluster with Knative installed. Follow the - A Kubernetes cluster with Knative installed. Follow the
[installation instructions](https://github.com/knative/docs/blob/master/install/README.md) [installation instructions](https://github.com/knative/docs/blob/master/install/)
if you need to create one. if you need to create one.
- [Docker](https://www.docker.com) installed and running on your local machine, - [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). and a Docker Hub account configured (we'll use it for a container registry).

View File

@ -4,4 +4,4 @@ linkTitle: "Java"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/hello-world/helloworld-java/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/hello-world/helloworld-java/" markdown="true" %}}

View File

@ -6,7 +6,7 @@ use for testing. It reads in an env variable `TARGET` and prints "Hello
## Prerequisites ## Prerequisites
- A Kubernetes cluster with Knative installed. Follow the - A Kubernetes cluster with Knative installed. Follow the
[installation instructions](https://github.com/knative/docs/blob/master/install/README.md) [installation instructions](https://github.com/knative/docs/blob/master/install/)
if you need to create one. if you need to create one.
- [Docker](https://www.docker.com) installed and running on your local machine, - [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). and a Docker Hub account configured (we'll use it for a container registry).

View File

@ -4,4 +4,4 @@ linkTitle: "Kotlin"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/hello-world/helloworld-kotlin/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/hello-world/helloworld-kotlin/" markdown="true" %}}

View File

@ -6,7 +6,7 @@ specified, it will use "World" as the TARGET.
## Prerequisites ## Prerequisites
- A Kubernetes cluster with Knative installed. Follow the - A Kubernetes cluster with Knative installed. Follow the
[installation instructions](https://github.com/knative/docs/blob/master/install/README.md) [installation instructions](https://github.com/knative/docs/blob/master/install/)
if you need to create one. if you need to create one.
- [Docker](https://www.docker.com) installed and running on your local machine, - [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). and a Docker Hub account configured (we'll use it for a container registry).

View File

@ -4,4 +4,4 @@ linkTitle: "Node.js"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/hello-world/helloworld-nodejs/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/hello-world/helloworld-nodejs/" markdown="true" %}}

View File

@ -6,7 +6,7 @@ will use "World" as the TARGET.
## Prerequisites ## Prerequisites
- A Kubernetes cluster with Knative installed. Follow the - A Kubernetes cluster with Knative installed. Follow the
[installation instructions](https://github.com/knative/docs/blob/master/install/README.md) [installation instructions](https://github.com/knative/docs/blob/master/install/)
if you need to create one. if you need to create one.
- [Docker](https://www.docker.com) installed and running on your local machine, - [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). and a Docker Hub account configured (we'll use it for a container registry).

View File

@ -4,4 +4,4 @@ linkTitle: "PHP"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/hello-world/helloworld-php/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/hello-world/helloworld-php/" markdown="true" %}}

View File

@ -6,7 +6,7 @@ specified, it will use "World" as the TARGET.
## Prerequisites ## Prerequisites
- A Kubernetes cluster with Knative installed. Follow the - A Kubernetes cluster with Knative installed. Follow the
[installation instructions](https://github.com/knative/docs/blob/master/install/README.md) [installation instructions](https://github.com/knative/docs/blob/master/install/)
if you need to create one. if you need to create one.
- [Docker](https://www.docker.com) installed and running on your local machine, - [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). and a Docker Hub account configured (we'll use it for a container registry).

View File

@ -4,4 +4,4 @@ linkTitle: "Python"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/hello-world/helloworld-python/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/hello-world/helloworld-python/" markdown="true" %}}

View File

@ -6,7 +6,7 @@ specified, it will use "World" as the TARGET.
## Prerequisites ## Prerequisites
- A Kubernetes cluster with Knative installed. Follow the - A Kubernetes cluster with Knative installed. Follow the
[installation instructions](https://github.com/knative/docs/blob/master/install/README.md) [installation instructions](https://github.com/knative/docs/blob/master/install/)
if you need to create one. if you need to create one.
- [Docker](https://www.docker.com) installed and running on your local machine, - [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). and a Docker Hub account configured (we'll use it for a container registry).

View File

@ -4,4 +4,4 @@ linkTitle: "Ruby"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/hello-world/helloworld-ruby/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/hello-world/helloworld-ruby/" markdown="true" %}}

View File

@ -15,7 +15,7 @@ the Login service.
## Prerequisites ## Prerequisites
1. A Kubernetes cluster with 1. A Kubernetes cluster with
[Knative Serving](https://github.com/knative/docs/blob/master/install/README.md) [Knative Serving](https://github.com/knative/docs/blob/master/install/)
installed. installed.
2. Install 2. Install
[Docker](https://docs.docker.com/get-started/#prepare-your-docker-environment). [Docker](https://docs.docker.com/get-started/#prepare-your-docker-environment).

View File

@ -4,4 +4,4 @@ linkTitle: "Routing services - Go"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/knative-routing-go/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/knative-routing-go/" markdown="true" %}}

View File

@ -4,4 +4,4 @@ linkTitle: "RESTful service - Go"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/rest-api-go/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/rest-api-go/" markdown="true" %}}

View File

@ -2,8 +2,8 @@
A Go sample that shows how to use Knative to go from source code in a git A Go sample that shows how to use Knative to go from source code in a git
repository to a running application with a URL. repository to a running application with a URL.
This sample uses the [Build](../../../build/README.md) and This sample uses the [Build](../../../build/) and
[Serving](../../README.md) components of Knative to orchestrate an end-to-end [Serving](../../) components of Knative to orchestrate an end-to-end
deployment. deployment.
## Prerequisites ## Prerequisites
@ -11,7 +11,7 @@ deployment.
You need: You need:
- A Kubernetes cluster with Knative installed. Follow the - A Kubernetes cluster with Knative installed. Follow the
[installation instructions](https://github.com/knative/docs/blob/master/install/README.md) [installation instructions](https://github.com/knative/docs/blob/master/install/)
if you need to create one. if you need to create one.
- Go installed and configured. This is optional, and only required if you want - Go installed and configured. This is optional, and only required if you want
to run the sample app locally. to run the sample app locally.

View File

@ -5,4 +5,4 @@ linkTitle: "Build and deploy - Go"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/source-to-url-go/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/source-to-url-go/" markdown="true" %}}

View File

@ -9,7 +9,7 @@ dedicated Prometheus instance rather than using the default installation.
## Prerequisites ## Prerequisites
1. A Kubernetes cluster with 1. A Kubernetes cluster with
[Knative Serving](https://github.com/knative/docs/blob/master/install/README.md) [Knative Serving](https://github.com/knative/docs/blob/master/install/)
installed. installed.
2. Check if Knative monitoring components are installed: 2. Check if Knative monitoring components are installed:

View File

@ -4,4 +4,4 @@ linkTitle: "Observability - Go"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/telemetry-go/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/telemetry-go/" markdown="true" %}}

View File

@ -6,7 +6,7 @@ generates its thumbnail image using the `ffmpeg` framework.
## Before you begin ## Before you begin
- [Install Knative Serving](../../../install/README.md) - [Install Knative Serving](../../../install/)
If you want to test and run the app locally: If you want to test and run the app locally:

View File

@ -4,4 +4,4 @@ linkTitle: "Deploy, build, and serve - Go"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/thumbnailer-go/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/thumbnailer-go/" markdown="true" %}}

View File

@ -4,4 +4,4 @@ linkTitle: "Traffic splitting"
weight: 1 weight: 1
--- ---
{{% readfile file="docs/serving/samples/traffic-splitting/README.md" markdown="true" %}} {{% readfile file="docs/serving/samples/traffic-splitting/" markdown="true" %}}

View File

@ -35,7 +35,7 @@ collecting `stdout/stderr` logs from the containers:
in in
[200-fluentd.yaml](https://github.com/knative/serving/blob/master/config/monitoring/logging/elasticsearch/200-fluentd.yaml) [200-fluentd.yaml](https://github.com/knative/serving/blob/master/config/monitoring/logging/elasticsearch/200-fluentd.yaml)
with the Fluentd image including the desired Fluentd output plugin. See with the Fluentd image including the desired Fluentd output plugin. See
[here](fluentd/README.md) for the requirements of Flunetd image on Knative. [here](fluentd/) for the requirements of Flunetd image on Knative.
### Configure the Sidecar for log files under /var/log ### Configure the Sidecar for log files under /var/log

View File

@ -81,7 +81,7 @@ You can also apply an updated domain configuration:
> deployed services and routes. > deployed services and routes.
Deploy an app (for example, Deploy an app (for example,
[`helloworld-go`](./samples/helloworld-go/README.md)), to your cluster as [`helloworld-go`](./samples/helloworld-go/)), to your cluster as
normal. You can check the customized domain in Knative Route "helloworld-go" normal. You can check the customized domain in Knative Route "helloworld-go"
with the following command: with the following command:

View File

@ -116,7 +116,7 @@ permission to get the credential secret can access your Cloud DNS.
## Set up Knative ## Set up Knative
1. Follow the 1. Follow the
[instruction](https://github.com/knative/docs/blob/master/install/README.md) [instruction](https://github.com/knative/docs/blob/master/install/)
to install Knative on your cluster. to install Knative on your cluster.
1. Configure Knative to use your custom domain. 1. Configure Knative to use your custom domain.