diff --git a/community/samples/_index.md b/community/samples/_index.md index 84748c842..6450b13a5 100644 --- a/community/samples/_index.md +++ b/community/samples/_index.md @@ -5,4 +5,5 @@ weight: 40 type: "docs" --- -{{% readfile file="README.md" relative="true" markdown="true" %}} +{{% readfile file="index.md" relative="true" markdown="true" %}} + diff --git a/community/samples/serving/helloworld-clojure/README.md b/community/samples/serving/helloworld-clojure/README.md index 7543fdb08..a15bdcdc9 100644 --- a/community/samples/serving/helloworld-clojure/README.md +++ b/community/samples/serving/helloworld-clojure/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Clojure" +linkTitle: "Clojure" +weight: 1 +type: "docs" +--- + A simple web app written in Clojure that you can use for testing. It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not specified, it will use "World" as the TARGET. diff --git a/community/samples/serving/helloworld-clojure/_index.md b/community/samples/serving/helloworld-clojure/_index.md deleted file mode 100644 index a42306f72..000000000 --- a/community/samples/serving/helloworld-clojure/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Clojure" -linkTitle: "Clojure" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/community/samples/serving/helloworld-dart/README.md b/community/samples/serving/helloworld-dart/README.md index 420e51004..d56aaf4c3 100644 --- a/community/samples/serving/helloworld-dart/README.md +++ b/community/samples/serving/helloworld-dart/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Dart" +linkTitle: "Dart" +weight: 1 +type: "docs" +--- + A simple web app written in the [Dart](www.dartlang.org) 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 diff --git a/community/samples/serving/helloworld-dart/_index.md b/community/samples/serving/helloworld-dart/_index.md deleted file mode 100644 index 4b1b03ef5..000000000 --- a/community/samples/serving/helloworld-dart/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Dart" -linkTitle: "Dart" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/community/samples/serving/helloworld-elixir/README.md b/community/samples/serving/helloworld-elixir/README.md index 6950a8c3c..e02760695 100644 --- a/community/samples/serving/helloworld-elixir/README.md +++ b/community/samples/serving/helloworld-elixir/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Elixir" +linkTitle: "Elixir" +weight: 1 +type: "docs" +--- + A simple web application written in [Elixir](https://elixir-lang.org/) using the [Phoenix Framework](https://phoenixframework.org/). The application prints all environment variables to the main page. diff --git a/community/samples/serving/helloworld-elixir/_index.md b/community/samples/serving/helloworld-elixir/_index.md deleted file mode 100644 index 8af68fe95..000000000 --- a/community/samples/serving/helloworld-elixir/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Elixir" -linkTitle: "Elixir" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/community/samples/serving/helloworld-haskell/README.md b/community/samples/serving/helloworld-haskell/README.md index d486d6aa0..d4447cc2e 100644 --- a/community/samples/serving/helloworld-haskell/README.md +++ b/community/samples/serving/helloworld-haskell/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Haskell" +linkTitle: "Haskell" +weight: 1 +type: "docs" +--- + A simple web app written in Haskell that you can use for testing. It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not specified, it will use "World" as the TARGET. diff --git a/community/samples/serving/helloworld-haskell/_index.md b/community/samples/serving/helloworld-haskell/_index.md deleted file mode 100644 index 4191cf7e8..000000000 --- a/community/samples/serving/helloworld-haskell/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Haskell" -linkTitle: "Haskell" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/community/samples/serving/helloworld-java-micronaut/README.md b/community/samples/serving/helloworld-java-micronaut/README.md index d78807ed8..358d67fe1 100644 --- a/community/samples/serving/helloworld-java-micronaut/README.md +++ b/community/samples/serving/helloworld-java-micronaut/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Java (Micronaut)" +linkTitle: "Java (Micronaut)" +weight: 1 +type: "docs" +--- + Learn how to deploy a simple web app that is written in Java and uses Micronaut. This samples uses Docker to build locally. The app reads in a `TARGET` env diff --git a/community/samples/serving/helloworld-java-micronaut/_index.md b/community/samples/serving/helloworld-java-micronaut/_index.md deleted file mode 100644 index ece1cadb7..000000000 --- a/community/samples/serving/helloworld-java-micronaut/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Java (Micronaut)" -linkTitle: "Java (Micronaut)" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/community/samples/serving/helloworld-java-quarkus/README.md b/community/samples/serving/helloworld-java-quarkus/README.md index b214e4baf..4a29b6510 100644 --- a/community/samples/serving/helloworld-java-quarkus/README.md +++ b/community/samples/serving/helloworld-java-quarkus/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Java (Quarkus)" +linkTitle: "Java (Quarkus)" +weight: 1 +type: "docs" +--- + A simple [JAX-RS REST API](https://github.com/jax-rs) application that is written in Java and uses [Quarkus](https://quarkus.io/). diff --git a/community/samples/serving/helloworld-java-quarkus/_index.md b/community/samples/serving/helloworld-java-quarkus/_index.md deleted file mode 100644 index 2be87fb5e..000000000 --- a/community/samples/serving/helloworld-java-quarkus/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Java (Quarkus)" -linkTitle: "Java (Quarkus)" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/community/samples/serving/helloworld-rust/README.md b/community/samples/serving/helloworld-rust/README.md index bea583c2c..22770b44f 100644 --- a/community/samples/serving/helloworld-rust/README.md +++ b/community/samples/serving/helloworld-rust/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Rust" +linkTitle: "Rust" +weight: 1 +type: "docs" +--- + A simple web app written in Rust that you can use for testing. It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If diff --git a/community/samples/serving/helloworld-rust/_index.md b/community/samples/serving/helloworld-rust/_index.md deleted file mode 100644 index e455e8087..000000000 --- a/community/samples/serving/helloworld-rust/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Rust" -linkTitle: "Rust" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/community/samples/serving/helloworld-swift/README.md b/community/samples/serving/helloworld-swift/README.md index 8a483ca07..7d044a066 100644 --- a/community/samples/serving/helloworld-swift/README.md +++ b/community/samples/serving/helloworld-swift/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Swift" +linkTitle: "Swift" +weight: 1 +type: "docs" +--- + A simple web app written in Swift that you can use for testing. The app reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not specified, the app uses "World" as the TARGET. diff --git a/community/samples/serving/helloworld-swift/_index.md b/community/samples/serving/helloworld-swift/_index.md deleted file mode 100644 index e656131c8..000000000 --- a/community/samples/serving/helloworld-swift/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Swift" -linkTitle: "Swift" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/community/samples/serving/helloworld-vertx/README.md b/community/samples/serving/helloworld-vertx/README.md index 3a377499e..9784d9212 100644 --- a/community/samples/serving/helloworld-vertx/README.md +++ b/community/samples/serving/helloworld-vertx/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Eclipse Vert.x" +linkTitle: "Eclipse Vert.x" +weight: 1 +type: "docs" +--- + Learn how to deploy a simple web app that is written in Java and uses Eclipse Vert.x. This samples uses Docker to build locally. The app reads in a `TARGET` env variable and then prints "Hello World: \${TARGET}!". If a value for `TARGET` diff --git a/community/samples/serving/helloworld-vertx/_index.md b/community/samples/serving/helloworld-vertx/_index.md deleted file mode 100644 index 5b3b1e688..000000000 --- a/community/samples/serving/helloworld-vertx/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Eclipse Vert.x" -linkTitle: "Eclipse Vert.x" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/_index.md b/docs/_index.md index 664511543..e8a4408a5 100755 --- a/docs/_index.md +++ b/docs/_index.md @@ -5,4 +5,4 @@ weight: 10 type: "docs" --- -{{% readfile file="README.md" relative="true" markdown="true" %}} +{{% readfile file="index.md" relative="true" markdown="true" %}} diff --git a/docs/build/_index.md b/docs/build/_index.md index 1a4b900b4..3f9c53599 100644 --- a/docs/build/_index.md +++ b/docs/build/_index.md @@ -5,4 +5,4 @@ weight: 20 type: "docs" --- -{{% readfile file="README.md" relative="true" markdown="true" %}} +{{% readfile file="index.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/_index.md b/docs/eventing/_index.md index dd4871dde..cfb63c0ee 100644 --- a/docs/eventing/_index.md +++ b/docs/eventing/_index.md @@ -5,4 +5,4 @@ weight: 60 type: "docs" --- -{{% readfile file="README.md" relative="true" markdown="true" %}} +{{% readfile file="index.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/channels/README.md b/docs/eventing/channels/README.md index daf15416c..f478a3a40 100644 --- a/docs/eventing/channels/README.md +++ b/docs/eventing/channels/README.md @@ -1,3 +1,10 @@ +--- +title: "Knative Eventing channels" +linkTitle: "Eventing channels" +weight: 40 +type: "docs" +--- + -Channels are Kubernetes Custom Resources which define a single event forwarding -and persistence layer. Messaging implementations may provide implementations of -Channels via the +Channels are Kubernetes Custom Resources which define a single event forwarding and persistence layer. +Messaging implementations may provide implementations of Channels via the [ClusterChannelProvisioner](https://github.com/knative/eventing/blob/master/pkg/apis/eventing/v1alpha1/cluster_channel_provisioner_types.go#L35) -object, supporting different technologies, such as Apache Kafka or NATS -Streaming. +object, supporting different technologies, such as Apache Kafka or NATS Streaming. This is a non-exhaustive list of Channels for Knative. + ### Inclusion in this list is not an endorsement, nor does it imply any level of support. + ## Channels These are the channels `CRD`s. -| Name | Status | Support | Description | -| -------------------------------------------------------------------------------------------------- | ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------- | -| [Apache Kafka](https://github.com/knative/eventing/tree/master/contrib/kafka/config) | Proof of Concept | None | Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. | -| [GCP PubSub](https://github.com/knative/eventing/tree/master/contrib/gcppubsub/config) | Proof of Concept | None | Channels are backed by [GCP PubSub](https://cloud.google.com/pubsub/). | -| [In-Memory](https://github.com/knative/eventing/tree/master/config/provisioners/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. | -| [Natss](https://github.com/knative/eventing/tree/master/contrib/natss/config) | Proof of Concept | None | Channels are backed by [NATS Streaming](https://github.com/nats-io/nats-streaming-server#configuring). | +Name | Status | Support | Description +--- | --- | --- | --- +[Apache Kafka](https://github.com/knative/eventing/tree/master/contrib/kafka/config) | Proof of Concept | None | Channels are backed by [Apache Kafka](http://kafka.apache.org/) topics. +[GCP PubSub](https://github.com/knative/eventing/tree/master/contrib/gcppubsub/config) | Proof of Concept | None | Channels are backed by [GCP PubSub](https://cloud.google.com/pubsub/). +[In-Memory](https://github.com/knative/eventing/tree/master/config/provisioners/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. +[Natss](https://github.com/knative/eventing/tree/master/contrib/natss/config) | Proof of Concept | None | Channels are backed by [NATS Streaming](https://github.com/nats-io/nats-streaming-server#configuring). + + diff --git a/docs/eventing/channels/_index.md b/docs/eventing/channels/_index.md deleted file mode 100644 index bddd22c96..000000000 --- a/docs/eventing/channels/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Knative Eventing channels" -linkTitle: "Eventing channels" -weight: 40 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/channels/generator/ReadmeTemplate.gomd b/docs/eventing/channels/generator/ReadmeTemplate.gomd index 6b845d33d..58842d184 100644 --- a/docs/eventing/channels/generator/ReadmeTemplate.gomd +++ b/docs/eventing/channels/generator/ReadmeTemplate.gomd @@ -1,3 +1,12 @@ +--- +title: "Knative Eventing channels" +linkTitle: "Eventing channels" +weight: 40 +type: "docs" +--- + +{{ "" }} + {{- /* This will be interpreted given a yamlChannels object. */ -}} {{- /* Ignore this next paragraph, it is only intended in the generated markdown, not here. */ -}} diff --git a/docs/eventing/channels/generator/main.go b/docs/eventing/channels/generator/main.go index 111385a56..b6f8bc636 100644 --- a/docs/eventing/channels/generator/main.go +++ b/docs/eventing/channels/generator/main.go @@ -30,7 +30,7 @@ import ( var ( 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.") - mdFile = flag.String("md", "eventing/channels/", "The mark down file to write to. Any existing file will be overwritten.") + mdFile = flag.String("md", "eventing/channels/README.md", "The mark down file to write to. Any existing file will be overwritten.") ) func main() { diff --git a/docs/eventing/debugging/README.md b/docs/eventing/debugging/README.md index 89fd2e3c9..0a93e451a 100644 --- a/docs/eventing/debugging/README.md +++ b/docs/eventing/debugging/README.md @@ -1,3 +1,10 @@ +--- +title: "Debugging Knative Eventing" +linkTitle: "Debugging" +weight: 100 +type: "docs" +--- + This is an evolving document on how to debug a non-working Knative Eventing setup. diff --git a/docs/eventing/debugging/_index.md b/docs/eventing/debugging/_index.md deleted file mode 100644 index 648f701fb..000000000 --- a/docs/eventing/debugging/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Debugging Knative Eventing" -linkTitle: "Debugging" -weight: 100 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/samples/apache-camel-source/README.md b/docs/eventing/samples/apache-camel-source/README.md index 905f66e64..be848ceda 100644 --- a/docs/eventing/samples/apache-camel-source/README.md +++ b/docs/eventing/samples/apache-camel-source/README.md @@ -1,3 +1,10 @@ +--- +title: "Apache Camel source" +linkTitle: "Camel source" +weight: 5 +type: "docs" +--- + These samples show how to configure a Camel Source. It is an Event Source that can leverage one of the [250+ Apache Camel components](https://github.com/apache/camel/tree/master/components) diff --git a/docs/eventing/samples/apache-camel-source/_index.md b/docs/eventing/samples/apache-camel-source/_index.md deleted file mode 100644 index 0b51e634d..000000000 --- a/docs/eventing/samples/apache-camel-source/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Apache Camel source" -linkTitle: "Camel source" -weight: 5 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/samples/container-source/README.md b/docs/eventing/samples/container-source/README.md index 94b5be8aa..6c8bc0894 100644 --- a/docs/eventing/samples/container-source/README.md +++ b/docs/eventing/samples/container-source/README.md @@ -1,3 +1,10 @@ +--- +title: "Container Source Example" +linkTitle: "Container source" +weight: 10 +type: "docs" +--- + ContainerSource will start a container image which will generate events under certain situations and send messages to a sink URI. It also can be an easy way to support your own event sources in Knative. This guide shows how to configure diff --git a/docs/eventing/samples/container-source/_index.md b/docs/eventing/samples/container-source/_index.md deleted file mode 100644 index dfe798907..000000000 --- a/docs/eventing/samples/container-source/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Container Source Example" -linkTitle: "Container source" -weight: 10 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/samples/cronjob-source/README.md b/docs/eventing/samples/cronjob-source/README.md index 43755eb83..3fbe100f9 100644 --- a/docs/eventing/samples/cronjob-source/README.md +++ b/docs/eventing/samples/cronjob-source/README.md @@ -1,3 +1,10 @@ +--- +title: "Cron job source example" +linkTitle: "Cron job source" +weight: 10 +type: "docs" +--- + Cron Job Source example shows how to configure Cron Job as event source for functions. diff --git a/docs/eventing/samples/cronjob-source/_index.md b/docs/eventing/samples/cronjob-source/_index.md deleted file mode 100644 index 609655485..000000000 --- a/docs/eventing/samples/cronjob-source/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Cron job source example" -linkTitle: "Cron job source" -weight: 10 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/samples/gcp-pubsub-source/README.md b/docs/eventing/samples/gcp-pubsub-source/README.md index 125d498c8..8fa35aac8 100644 --- a/docs/eventing/samples/gcp-pubsub-source/README.md +++ b/docs/eventing/samples/gcp-pubsub-source/README.md @@ -1,3 +1,10 @@ +--- +title: "GCP Cloud Pub/Sub source" +linkTitle: "Pub/Sub source" +weight: 20 +type: "docs" +--- + This sample shows how to configure the GCP PubSub event source. This event source is most useful as a bridge from other GCP services, such as [Cloud Storage](https://cloud.google.com/storage/docs/pubsub-notifications), diff --git a/docs/eventing/samples/gcp-pubsub-source/_index.md b/docs/eventing/samples/gcp-pubsub-source/_index.md deleted file mode 100644 index 03a199da7..000000000 --- a/docs/eventing/samples/gcp-pubsub-source/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "GCP Cloud Pub/Sub source" -linkTitle: "Pub/Sub source" -weight: 20 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/samples/github-source/README.md b/docs/eventing/samples/github-source/README.md index ed6b9b9d8..912b9e280 100644 --- a/docs/eventing/samples/github-source/README.md +++ b/docs/eventing/samples/github-source/README.md @@ -1,3 +1,9 @@ +--- +title: "GitHub source" +linkTitle: "GitHub source" +weight: 30 +type: "docs" +--- GitHub Source example shows how to wire GitHub events for consumption by a Knative Service. diff --git a/docs/eventing/samples/github-source/_index.md b/docs/eventing/samples/github-source/_index.md deleted file mode 100644 index 69b844b80..000000000 --- a/docs/eventing/samples/github-source/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "GitHub source" -linkTitle: "GitHub source" -weight: 30 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/samples/iot-core/README.md b/docs/eventing/samples/iot-core/README.md index 64f126d2f..4c629b41f 100644 --- a/docs/eventing/samples/iot-core/README.md +++ b/docs/eventing/samples/iot-core/README.md @@ -1,3 +1,10 @@ +--- +title: "Binding running services to an IoT core" +linkTitle: "IoT core" +weight: 40 +type: "docs" +--- + This sample shows how to bind a running service to an [IoT core](https://cloud.google.com/iot-core/) using [GCP PubSub](https://cloud.google.com/pubsub/) as the event source. With minor diff --git a/docs/eventing/samples/iot-core/_index.md b/docs/eventing/samples/iot-core/_index.md deleted file mode 100644 index 4be7c6c77..000000000 --- a/docs/eventing/samples/iot-core/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Binding running services to an IoT core" -linkTitle: "IoT core" -weight: 40 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/samples/kubernetes-event-source/README.md b/docs/eventing/samples/kubernetes-event-source/README.md index 261faa36e..8ece958d5 100644 --- a/docs/eventing/samples/kubernetes-event-source/README.md +++ b/docs/eventing/samples/kubernetes-event-source/README.md @@ -1,3 +1,10 @@ +--- +title: "Kubernetes Api Server Source" +linkTitle: "Kubernetes event" +weight: 50 +type: "docs" +--- + Kubernetes Event Source example shows how to wire kubernetes cluster events for consumption by a function that has been implemented as a Knative Service. The code for the following files can be found in the diff --git a/docs/eventing/samples/kubernetes-event-source/_index.md b/docs/eventing/samples/kubernetes-event-source/_index.md deleted file mode 100644 index 4dbcf5340..000000000 --- a/docs/eventing/samples/kubernetes-event-source/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Kubernetes Api Server Source" -linkTitle: "Kubernetes event" -weight: 50 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md b/docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md index 47b49df9d..5394184a0 100644 --- a/docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md +++ b/docs/eventing/samples/sequence/sequence-reply-to-event-display/README.md @@ -1,4 +1,9 @@ -## Overview +--- +title: "Sequence wired to event-display" +linkTitle: "Displaying sequence output" +weight: 20 +type: "docs" +--- We are going to create the following logical configuration. We create a CronJobSource, feeding events to a [`Sequence`](../../../sequence.md), then diff --git a/docs/eventing/samples/sequence/sequence-reply-to-event-display/_index.md b/docs/eventing/samples/sequence/sequence-reply-to-event-display/_index.md deleted file mode 100644 index 8f31c7f1b..000000000 --- a/docs/eventing/samples/sequence/sequence-reply-to-event-display/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Sequence wired to event-display" -linkTitle: "Displaying sequence output" -weight: 20 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/samples/sequence/sequence-reply-to-sequence/README.md b/docs/eventing/samples/sequence/sequence-reply-to-sequence/README.md index e94a591b6..b0b426f96 100644 --- a/docs/eventing/samples/sequence/sequence-reply-to-sequence/README.md +++ b/docs/eventing/samples/sequence/sequence-reply-to-sequence/README.md @@ -1,4 +1,9 @@ -## Overview +--- +title: "Sequence wired to another Sequence" +linkTitle: "Using Sequences in series" +weight: 20 +type: "docs" +--- We are going to create the following logical configuration. We create a CronJobSource, feeding events to a [`Sequence`](../../../sequence.md), then diff --git a/docs/eventing/samples/sequence/sequence-reply-to-sequence/_index.md b/docs/eventing/samples/sequence/sequence-reply-to-sequence/_index.md deleted file mode 100644 index e0c6ae420..000000000 --- a/docs/eventing/samples/sequence/sequence-reply-to-sequence/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Sequence wired to another Sequence" -linkTitle: "Using Sequences in series" -weight: 20 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/samples/sequence/sequence-terminal/README.md b/docs/eventing/samples/sequence/sequence-terminal/README.md index 0d425483e..e2692e964 100644 --- a/docs/eventing/samples/sequence/sequence-terminal/README.md +++ b/docs/eventing/samples/sequence/sequence-terminal/README.md @@ -1,4 +1,9 @@ -## Overview +--- +title: "Sequence terminal" +linkTitle: "Create additional events" +weight: 20 +type: "docs" +--- We are going to create the following logical configuration. We create a CronJobSource, feeding events to a [`Sequence`](../../../sequence.md). Sequence diff --git a/docs/eventing/samples/sequence/sequence-terminal/_index.md b/docs/eventing/samples/sequence/sequence-terminal/_index.md deleted file mode 100644 index b294f0c50..000000000 --- a/docs/eventing/samples/sequence/sequence-terminal/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Sequence terminal" -linkTitle: "Create additional events" -weight: 20 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/samples/sequence/sequence-with-broker-trigger/README.md b/docs/eventing/samples/sequence/sequence-with-broker-trigger/README.md index 63e25966e..8b444770f 100644 --- a/docs/eventing/samples/sequence/sequence-with-broker-trigger/README.md +++ b/docs/eventing/samples/sequence/sequence-with-broker-trigger/README.md @@ -1,4 +1,9 @@ -## Overview +--- +title: "Using Sequence with Broker and Trigger" +linkTitle: "Using with Broker and Trigger" +weight: 20 +type: "docs" +--- We are going to create the following logical configuration. We create a CronJobSource, feeding events into the Broker, then we create a `Filter` that diff --git a/docs/eventing/samples/sequence/sequence-with-broker-trigger/_index.md b/docs/eventing/samples/sequence/sequence-with-broker-trigger/_index.md deleted file mode 100644 index b0da060aa..000000000 --- a/docs/eventing/samples/sequence/sequence-with-broker-trigger/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Using Sequence with Broker and Trigger" -linkTitle: "Using with Broker and Trigger" -weight: 20 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/samples/writing-a-source/_index.md b/docs/eventing/samples/writing-a-source/_index.md index 4ffcf355e..6c737ebc0 100644 --- a/docs/eventing/samples/writing-a-source/_index.md +++ b/docs/eventing/samples/writing-a-source/_index.md @@ -5,4 +5,4 @@ weight: 60 type: "docs" --- -{{% readfile file="README.md" relative="true" markdown="true" %}} +{{% readfile file="index.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/sources/README.md b/docs/eventing/sources/README.md index 6b87d253c..7204af4a6 100644 --- a/docs/eventing/sources/README.md +++ b/docs/eventing/sources/README.md @@ -1,3 +1,10 @@ +--- +title: "Knative Eventing sources" +linkTitle: "Eventing sources" +weight: 20 +type: "docs" +--- + -Event Sources are Kubernetes Custom Resources which provide a mechanism for -registering interest in a class of events from a particular software system. -Since different event sources may be described by different Custom Resources, -this page provides an index of the available source resource types as well as -links to installation instructions. +Event Sources are Kubernetes Custom Resources which provide a mechanism for registering interest in +a class of events from a particular software system. Since different event sources may be described +by different Custom Resources, this page provides an index of the available source resource types as +well as links to installation instructions. This is a non-exhaustive list of Event sources for Knative. @@ -42,11 +48,11 @@ These are sources that are installed as `CRD`s. These are not directly usable, but make writing a Source much easier. -| Name | Status | Support | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ------------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Auto Container Source](https://github.com/Harwayne/auto-container-source) | Proof of Concept | None | AutoContainerSource is a controller that allows the Source CRDs _without_ needing a controller. It notices CRDs with a specific label and starts controlling resources of that type. It utilizes Container Source as underlying infrastructure. | -| [Container Source](https://github.com/knative/eventing/blob/master/pkg/apis/sources/v1alpha1/containersource_types.go) | Active Development | Knative | Container Source is a generic controller. Given an Image URL, it will keep a single `Pod` running with the specified image, environment, and arguments. It is used by multiple other Sources as underlying infrastructure. | -| [Sample Source](https://github.com/grantr/sample-source) | Proof of Concept | None | SampleSource is a reference implementation supporting the [Writing an Event Source the Hard Way tutorial](../samples/writing-a-source). | +Name | Status | Support | Description +--- | --- | --- | --- +[Auto Container Source](https://github.com/Harwayne/auto-container-source) | Proof of Concept | None | AutoContainerSource is a controller that allows the Source CRDs _without_ needing a controller. It notices CRDs with a specific label and starts controlling resources of that type. It utilizes Container Source as underlying infrastructure. +[Container Source](https://github.com/knative/eventing/blob/master/pkg/apis/sources/v1alpha1/containersource_types.go) | Active Development | Knative | Container Source is a generic controller. Given an Image URL, it will keep a single `Pod` running with the specified image, environment, and arguments. It is used by multiple other Sources as underlying infrastructure. +[Sample Source](https://github.com/grantr/sample-source) | Proof of Concept | None | SampleSource is a reference implementation supporting the [Writing an Event Source the Hard Way tutorial](../samples/writing-a-source). ### ContainerSource Containers diff --git a/docs/eventing/sources/_index.md b/docs/eventing/sources/_index.md deleted file mode 100644 index d93a8691c..000000000 --- a/docs/eventing/sources/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Knative Eventing sources" -linkTitle: "Eventing sources" -weight: 20 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/eventing/sources/generator/ReadmeTemplate.gomd b/docs/eventing/sources/generator/ReadmeTemplate.gomd index 78c4c4d98..ed6048dd5 100644 --- a/docs/eventing/sources/generator/ReadmeTemplate.gomd +++ b/docs/eventing/sources/generator/ReadmeTemplate.gomd @@ -1,3 +1,12 @@ +--- +title: "Knative Eventing sources" +linkTitle: "Eventing sources" +weight: 20 +type: "docs" +--- + +{{ "" }} + {{- /* This will be interpreted given a yamlSources object. */ -}} {{- /* Ignore this next paragraph, it is only intended in the generated markdown, not here. */ -}} diff --git a/docs/install/_index.md b/docs/install/_index.md index bf49162d1..333028673 100644 --- a/docs/install/_index.md +++ b/docs/install/_index.md @@ -5,4 +5,4 @@ weight: 05 type: "docs" --- -{{% readfile file="README.md" relative="true" markdown="true" %}} +{{% readfile file="index.md" relative="true" markdown="true" %}} diff --git a/docs/reference/build-api.md b/docs/reference/build-api.md index ef6b88568..5f2a93268 100644 --- a/docs/reference/build-api.md +++ b/docs/reference/build-api.md @@ -5,4 +5,4 @@ weight: 20 type: "docs" --- -{{% readfile file="build.md" relative="true" %}} +{{< readfile file="build.md" relative="true" >}} diff --git a/docs/reference/eventing/_index.md b/docs/reference/eventing/_index.md index d16732c1c..ff008437f 100644 --- a/docs/reference/eventing/_index.md +++ b/docs/reference/eventing/_index.md @@ -5,4 +5,4 @@ weight: 30 type: "docs" --- -{{% readfile file="eventing.md" relative="true" %}} +{{< readfile file="eventing.md" relative="true" >}} diff --git a/docs/reference/eventing/eventing-contrib-api.md b/docs/reference/eventing/eventing-contrib-api.md index fdfb78040..3f08b0fba 100644 --- a/docs/reference/eventing/eventing-contrib-api.md +++ b/docs/reference/eventing/eventing-contrib-api.md @@ -5,4 +5,4 @@ weight: 50 type: "docs" --- -{{% readfile file="eventing-contrib-resources.md" relative="true" %}} +{{< readfile file="eventing-contrib-resources.md" relative="true" >}} diff --git a/docs/reference/serving-api.md b/docs/reference/serving-api.md index 3e370cfa7..aee766d2e 100644 --- a/docs/reference/serving-api.md +++ b/docs/reference/serving-api.md @@ -5,4 +5,4 @@ weight: 50 type: "docs" --- -{{% readfile file="serving.md" relative="true" %}} +{{< readfile file="serving.md" relative="true" >}} diff --git a/docs/serving/_index.md b/docs/serving/_index.md index b63deb17e..5f86867b4 100644 --- a/docs/serving/_index.md +++ b/docs/serving/_index.md @@ -5,4 +5,4 @@ weight: 20 type: "docs" --- -{{% readfile file="README.md" relative="true" markdown="true" %}} +{{% readfile file="index.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/_index.md b/docs/serving/samples/_index.md index f55ccd943..15dca570d 100644 --- a/docs/serving/samples/_index.md +++ b/docs/serving/samples/_index.md @@ -5,4 +5,4 @@ weight: 100 type: "docs" --- -{{% readfile file="README.md" relative="true" markdown="true" %}} +{{% readfile file="index.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/autoscale-go/README.md b/docs/serving/samples/autoscale-go/README.md index c7ec5fe8a..af7d56784 100644 --- a/docs/serving/samples/autoscale-go/README.md +++ b/docs/serving/samples/autoscale-go/README.md @@ -1,3 +1,10 @@ +--- +title: "Autoscale Sample App - Go" +linkTitle: "Autoscaling - Go" +weight: 1 +type: "docs" +--- + A demonstration of the autoscaling capabilities of a Knative Serving Revision. ## Prerequisites diff --git a/docs/serving/samples/autoscale-go/_index.md b/docs/serving/samples/autoscale-go/_index.md deleted file mode 100644 index 543bde942..000000000 --- a/docs/serving/samples/autoscale-go/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Autoscale Sample App - Go" -linkTitle: "Autoscaling - Go" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/gitwebhook-go/README.md b/docs/serving/samples/gitwebhook-go/README.md index 638f49e33..f6ccc3abf 100644 --- a/docs/serving/samples/gitwebhook-go/README.md +++ b/docs/serving/samples/gitwebhook-go/README.md @@ -1,3 +1,10 @@ +--- +title: "GitHub webhook sample - Go" +linkTitle: "GitHub Webhook - Go" +weight: 1 +type: "docs" +--- + A handler written in Go that demonstrates interacting with GitHub through a webhook. diff --git a/docs/serving/samples/gitwebhook-go/_index.md b/docs/serving/samples/gitwebhook-go/_index.md deleted file mode 100644 index e44cfcc1d..000000000 --- a/docs/serving/samples/gitwebhook-go/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "GitHub webhook sample - Go" -linkTitle: "GitHub Webhook - Go" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/grpc-ping-go/README.md b/docs/serving/samples/grpc-ping-go/README.md index 9020c4316..6e14b5200 100644 --- a/docs/serving/samples/grpc-ping-go/README.md +++ b/docs/serving/samples/grpc-ping-go/README.md @@ -1,3 +1,10 @@ +--- +title: "gRPC server - Go" +#linkTitle: "" +weight: 1 +type: "docs" +--- + A simple gRPC server written in Go that you can use for testing. ## Prerequisites diff --git a/docs/serving/samples/grpc-ping-go/_index.md b/docs/serving/samples/grpc-ping-go/_index.md deleted file mode 100644 index 755b74e68..000000000 --- a/docs/serving/samples/grpc-ping-go/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "gRPC server - Go" -#linkTitle: "" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/hello-world/helloworld-csharp/README.md b/docs/serving/samples/hello-world/helloworld-csharp/README.md index a402e51de..3e2d21c3f 100644 --- a/docs/serving/samples/hello-world/helloworld-csharp/README.md +++ b/docs/serving/samples/hello-world/helloworld-csharp/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello world - .NET Core" +linkTitle: ".NET" +weight: 1 +type: "docs" +--- + A simple web app written in C# using .NET Core 2.2 that you can use for testing. It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not specified, it will use "World" as the TARGET. diff --git a/docs/serving/samples/hello-world/helloworld-csharp/_index.md b/docs/serving/samples/hello-world/helloworld-csharp/_index.md deleted file mode 100644 index f98d54672..000000000 --- a/docs/serving/samples/hello-world/helloworld-csharp/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello world - .NET Core" -linkTitle: ".NET" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/hello-world/helloworld-go/README.md b/docs/serving/samples/hello-world/helloworld-go/README.md index e5a86ead1..8556d7648 100644 --- a/docs/serving/samples/hello-world/helloworld-go/README.md +++ b/docs/serving/samples/hello-world/helloworld-go/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Go" +linkTitle: "Go" +weight: 1 +type: "docs" +--- + A simple web app written in Go that you can use for testing. It reads in an env variable `TARGET` and prints `Hello ${TARGET}!`. If `TARGET` is not specified, it will use `World` as the `TARGET`. diff --git a/docs/serving/samples/hello-world/helloworld-go/_index.md b/docs/serving/samples/hello-world/helloworld-go/_index.md deleted file mode 100644 index 7251874db..000000000 --- a/docs/serving/samples/hello-world/helloworld-go/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Go" -linkTitle: "Go" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/hello-world/helloworld-java-spark/README.md b/docs/serving/samples/hello-world/helloworld-java-spark/README.md index 4a3475a1e..9ce3965b0 100644 --- a/docs/serving/samples/hello-world/helloworld-java-spark/README.md +++ b/docs/serving/samples/hello-world/helloworld-java-spark/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Spark Java Framework" +linkTitle: "Java (Spark)" +weight: 1 +type: "docs" +--- + A simple web app written in Java using Spark Java Framework that you can use for testing. diff --git a/docs/serving/samples/hello-world/helloworld-java-spark/_index.md b/docs/serving/samples/hello-world/helloworld-java-spark/_index.md deleted file mode 100644 index c4b36b00d..000000000 --- a/docs/serving/samples/hello-world/helloworld-java-spark/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Spark Java Framework" -linkTitle: "Java (Spark)" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/hello-world/helloworld-java-spring/README.md b/docs/serving/samples/hello-world/helloworld-java-spring/README.md index 1386e2260..e4b3ef2a7 100644 --- a/docs/serving/samples/hello-world/helloworld-java-spring/README.md +++ b/docs/serving/samples/hello-world/helloworld-java-spring/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Spring Boot Java" +linkTitle: "Java (Spring)" +weight: 1 +type: "docs" +--- + A simple web app written in Java using Spring Boot 2.0 that you can use for testing. It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not specified, it will use "World" as the TARGET. diff --git a/docs/serving/samples/hello-world/helloworld-java-spring/_index.md b/docs/serving/samples/hello-world/helloworld-java-spring/_index.md deleted file mode 100644 index 64ffb50ba..000000000 --- a/docs/serving/samples/hello-world/helloworld-java-spring/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Spring Boot Java" -linkTitle: "Java (Spring)" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/hello-world/helloworld-kotlin/README.md b/docs/serving/samples/hello-world/helloworld-kotlin/README.md index 84126affe..b18aa49db 100644 --- a/docs/serving/samples/hello-world/helloworld-kotlin/README.md +++ b/docs/serving/samples/hello-world/helloworld-kotlin/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Kotlin" +linkTitle: "Kotlin" +weight: 1 +type: "docs" +--- + A simple web app written in Kotlin using [Ktor](https://ktor.io/) that you can use for testing. It reads in an env variable `TARGET` and prints "Hello \${TARGET}". If TARGET is not specified, it will use "World" as the TARGET. diff --git a/docs/serving/samples/hello-world/helloworld-kotlin/_index.md b/docs/serving/samples/hello-world/helloworld-kotlin/_index.md deleted file mode 100644 index b0bc90d7f..000000000 --- a/docs/serving/samples/hello-world/helloworld-kotlin/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Kotlin" -linkTitle: "Kotlin" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/hello-world/helloworld-nodejs/README.md b/docs/serving/samples/hello-world/helloworld-nodejs/README.md index bcf437c11..e7ee54a8b 100644 --- a/docs/serving/samples/hello-world/helloworld-nodejs/README.md +++ b/docs/serving/samples/hello-world/helloworld-nodejs/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Node.js" +linkTitle: "Node.js" +weight: 1 +type: "docs" +--- + A simple web app written in Node.js that you can use for testing. It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not specified, it will use "World" as the TARGET. diff --git a/docs/serving/samples/hello-world/helloworld-nodejs/_index.md b/docs/serving/samples/hello-world/helloworld-nodejs/_index.md deleted file mode 100644 index 366f22a97..000000000 --- a/docs/serving/samples/hello-world/helloworld-nodejs/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Node.js" -linkTitle: "Node.js" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/hello-world/helloworld-php/README.md b/docs/serving/samples/hello-world/helloworld-php/README.md index 43c2b15de..b1db9f0fb 100644 --- a/docs/serving/samples/hello-world/helloworld-php/README.md +++ b/docs/serving/samples/hello-world/helloworld-php/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - PHP" +linkTitle: "PHP" +weight: 1 +type: "docs" +--- + A simple web app written in Go that you can use for testing. It reads in an env variable `TARGET` and prints `Hello ${TARGET}!`. If `TARGET` is not specified, it will use `World` as the `TARGET`. diff --git a/docs/serving/samples/hello-world/helloworld-php/_index.md b/docs/serving/samples/hello-world/helloworld-php/_index.md deleted file mode 100644 index 4d10a3938..000000000 --- a/docs/serving/samples/hello-world/helloworld-php/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - PHP" -linkTitle: "PHP" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/hello-world/helloworld-python/README.md b/docs/serving/samples/hello-world/helloworld-python/README.md index ae992c9a4..18b56c32d 100644 --- a/docs/serving/samples/hello-world/helloworld-python/README.md +++ b/docs/serving/samples/hello-world/helloworld-python/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Python" +linkTitle: "Python" +weight: 1 +type: "docs" +--- + A simple web app written in Python that you can use for testing. It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not specified, it will use "World" as the TARGET. diff --git a/docs/serving/samples/hello-world/helloworld-python/_index.md b/docs/serving/samples/hello-world/helloworld-python/_index.md deleted file mode 100644 index ca652936e..000000000 --- a/docs/serving/samples/hello-world/helloworld-python/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Python" -linkTitle: "Python" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/hello-world/helloworld-ruby/README.md b/docs/serving/samples/hello-world/helloworld-ruby/README.md index 87c28c08c..98e73997b 100644 --- a/docs/serving/samples/hello-world/helloworld-ruby/README.md +++ b/docs/serving/samples/hello-world/helloworld-ruby/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Ruby" +linkTitle: "Ruby" +weight: 1 +type: "docs" +--- + A simple web app written in Ruby that you can use for testing. It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not specified, it will use "World" as the TARGET. diff --git a/docs/serving/samples/hello-world/helloworld-ruby/_index.md b/docs/serving/samples/hello-world/helloworld-ruby/_index.md deleted file mode 100644 index 8ba065d53..000000000 --- a/docs/serving/samples/hello-world/helloworld-ruby/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Ruby" -linkTitle: "Ruby" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/hello-world/helloworld-scala/README.md b/docs/serving/samples/hello-world/helloworld-scala/README.md index f4196bdcd..3741d1c6e 100644 --- a/docs/serving/samples/hello-world/helloworld-scala/README.md +++ b/docs/serving/samples/hello-world/helloworld-scala/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Scala using Akka HTTP" +linkTitle: "Scala" +weight: 1 +type: "docs" +--- + A microservice which demonstrates how to get set up and running with Knative Serving when using [Scala](https://scala-lang.org/) and [Akka](https://akka.io/) [HTTP](https://doc.akka.io/docs/akka-http/current/). It will respond to a HTTP diff --git a/docs/serving/samples/hello-world/helloworld-scala/_index.md b/docs/serving/samples/hello-world/helloworld-scala/_index.md deleted file mode 100644 index 3e20ac1fa..000000000 --- a/docs/serving/samples/hello-world/helloworld-scala/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Scala using Akka HTTP" -linkTitle: "Scala" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/hello-world/helloworld-shell/README.md b/docs/serving/samples/hello-world/helloworld-shell/README.md index 8bd98d680..e292a6da3 100644 --- a/docs/serving/samples/hello-world/helloworld-shell/README.md +++ b/docs/serving/samples/hello-world/helloworld-shell/README.md @@ -1,3 +1,10 @@ +--- +title: "Hello World - Shell" +linkTitle: "Shell" +weight: 1 +type: "docs" +--- + A simple web app that executes a shell script. The shell script reads an env variable `TARGET` and prints `Hello ${TARGET}!`. If the `TARGET` environment variable is not specified, the script uses `World`. diff --git a/docs/serving/samples/hello-world/helloworld-shell/_index.md b/docs/serving/samples/hello-world/helloworld-shell/_index.md deleted file mode 100644 index 98e8b563f..000000000 --- a/docs/serving/samples/hello-world/helloworld-shell/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Hello World - Shell" -linkTitle: "Shell" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/hello-world/rest-api-go/sample-template.yaml b/docs/serving/samples/hello-world/rest-api-go/sample-template.yaml deleted file mode 100644 index afc4d40e6..000000000 --- a/docs/serving/samples/hello-world/rest-api-go/sample-template.yaml +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2018 The Knative Authors -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -apiVersion: serving.knative.dev/v1alpha1 -kind: Service -metadata: - name: stock-service-example - namespace: default -spec: - template: - spec: - containers: - - image: ${REPO}/rest-api-go - env: - - name: RESOURCE - value: stock - readinessProbe: - httpGet: - path: / - initialDelaySeconds: 0 - periodSeconds: 3 - diff --git a/docs/serving/samples/hello-world/traffic-splitting/release_sample.yaml b/docs/serving/samples/hello-world/traffic-splitting/release_sample.yaml deleted file mode 100644 index 3ee206409..000000000 --- a/docs/serving/samples/hello-world/traffic-splitting/release_sample.yaml +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2019 The Knative Authors -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -apiVersion: serving.knative.dev/v1alpha1 -kind: Service -metadata: - name: stock-service-example - namespace: default -spec: - release: - revisions: ["${CURRENT}"] - configuration: - revisionTemplate: - spec: - container: - image: ${REPO}/rest-api-go - env: - - name: RESOURCE - value: stock - readinessProbe: - httpGet: - path: / - initialDelaySeconds: 0 - periodSeconds: 3 diff --git a/docs/serving/samples/hello-world/traffic-splitting/split_sample.yaml b/docs/serving/samples/hello-world/traffic-splitting/split_sample.yaml deleted file mode 100644 index 191f91803..000000000 --- a/docs/serving/samples/hello-world/traffic-splitting/split_sample.yaml +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2019 The Knative Authors -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -apiVersion: serving.knative.dev/v1alpha1 -kind: Service -metadata: - name: stock-service-example - namespace: default -spec: - release: - revisions: [ "${CURRENT}", "${CANDIDATE}"] - rolloutPercent: 50 - configuration: - revisionTemplate: - spec: - container: - image: ${REPO}/rest-api-go - env: - - name: RESOURCE - value: share - readinessProbe: - httpGet: - path: / - initialDelaySeconds: 0 - periodSeconds: 3 diff --git a/docs/serving/samples/hello-world/traffic-splitting/updated_sample.yaml b/docs/serving/samples/hello-world/traffic-splitting/updated_sample.yaml deleted file mode 100644 index cd7c866ca..000000000 --- a/docs/serving/samples/hello-world/traffic-splitting/updated_sample.yaml +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2019 The Knative Authors -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -apiVersion: serving.knative.dev/v1alpha1 -kind: Service -metadata: - name: stock-service-example - namespace: default -spec: - release: - revisions: ["${CURRENT}"] - configuration: - revisionTemplate: - spec: - container: - image: ${REPO}/rest-api-go - env: - - name: RESOURCE - value: share - readinessProbe: - httpGet: - path: / - initialDelaySeconds: 0 - periodSeconds: 3 diff --git a/docs/serving/samples/knative-routing-go/README.md b/docs/serving/samples/knative-routing-go/README.md index 36d13e1b7..0bf47f0c2 100644 --- a/docs/serving/samples/knative-routing-go/README.md +++ b/docs/serving/samples/knative-routing-go/README.md @@ -1,3 +1,10 @@ +--- +title: "Routing across multiple Knative services - Go" +linkTitle: "Routing services - Go" +weight: 1 +type: "docs" +--- + This example shows how to map multiple Knative services to different paths under a single domain name using the Istio VirtualService concept. Istio is a general-purpose reverse proxy, therefore these directions can also be used to diff --git a/docs/serving/samples/knative-routing-go/_index.md b/docs/serving/samples/knative-routing-go/_index.md deleted file mode 100644 index 1d208f21d..000000000 --- a/docs/serving/samples/knative-routing-go/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Routing across multiple Knative services - Go" -linkTitle: "Routing services - Go" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/rest-api-go/README.md b/docs/serving/samples/rest-api-go/README.md index 36e2b52b2..2f146b970 100644 --- a/docs/serving/samples/rest-api-go/README.md +++ b/docs/serving/samples/rest-api-go/README.md @@ -1,3 +1,10 @@ +--- +title: "Creating a RESTful Service - Go" +linkTitle: "RESTful service - Go" +weight: 1 +type: "docs" +--- + This "stock ticker" sample demonstrates how to create and run a simple RESTful service on Knative Serving. The exposed endpoint outputs the stock price for a given "[stock symbol](https://www.marketwatch.com/tools/quotes/lookup.asp)", diff --git a/docs/serving/samples/rest-api-go/_index.md b/docs/serving/samples/rest-api-go/_index.md deleted file mode 100644 index 07aeddb92..000000000 --- a/docs/serving/samples/rest-api-go/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Creating a RESTful Service - Go" -linkTitle: "RESTful service - Go" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/secrets-go/README.md b/docs/serving/samples/secrets-go/README.md index c5ad306bb..b3da59a0e 100644 --- a/docs/serving/samples/secrets-go/README.md +++ b/docs/serving/samples/secrets-go/README.md @@ -1,3 +1,10 @@ +--- +title: "Knative Secrets - Go" +linkTitle: "Secrets - Go" +weight: 1 +type: "docs" +--- + A simple web app written in Go that you can use for testing. It demonstrates how to use a Kubernetes secret as a Volume with Knative. We will create a new Google Service Account and place it into a Kubernetes secret, then we will mount it diff --git a/docs/serving/samples/secrets-go/_index.md b/docs/serving/samples/secrets-go/_index.md deleted file mode 100644 index f78e3ab14..000000000 --- a/docs/serving/samples/secrets-go/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Knative Secrets - Go" -linkTitle: "Secrets - Go" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/telemetry-go/README.md b/docs/serving/samples/telemetry-go/README.md index 0410d8d8e..e53b852fb 100644 --- a/docs/serving/samples/telemetry-go/README.md +++ b/docs/serving/samples/telemetry-go/README.md @@ -1,3 +1,10 @@ +--- +title: "Observability: Monitoring, logging, and tracing sample - Go" +linkTitle: "Observability - Go" +weight: 1 +type: "docs" +--- + This sample runs a simple web server that makes calls to other in-cluster services and responds to requests with "Hello World!". The purpose of this sample is to show generating [metrics](../../accessing-metrics.md), diff --git a/docs/serving/samples/telemetry-go/_index.md b/docs/serving/samples/telemetry-go/_index.md deleted file mode 100644 index 824f7d607..000000000 --- a/docs/serving/samples/telemetry-go/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Observability: Monitoring, logging, and tracing sample - Go" -linkTitle: "Observability - Go" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}} diff --git a/docs/serving/samples/traffic-splitting/README.md b/docs/serving/samples/traffic-splitting/README.md index b0f9aea61..787ec4e57 100644 --- a/docs/serving/samples/traffic-splitting/README.md +++ b/docs/serving/samples/traffic-splitting/README.md @@ -1,3 +1,10 @@ +--- +title: "Simple Traffic Splitting Between Revisions" +linkTitle: "Traffic splitting" +weight: 1 +type: "docs" +--- + This samples builds off of the [Creating a RESTful Service](../rest-api-go) sample to illustrate updating a Service to create a new Revision as well as splitting traffic between the two created Revisions. diff --git a/docs/serving/samples/traffic-splitting/_index.md b/docs/serving/samples/traffic-splitting/_index.md deleted file mode 100644 index f0c2fdec3..000000000 --- a/docs/serving/samples/traffic-splitting/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Simple Traffic Splitting Between Revisions" -linkTitle: "Traffic splitting" -weight: 1 -type: "docs" ---- - -{{% readfile file="README.md" relative="true" markdown="true" %}}