From 10c902052f1ececfd6784a11192b2d9c22ee3411 Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Fri, 1 Feb 2019 12:10:00 -0800 Subject: [PATCH] site: add build files and front matter to serving samples (#850) * new _index.md files and front matter * serving samples + fix urls * remove file --- .gitignore | 1 + contributing/WORKING-GROUPS.md | 1 + contributing/_index.md | 3 +- docs/build/README.md | 1 - docs/build/_index.md | 7 ++++ docs/eventing/_index.md | 2 +- docs/install/README.md | 1 - docs/install/_index.md | 7 ++++ {reference => docs/reference}/_index.md | 3 +- {reference => docs/reference}/build-api.md | 2 +- .../reference}/eventing/_index.md | 2 +- .../eventing/eventing-sources-api.md | 2 +- {reference => docs/reference}/serving-api.md | 2 +- docs/serving/_index.md | 7 ++++ docs/serving/samples/README.md | 1 - docs/serving/samples/_index.md | 7 ++++ docs/serving/samples/autoscale-go/README.md | 1 - docs/serving/samples/autoscale-go/_index.md | 7 ++++ docs/serving/samples/blue-green-deployment.md | 6 ++- .../samples/build-private-repo-go/README.md | 1 - .../samples/build-private-repo-go/_index.md | 7 ++++ .../samples/buildpack-app-dotnet/README.md | 1 - .../samples/buildpack-app-dotnet/_index.md | 7 ++++ .../buildpack-function-nodejs/README.md | 1 - .../buildpack-function-nodejs/_index.md | 7 ++++ docs/serving/samples/gitwebhook-go/README.md | 1 - docs/serving/samples/gitwebhook-go/_index.md | 7 ++++ docs/serving/samples/grpc-ping-go/README.md | 1 - docs/serving/samples/grpc-ping-go/_index.md | 7 ++++ docs/serving/samples/hello-world/_index.md | 6 +++ .../helloworld-csharp/.gitignore | 0 .../helloworld-csharp/Dockerfile | 0 .../helloworld-csharp/Program.cs | 0 .../Properties/launchSettings.json | 0 .../helloworld-csharp/README.md | 1 - .../helloworld-csharp/Startup.cs | 0 .../hello-world/helloworld-csharp/_index.md | 7 ++++ .../helloworld-csharp.csproj | 0 .../helloworld-csharp/service.yaml | 0 .../helloworld-go/Dockerfile | 0 .../{ => hello-world}/helloworld-go/README.md | 1 - .../hello-world/helloworld-go/_index.md | 7 ++++ .../helloworld-go/helloworld.go | 0 .../helloworld-go/service.yaml | 0 .../helloworld-java/.gitignore | 0 .../.mvn/wrapper/maven-wrapper.jar | Bin .../.mvn/wrapper/maven-wrapper.properties | 0 .../helloworld-java/Dockerfile | 0 .../helloworld-java/README.md | 1 - .../hello-world/helloworld-java/_index.md | 7 ++++ .../helloworld-java/helloworld.zip | Bin .../{ => hello-world}/helloworld-java/mvnw | 0 .../helloworld-java/mvnw.cmd | 0 .../{ => hello-world}/helloworld-java/pom.xml | 0 .../helloworld-java/service.yaml | 0 .../helloworld/HelloworldApplication.java | 0 .../src/main/resources/application.properties | 0 .../HelloworldApplicationTests.java | 0 .../helloworld-kotlin/Dockerfile | 0 .../helloworld-kotlin/README.md | 1 - .../hello-world/helloworld-kotlin/_index.md | 7 ++++ .../helloworld-kotlin/build.gradle | 0 .../helloworld-kotlin/service.yaml | 0 .../src/main/kotlin/com/example/hello/Main.kt | 0 .../helloworld-nodejs/.gitignore | 0 .../helloworld-nodejs/Dockerfile | 0 .../helloworld-nodejs/README.md | 1 - .../hello-world/helloworld-nodejs/_index.md | 7 ++++ .../helloworld-nodejs/index.js | 0 .../helloworld-nodejs/package-lock.json | 0 .../helloworld-nodejs/package.json | 0 .../helloworld-nodejs/service.yaml | 0 .../helloworld-php/Dockerfile | 0 .../helloworld-php/README.md | 35 +++++++++--------- .../hello-world/helloworld-php/_index.md | 7 ++++ .../helloworld-php/index.php | 0 .../helloworld-php/service.yaml | 0 .../helloworld-python/Dockerfile | 0 .../helloworld-python/README.md | 1 - .../hello-world/helloworld-python/_index.md | 7 ++++ .../helloworld-python/app.py | 0 .../helloworld-python/service.yaml | 0 .../helloworld-ruby/Dockerfile | 0 .../{ => hello-world}/helloworld-ruby/Gemfile | 0 .../helloworld-ruby/Gemfile.lock | 0 .../helloworld-ruby/README.md | 1 - .../hello-world/helloworld-ruby/_index.md | 7 ++++ .../{ => hello-world}/helloworld-ruby/app.rb | 0 .../helloworld-ruby/service.yaml | 0 .../helloworld-scala/.gitignore | 0 .../helloworld-scala/README.md | 0 .../helloworld-scala/build.sbt | 0 .../helloworld-scala/helloworld-scala.yaml | 0 .../helloworld-scala/project/build.properties | 0 .../helloworld-scala/project/plugins.sbt | 0 .../src/main/resources/application.conf | 0 .../main/scala/klang/HelloWorldScala.scala | 0 .../samples/knative-routing-go/README.md | 1 - .../samples/knative-routing-go/_index.md | 7 ++++ docs/serving/samples/rest-api-go/README.md | 1 - docs/serving/samples/rest-api-go/_index.md | 7 ++++ .../samples/source-to-url-go/README.md | 1 - .../samples/source-to-url-go/_index.md | 8 ++++ docs/serving/samples/telemetry-go/README.md | 1 - docs/serving/samples/telemetry-go/_index.md | 7 ++++ docs/serving/samples/thumbnailer-go/README.md | 1 - docs/serving/samples/thumbnailer-go/_index.md | 7 ++++ .../samples/traffic-splitting/README.md | 1 - .../samples/traffic-splitting/_index.md | 7 ++++ 109 files changed, 206 insertions(+), 50 deletions(-) create mode 100644 docs/build/_index.md create mode 100644 docs/install/_index.md rename {reference => docs/reference}/_index.md (78%) rename {reference => docs/reference}/build-api.md (64%) rename {reference => docs/reference}/eventing/_index.md (60%) rename {reference => docs/reference}/eventing/eventing-sources-api.md (59%) rename {reference => docs/reference}/serving-api.md (64%) create mode 100644 docs/serving/_index.md create mode 100644 docs/serving/samples/_index.md create mode 100644 docs/serving/samples/autoscale-go/_index.md create mode 100644 docs/serving/samples/build-private-repo-go/_index.md create mode 100644 docs/serving/samples/buildpack-app-dotnet/_index.md create mode 100644 docs/serving/samples/buildpack-function-nodejs/_index.md create mode 100644 docs/serving/samples/gitwebhook-go/_index.md create mode 100644 docs/serving/samples/grpc-ping-go/_index.md create mode 100644 docs/serving/samples/hello-world/_index.md rename docs/serving/samples/{ => hello-world}/helloworld-csharp/.gitignore (100%) rename docs/serving/samples/{ => hello-world}/helloworld-csharp/Dockerfile (100%) rename docs/serving/samples/{ => hello-world}/helloworld-csharp/Program.cs (100%) rename docs/serving/samples/{ => hello-world}/helloworld-csharp/Properties/launchSettings.json (100%) rename docs/serving/samples/{ => hello-world}/helloworld-csharp/README.md (99%) rename docs/serving/samples/{ => hello-world}/helloworld-csharp/Startup.cs (100%) create mode 100644 docs/serving/samples/hello-world/helloworld-csharp/_index.md rename docs/serving/samples/{ => hello-world}/helloworld-csharp/helloworld-csharp.csproj (100%) rename docs/serving/samples/{ => hello-world}/helloworld-csharp/service.yaml (100%) rename docs/serving/samples/{ => hello-world}/helloworld-go/Dockerfile (100%) rename docs/serving/samples/{ => hello-world}/helloworld-go/README.md (99%) create mode 100644 docs/serving/samples/hello-world/helloworld-go/_index.md rename docs/serving/samples/{ => hello-world}/helloworld-go/helloworld.go (100%) rename docs/serving/samples/{ => hello-world}/helloworld-go/service.yaml (100%) rename docs/serving/samples/{ => hello-world}/helloworld-java/.gitignore (100%) rename docs/serving/samples/{ => hello-world}/helloworld-java/.mvn/wrapper/maven-wrapper.jar (100%) rename docs/serving/samples/{ => hello-world}/helloworld-java/.mvn/wrapper/maven-wrapper.properties (100%) rename docs/serving/samples/{ => hello-world}/helloworld-java/Dockerfile (100%) rename docs/serving/samples/{ => hello-world}/helloworld-java/README.md (99%) create mode 100644 docs/serving/samples/hello-world/helloworld-java/_index.md rename docs/serving/samples/{ => hello-world}/helloworld-java/helloworld.zip (100%) rename docs/serving/samples/{ => hello-world}/helloworld-java/mvnw (100%) rename docs/serving/samples/{ => hello-world}/helloworld-java/mvnw.cmd (100%) rename docs/serving/samples/{ => hello-world}/helloworld-java/pom.xml (100%) rename docs/serving/samples/{ => hello-world}/helloworld-java/service.yaml (100%) rename docs/serving/samples/{ => hello-world}/helloworld-java/src/main/java/com/example/helloworld/HelloworldApplication.java (100%) rename docs/serving/samples/{ => hello-world}/helloworld-java/src/main/resources/application.properties (100%) rename docs/serving/samples/{ => hello-world}/helloworld-java/src/test/java/com/example/helloworld/HelloworldApplicationTests.java (100%) rename docs/serving/samples/{ => hello-world}/helloworld-kotlin/Dockerfile (100%) rename docs/serving/samples/{ => hello-world}/helloworld-kotlin/README.md (99%) create mode 100644 docs/serving/samples/hello-world/helloworld-kotlin/_index.md rename docs/serving/samples/{ => hello-world}/helloworld-kotlin/build.gradle (100%) rename docs/serving/samples/{ => hello-world}/helloworld-kotlin/service.yaml (100%) rename docs/serving/samples/{ => hello-world}/helloworld-kotlin/src/main/kotlin/com/example/hello/Main.kt (100%) rename docs/serving/samples/{ => hello-world}/helloworld-nodejs/.gitignore (100%) rename docs/serving/samples/{ => hello-world}/helloworld-nodejs/Dockerfile (100%) rename docs/serving/samples/{ => hello-world}/helloworld-nodejs/README.md (99%) create mode 100644 docs/serving/samples/hello-world/helloworld-nodejs/_index.md rename docs/serving/samples/{ => hello-world}/helloworld-nodejs/index.js (100%) rename docs/serving/samples/{ => hello-world}/helloworld-nodejs/package-lock.json (100%) rename docs/serving/samples/{ => hello-world}/helloworld-nodejs/package.json (100%) rename docs/serving/samples/{ => hello-world}/helloworld-nodejs/service.yaml (100%) rename docs/serving/samples/{ => hello-world}/helloworld-php/Dockerfile (100%) rename docs/serving/samples/{ => hello-world}/helloworld-php/README.md (85%) create mode 100644 docs/serving/samples/hello-world/helloworld-php/_index.md rename docs/serving/samples/{ => hello-world}/helloworld-php/index.php (100%) rename docs/serving/samples/{ => hello-world}/helloworld-php/service.yaml (100%) rename docs/serving/samples/{ => hello-world}/helloworld-python/Dockerfile (100%) rename docs/serving/samples/{ => hello-world}/helloworld-python/README.md (99%) create mode 100644 docs/serving/samples/hello-world/helloworld-python/_index.md rename docs/serving/samples/{ => hello-world}/helloworld-python/app.py (100%) rename docs/serving/samples/{ => hello-world}/helloworld-python/service.yaml (100%) rename docs/serving/samples/{ => hello-world}/helloworld-ruby/Dockerfile (100%) rename docs/serving/samples/{ => hello-world}/helloworld-ruby/Gemfile (100%) rename docs/serving/samples/{ => hello-world}/helloworld-ruby/Gemfile.lock (100%) rename docs/serving/samples/{ => hello-world}/helloworld-ruby/README.md (99%) create mode 100644 docs/serving/samples/hello-world/helloworld-ruby/_index.md rename docs/serving/samples/{ => hello-world}/helloworld-ruby/app.rb (100%) rename docs/serving/samples/{ => hello-world}/helloworld-ruby/service.yaml (100%) rename docs/serving/samples/{ => hello-world}/helloworld-scala/.gitignore (100%) rename docs/serving/samples/{ => hello-world}/helloworld-scala/README.md (100%) rename docs/serving/samples/{ => hello-world}/helloworld-scala/build.sbt (100%) rename docs/serving/samples/{ => hello-world}/helloworld-scala/helloworld-scala.yaml (100%) rename docs/serving/samples/{ => hello-world}/helloworld-scala/project/build.properties (100%) rename docs/serving/samples/{ => hello-world}/helloworld-scala/project/plugins.sbt (100%) rename docs/serving/samples/{ => hello-world}/helloworld-scala/src/main/resources/application.conf (100%) rename docs/serving/samples/{ => hello-world}/helloworld-scala/src/main/scala/klang/HelloWorldScala.scala (100%) create mode 100644 docs/serving/samples/knative-routing-go/_index.md create mode 100644 docs/serving/samples/rest-api-go/_index.md create mode 100644 docs/serving/samples/source-to-url-go/_index.md create mode 100644 docs/serving/samples/telemetry-go/_index.md create mode 100644 docs/serving/samples/thumbnailer-go/_index.md create mode 100644 docs/serving/samples/traffic-splitting/_index.md diff --git a/.gitignore b/.gitignore index af56f6105..da9723e71 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .DS_Store .idea/ + diff --git a/contributing/WORKING-GROUPS.md b/contributing/WORKING-GROUPS.md index 95e53fc13..f4ed629bd 100644 --- a/contributing/WORKING-GROUPS.md +++ b/contributing/WORKING-GROUPS.md @@ -2,6 +2,7 @@ title: "Knative working group" linkTitle: "Join working groups" weight: 25 +type: --- Most community activity is organized into _working groups_. diff --git a/contributing/_index.md b/contributing/_index.md index 0fbfacd8b..22529b021 100644 --- a/contributing/_index.md +++ b/contributing/_index.md @@ -1,4 +1,3 @@ - --- title: "Knative contribution guidelines" linkTitle: "Contributing" @@ -16,4 +15,4 @@ Learn how to join the community of Knative contributors. Also see our [Community page](community) for links to Knative chats, discussions, or Q&A. -{{% readfile file="docs/contributing/README.md" markdown="true" %}} +{{% readfile file="contributing/README.md" markdown="true" %}} diff --git a/docs/build/README.md b/docs/build/README.md index bb98afa9f..dafad3663 100644 --- a/docs/build/README.md +++ b/docs/build/README.md @@ -1,4 +1,3 @@ -# Knative Build A `Build` is a custom resource in Knative that allows you to define a process that runs to completion and can provide status. For example, fetch, build, and diff --git a/docs/build/_index.md b/docs/build/_index.md new file mode 100644 index 000000000..ded1dfe61 --- /dev/null +++ b/docs/build/_index.md @@ -0,0 +1,7 @@ +--- +title: "Knative Build" +linkTitle: "Build Component" +weight: 20 +--- + +{{% readfile file="docs/build/README.md" markdown="true" %}} diff --git a/docs/eventing/_index.md b/docs/eventing/_index.md index 6fd799af4..a1f47b4dd 100644 --- a/docs/eventing/_index.md +++ b/docs/eventing/_index.md @@ -1,5 +1,5 @@ --- -title: "Knative Eventing Component" +title: "Knative Eventing" linkTitle: "Eventing Component" weight: 60 type: "docs" diff --git a/docs/install/README.md b/docs/install/README.md index 822170d85..913cbcb2a 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -1,4 +1,3 @@ -# Installing Knative Follow this guide to install Knative components on a platform of your choice. diff --git a/docs/install/_index.md b/docs/install/_index.md new file mode 100644 index 000000000..251f39481 --- /dev/null +++ b/docs/install/_index.md @@ -0,0 +1,7 @@ +--- +title: "Installing Knative" +#linkTitle: "Installing" +weight: 20 +--- + +{{% readfile file="docs/install/README.md" markdown="true" %}} diff --git a/reference/_index.md b/docs/reference/_index.md similarity index 78% rename from reference/_index.md rename to docs/reference/_index.md index c5e55a9f5..5f1ee4b84 100644 --- a/reference/_index.md +++ b/docs/reference/_index.md @@ -1,9 +1,8 @@ --- title: "Knative Reference Documentation" -linkTitle: "Reference" +linkTitle: "Reference and API" weight: 100 type: "docs" --- Knative API and reference documentation. - diff --git a/reference/build-api.md b/docs/reference/build-api.md similarity index 64% rename from reference/build-api.md rename to docs/reference/build-api.md index 73682d188..08cdd6d29 100644 --- a/reference/build-api.md +++ b/docs/reference/build-api.md @@ -5,4 +5,4 @@ weight: 20 type: "docs" --- -{{% readfile file="/docs/reference/build.md" %}} +{{% readfile file="docs/reference/build.md" %}} diff --git a/reference/eventing/_index.md b/docs/reference/eventing/_index.md similarity index 60% rename from reference/eventing/_index.md rename to docs/reference/eventing/_index.md index ad2d98969..f6969afa7 100644 --- a/reference/eventing/_index.md +++ b/docs/reference/eventing/_index.md @@ -5,4 +5,4 @@ weight: 30 type: "docs" --- -{{% readfile file="/docs/reference/eventing/eventing.md" %}} +{{% readfile file="docs/reference/eventing/eventing.md" %}} diff --git a/reference/eventing/eventing-sources-api.md b/docs/reference/eventing/eventing-sources-api.md similarity index 59% rename from reference/eventing/eventing-sources-api.md rename to docs/reference/eventing/eventing-sources-api.md index 8405fce4c..ac7f96a91 100644 --- a/reference/eventing/eventing-sources-api.md +++ b/docs/reference/eventing/eventing-sources-api.md @@ -5,4 +5,4 @@ weight: 50 type: "docs" --- -{{% readfile file="/docs/reference/eventing/eventing-sources.md" %}} +{{% readfile file="docs/reference/eventing/eventing-sources.md" %}} diff --git a/reference/serving-api.md b/docs/reference/serving-api.md similarity index 64% rename from reference/serving-api.md rename to docs/reference/serving-api.md index 216baa097..b1685142d 100644 --- a/reference/serving-api.md +++ b/docs/reference/serving-api.md @@ -5,4 +5,4 @@ weight: 50 type: "docs" --- -{{% readfile file="/docs/reference/serving.md" %}} +{{% readfile file="docs/reference/serving.md" %}} diff --git a/docs/serving/_index.md b/docs/serving/_index.md new file mode 100644 index 000000000..39142a9fb --- /dev/null +++ b/docs/serving/_index.md @@ -0,0 +1,7 @@ +--- +title: "Knative Serving" +linkTitle: "Serving Component" +weight: 20 +--- + +{{% readfile file="docs/serving/README.md" markdown="true" %}} diff --git a/docs/serving/samples/README.md b/docs/serving/samples/README.md index d5ee7f830..f93bd2fc7 100644 --- a/docs/serving/samples/README.md +++ b/docs/serving/samples/README.md @@ -1,4 +1,3 @@ -# Knative serving sample applications This directory contains sample applications, developed on Knative, to illustrate different use-cases and resources. See diff --git a/docs/serving/samples/_index.md b/docs/serving/samples/_index.md new file mode 100644 index 000000000..7d22c004e --- /dev/null +++ b/docs/serving/samples/_index.md @@ -0,0 +1,7 @@ +--- +title: "Knative Serving Sample Applications" +linkTitle: "Sample Apps" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/README.md" markdown="true" %}} diff --git a/docs/serving/samples/autoscale-go/README.md b/docs/serving/samples/autoscale-go/README.md index 1b021a194..dd4af8a78 100644 --- a/docs/serving/samples/autoscale-go/README.md +++ b/docs/serving/samples/autoscale-go/README.md @@ -1,4 +1,3 @@ -# Autoscale Sample A demonstration of the autoscaling capabilities of a Knative Serving Revision. diff --git a/docs/serving/samples/autoscale-go/_index.md b/docs/serving/samples/autoscale-go/_index.md new file mode 100644 index 000000000..7cf4086f3 --- /dev/null +++ b/docs/serving/samples/autoscale-go/_index.md @@ -0,0 +1,7 @@ +--- +title: "Autoscale Sample App - Go" +linkTitle: "Autoscaling - Go" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/autoscale-go/README.md" markdown="true" %}} diff --git a/docs/serving/samples/blue-green-deployment.md b/docs/serving/samples/blue-green-deployment.md index a038beabb..d3c176b0f 100644 --- a/docs/serving/samples/blue-green-deployment.md +++ b/docs/serving/samples/blue-green-deployment.md @@ -1,4 +1,8 @@ -# Routing and managing traffic with blue/green deployment +--- +title: "Routing and managing traffic with blue/green deployment" +linkTitle: "Routing and managing traffic" +weight: +--- This sample demonstrates updating an application to a new version using a blue/green traffic routing pattern. With Knative, you can safely reroute traffic diff --git a/docs/serving/samples/build-private-repo-go/README.md b/docs/serving/samples/build-private-repo-go/README.md index 20c4af1db..5bc63ae01 100644 --- a/docs/serving/samples/build-private-repo-go/README.md +++ b/docs/serving/samples/build-private-repo-go/README.md @@ -1,4 +1,3 @@ -# Deploying to Knative from a Private GitHub Repo This sample demonstrates: diff --git a/docs/serving/samples/build-private-repo-go/_index.md b/docs/serving/samples/build-private-repo-go/_index.md new file mode 100644 index 000000000..b8aa84ef8 --- /dev/null +++ b/docs/serving/samples/build-private-repo-go/_index.md @@ -0,0 +1,7 @@ +--- +title: "Deploying to Knative from a Private GitHub Repo - Go" +linkTitle: "Private GitHub repo - Go" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/build-private-repo-go/README.md" markdown="true" %}} diff --git a/docs/serving/samples/buildpack-app-dotnet/README.md b/docs/serving/samples/buildpack-app-dotnet/README.md index c5aa6799f..46893165f 100644 --- a/docs/serving/samples/buildpack-app-dotnet/README.md +++ b/docs/serving/samples/buildpack-app-dotnet/README.md @@ -1,4 +1,3 @@ -# Buildpack Sample App A sample app that demonstrates using [Cloud Foundry](https://www.cloudfoundry.org/) buildpacks on Knative Serving, diff --git a/docs/serving/samples/buildpack-app-dotnet/_index.md b/docs/serving/samples/buildpack-app-dotnet/_index.md new file mode 100644 index 000000000..7d2ffe922 --- /dev/null +++ b/docs/serving/samples/buildpack-app-dotnet/_index.md @@ -0,0 +1,7 @@ +--- +title: "Buildpack Sample App - .NET" +linkTitle: "Buildpack app - .NET" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/buildpack-app-dotnet/README.md" markdown="true" %}} diff --git a/docs/serving/samples/buildpack-function-nodejs/README.md b/docs/serving/samples/buildpack-function-nodejs/README.md index 51f27c081..621c604bf 100644 --- a/docs/serving/samples/buildpack-function-nodejs/README.md +++ b/docs/serving/samples/buildpack-function-nodejs/README.md @@ -1,4 +1,3 @@ -# Buildpack Sample Function A sample function that demonstrates using [Cloud Foundry](https://www.cloudfoundry.org/) buildpacks on Knative Serving, diff --git a/docs/serving/samples/buildpack-function-nodejs/_index.md b/docs/serving/samples/buildpack-function-nodejs/_index.md new file mode 100644 index 000000000..95186e2a0 --- /dev/null +++ b/docs/serving/samples/buildpack-function-nodejs/_index.md @@ -0,0 +1,7 @@ +--- +title: "Buildpack Sample Function - Node.js" +linkTitle: "Buildpack function - Node.js" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/buildpack-function-nodejs/README.md" markdown="true" %}} diff --git a/docs/serving/samples/gitwebhook-go/README.md b/docs/serving/samples/gitwebhook-go/README.md index d26d6e185..c4be0dffe 100644 --- a/docs/serving/samples/gitwebhook-go/README.md +++ b/docs/serving/samples/gitwebhook-go/README.md @@ -1,4 +1,3 @@ -# GitHub Webhook - Go sample 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 new file mode 100644 index 000000000..819d705e1 --- /dev/null +++ b/docs/serving/samples/gitwebhook-go/_index.md @@ -0,0 +1,7 @@ +--- +title: "GitHub webhook sample - Go" +linkTitle: "GitHub Webhook - Go" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/gitwebhook-go/README.md" markdown="true" %}} diff --git a/docs/serving/samples/grpc-ping-go/README.md b/docs/serving/samples/grpc-ping-go/README.md index c09fc54a6..657cfef33 100644 --- a/docs/serving/samples/grpc-ping-go/README.md +++ b/docs/serving/samples/grpc-ping-go/README.md @@ -1,4 +1,3 @@ -# gRPC Ping A simple gRPC server written in Go that you can use for testing. diff --git a/docs/serving/samples/grpc-ping-go/_index.md b/docs/serving/samples/grpc-ping-go/_index.md new file mode 100644 index 000000000..9974b7694 --- /dev/null +++ b/docs/serving/samples/grpc-ping-go/_index.md @@ -0,0 +1,7 @@ +--- +title: "gRPC server - Go" +#linkTitle: "" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/grpc-ping-go/README.md" markdown="true" %}} diff --git a/docs/serving/samples/hello-world/_index.md b/docs/serving/samples/hello-world/_index.md new file mode 100644 index 000000000..e7844bc95 --- /dev/null +++ b/docs/serving/samples/hello-world/_index.md @@ -0,0 +1,6 @@ +--- +title: "Knative 'Hello World' samples" +linkTitle: "Hello world apps" +weight: 1 +--- + diff --git a/docs/serving/samples/helloworld-csharp/.gitignore b/docs/serving/samples/hello-world/helloworld-csharp/.gitignore similarity index 100% rename from docs/serving/samples/helloworld-csharp/.gitignore rename to docs/serving/samples/hello-world/helloworld-csharp/.gitignore diff --git a/docs/serving/samples/helloworld-csharp/Dockerfile b/docs/serving/samples/hello-world/helloworld-csharp/Dockerfile similarity index 100% rename from docs/serving/samples/helloworld-csharp/Dockerfile rename to docs/serving/samples/hello-world/helloworld-csharp/Dockerfile diff --git a/docs/serving/samples/helloworld-csharp/Program.cs b/docs/serving/samples/hello-world/helloworld-csharp/Program.cs similarity index 100% rename from docs/serving/samples/helloworld-csharp/Program.cs rename to docs/serving/samples/hello-world/helloworld-csharp/Program.cs diff --git a/docs/serving/samples/helloworld-csharp/Properties/launchSettings.json b/docs/serving/samples/hello-world/helloworld-csharp/Properties/launchSettings.json similarity index 100% rename from docs/serving/samples/helloworld-csharp/Properties/launchSettings.json rename to docs/serving/samples/hello-world/helloworld-csharp/Properties/launchSettings.json diff --git a/docs/serving/samples/helloworld-csharp/README.md b/docs/serving/samples/hello-world/helloworld-csharp/README.md similarity index 99% rename from docs/serving/samples/helloworld-csharp/README.md rename to docs/serving/samples/hello-world/helloworld-csharp/README.md index be15d6658..c873c21f4 100644 --- a/docs/serving/samples/helloworld-csharp/README.md +++ b/docs/serving/samples/hello-world/helloworld-csharp/README.md @@ -1,4 +1,3 @@ -# Hello World - .NET Core sample A simple web app written in C# using .NET Core 2.1 that you can use for testing. It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET diff --git a/docs/serving/samples/helloworld-csharp/Startup.cs b/docs/serving/samples/hello-world/helloworld-csharp/Startup.cs similarity index 100% rename from docs/serving/samples/helloworld-csharp/Startup.cs rename to docs/serving/samples/hello-world/helloworld-csharp/Startup.cs diff --git a/docs/serving/samples/hello-world/helloworld-csharp/_index.md b/docs/serving/samples/hello-world/helloworld-csharp/_index.md new file mode 100644 index 000000000..b8ad83e70 --- /dev/null +++ b/docs/serving/samples/hello-world/helloworld-csharp/_index.md @@ -0,0 +1,7 @@ +--- +title: "Hello world - .NET Core" +linkTitle: ".NET" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/hello-world/helloworld-csharp/README.md" markdown="true" %}} diff --git a/docs/serving/samples/helloworld-csharp/helloworld-csharp.csproj b/docs/serving/samples/hello-world/helloworld-csharp/helloworld-csharp.csproj similarity index 100% rename from docs/serving/samples/helloworld-csharp/helloworld-csharp.csproj rename to docs/serving/samples/hello-world/helloworld-csharp/helloworld-csharp.csproj diff --git a/docs/serving/samples/helloworld-csharp/service.yaml b/docs/serving/samples/hello-world/helloworld-csharp/service.yaml similarity index 100% rename from docs/serving/samples/helloworld-csharp/service.yaml rename to docs/serving/samples/hello-world/helloworld-csharp/service.yaml diff --git a/docs/serving/samples/helloworld-go/Dockerfile b/docs/serving/samples/hello-world/helloworld-go/Dockerfile similarity index 100% rename from docs/serving/samples/helloworld-go/Dockerfile rename to docs/serving/samples/hello-world/helloworld-go/Dockerfile diff --git a/docs/serving/samples/helloworld-go/README.md b/docs/serving/samples/hello-world/helloworld-go/README.md similarity index 99% rename from docs/serving/samples/helloworld-go/README.md rename to docs/serving/samples/hello-world/helloworld-go/README.md index f22a89ce9..85ecc8190 100644 --- a/docs/serving/samples/helloworld-go/README.md +++ b/docs/serving/samples/hello-world/helloworld-go/README.md @@ -1,4 +1,3 @@ -# Hello World - Go sample 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, diff --git a/docs/serving/samples/hello-world/helloworld-go/_index.md b/docs/serving/samples/hello-world/helloworld-go/_index.md new file mode 100644 index 000000000..49cf27bf7 --- /dev/null +++ b/docs/serving/samples/hello-world/helloworld-go/_index.md @@ -0,0 +1,7 @@ +--- +title: "Hello World - Go" +linkTitle: "Go" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/hello-world/helloworld-go/README.md" markdown="true" %}} diff --git a/docs/serving/samples/helloworld-go/helloworld.go b/docs/serving/samples/hello-world/helloworld-go/helloworld.go similarity index 100% rename from docs/serving/samples/helloworld-go/helloworld.go rename to docs/serving/samples/hello-world/helloworld-go/helloworld.go diff --git a/docs/serving/samples/helloworld-go/service.yaml b/docs/serving/samples/hello-world/helloworld-go/service.yaml similarity index 100% rename from docs/serving/samples/helloworld-go/service.yaml rename to docs/serving/samples/hello-world/helloworld-go/service.yaml diff --git a/docs/serving/samples/helloworld-java/.gitignore b/docs/serving/samples/hello-world/helloworld-java/.gitignore similarity index 100% rename from docs/serving/samples/helloworld-java/.gitignore rename to docs/serving/samples/hello-world/helloworld-java/.gitignore diff --git a/docs/serving/samples/helloworld-java/.mvn/wrapper/maven-wrapper.jar b/docs/serving/samples/hello-world/helloworld-java/.mvn/wrapper/maven-wrapper.jar similarity index 100% rename from docs/serving/samples/helloworld-java/.mvn/wrapper/maven-wrapper.jar rename to docs/serving/samples/hello-world/helloworld-java/.mvn/wrapper/maven-wrapper.jar diff --git a/docs/serving/samples/helloworld-java/.mvn/wrapper/maven-wrapper.properties b/docs/serving/samples/hello-world/helloworld-java/.mvn/wrapper/maven-wrapper.properties similarity index 100% rename from docs/serving/samples/helloworld-java/.mvn/wrapper/maven-wrapper.properties rename to docs/serving/samples/hello-world/helloworld-java/.mvn/wrapper/maven-wrapper.properties diff --git a/docs/serving/samples/helloworld-java/Dockerfile b/docs/serving/samples/hello-world/helloworld-java/Dockerfile similarity index 100% rename from docs/serving/samples/helloworld-java/Dockerfile rename to docs/serving/samples/hello-world/helloworld-java/Dockerfile diff --git a/docs/serving/samples/helloworld-java/README.md b/docs/serving/samples/hello-world/helloworld-java/README.md similarity index 99% rename from docs/serving/samples/helloworld-java/README.md rename to docs/serving/samples/hello-world/helloworld-java/README.md index 0875252fb..e53499448 100644 --- a/docs/serving/samples/helloworld-java/README.md +++ b/docs/serving/samples/hello-world/helloworld-java/README.md @@ -1,4 +1,3 @@ -# Hello World - Spring Boot Java sample 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 diff --git a/docs/serving/samples/hello-world/helloworld-java/_index.md b/docs/serving/samples/hello-world/helloworld-java/_index.md new file mode 100644 index 000000000..6226f6dcd --- /dev/null +++ b/docs/serving/samples/hello-world/helloworld-java/_index.md @@ -0,0 +1,7 @@ +--- +title: "Hello World - Spring Boot Java" +linkTitle: "Java" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/hello-world/helloworld-java/README.md" markdown="true" %}} diff --git a/docs/serving/samples/helloworld-java/helloworld.zip b/docs/serving/samples/hello-world/helloworld-java/helloworld.zip similarity index 100% rename from docs/serving/samples/helloworld-java/helloworld.zip rename to docs/serving/samples/hello-world/helloworld-java/helloworld.zip diff --git a/docs/serving/samples/helloworld-java/mvnw b/docs/serving/samples/hello-world/helloworld-java/mvnw similarity index 100% rename from docs/serving/samples/helloworld-java/mvnw rename to docs/serving/samples/hello-world/helloworld-java/mvnw diff --git a/docs/serving/samples/helloworld-java/mvnw.cmd b/docs/serving/samples/hello-world/helloworld-java/mvnw.cmd similarity index 100% rename from docs/serving/samples/helloworld-java/mvnw.cmd rename to docs/serving/samples/hello-world/helloworld-java/mvnw.cmd diff --git a/docs/serving/samples/helloworld-java/pom.xml b/docs/serving/samples/hello-world/helloworld-java/pom.xml similarity index 100% rename from docs/serving/samples/helloworld-java/pom.xml rename to docs/serving/samples/hello-world/helloworld-java/pom.xml diff --git a/docs/serving/samples/helloworld-java/service.yaml b/docs/serving/samples/hello-world/helloworld-java/service.yaml similarity index 100% rename from docs/serving/samples/helloworld-java/service.yaml rename to docs/serving/samples/hello-world/helloworld-java/service.yaml diff --git a/docs/serving/samples/helloworld-java/src/main/java/com/example/helloworld/HelloworldApplication.java b/docs/serving/samples/hello-world/helloworld-java/src/main/java/com/example/helloworld/HelloworldApplication.java similarity index 100% rename from docs/serving/samples/helloworld-java/src/main/java/com/example/helloworld/HelloworldApplication.java rename to docs/serving/samples/hello-world/helloworld-java/src/main/java/com/example/helloworld/HelloworldApplication.java diff --git a/docs/serving/samples/helloworld-java/src/main/resources/application.properties b/docs/serving/samples/hello-world/helloworld-java/src/main/resources/application.properties similarity index 100% rename from docs/serving/samples/helloworld-java/src/main/resources/application.properties rename to docs/serving/samples/hello-world/helloworld-java/src/main/resources/application.properties diff --git a/docs/serving/samples/helloworld-java/src/test/java/com/example/helloworld/HelloworldApplicationTests.java b/docs/serving/samples/hello-world/helloworld-java/src/test/java/com/example/helloworld/HelloworldApplicationTests.java similarity index 100% rename from docs/serving/samples/helloworld-java/src/test/java/com/example/helloworld/HelloworldApplicationTests.java rename to docs/serving/samples/hello-world/helloworld-java/src/test/java/com/example/helloworld/HelloworldApplicationTests.java diff --git a/docs/serving/samples/helloworld-kotlin/Dockerfile b/docs/serving/samples/hello-world/helloworld-kotlin/Dockerfile similarity index 100% rename from docs/serving/samples/helloworld-kotlin/Dockerfile rename to docs/serving/samples/hello-world/helloworld-kotlin/Dockerfile diff --git a/docs/serving/samples/helloworld-kotlin/README.md b/docs/serving/samples/hello-world/helloworld-kotlin/README.md similarity index 99% rename from docs/serving/samples/helloworld-kotlin/README.md rename to docs/serving/samples/hello-world/helloworld-kotlin/README.md index 503092ff1..bf3934294 100644 --- a/docs/serving/samples/helloworld-kotlin/README.md +++ b/docs/serving/samples/hello-world/helloworld-kotlin/README.md @@ -1,4 +1,3 @@ -# Hello World - Kotlin sample 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 diff --git a/docs/serving/samples/hello-world/helloworld-kotlin/_index.md b/docs/serving/samples/hello-world/helloworld-kotlin/_index.md new file mode 100644 index 000000000..af8d56e73 --- /dev/null +++ b/docs/serving/samples/hello-world/helloworld-kotlin/_index.md @@ -0,0 +1,7 @@ +--- +title: "Hello World - Kotlin" +linkTitle: "Kotlin" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/hello-world/helloworld-kotlin/README.md" markdown="true" %}} diff --git a/docs/serving/samples/helloworld-kotlin/build.gradle b/docs/serving/samples/hello-world/helloworld-kotlin/build.gradle similarity index 100% rename from docs/serving/samples/helloworld-kotlin/build.gradle rename to docs/serving/samples/hello-world/helloworld-kotlin/build.gradle diff --git a/docs/serving/samples/helloworld-kotlin/service.yaml b/docs/serving/samples/hello-world/helloworld-kotlin/service.yaml similarity index 100% rename from docs/serving/samples/helloworld-kotlin/service.yaml rename to docs/serving/samples/hello-world/helloworld-kotlin/service.yaml diff --git a/docs/serving/samples/helloworld-kotlin/src/main/kotlin/com/example/hello/Main.kt b/docs/serving/samples/hello-world/helloworld-kotlin/src/main/kotlin/com/example/hello/Main.kt similarity index 100% rename from docs/serving/samples/helloworld-kotlin/src/main/kotlin/com/example/hello/Main.kt rename to docs/serving/samples/hello-world/helloworld-kotlin/src/main/kotlin/com/example/hello/Main.kt diff --git a/docs/serving/samples/helloworld-nodejs/.gitignore b/docs/serving/samples/hello-world/helloworld-nodejs/.gitignore similarity index 100% rename from docs/serving/samples/helloworld-nodejs/.gitignore rename to docs/serving/samples/hello-world/helloworld-nodejs/.gitignore diff --git a/docs/serving/samples/helloworld-nodejs/Dockerfile b/docs/serving/samples/hello-world/helloworld-nodejs/Dockerfile similarity index 100% rename from docs/serving/samples/helloworld-nodejs/Dockerfile rename to docs/serving/samples/hello-world/helloworld-nodejs/Dockerfile diff --git a/docs/serving/samples/helloworld-nodejs/README.md b/docs/serving/samples/hello-world/helloworld-nodejs/README.md similarity index 99% rename from docs/serving/samples/helloworld-nodejs/README.md rename to docs/serving/samples/hello-world/helloworld-nodejs/README.md index 102b7b612..416e37cc4 100644 --- a/docs/serving/samples/helloworld-nodejs/README.md +++ b/docs/serving/samples/hello-world/helloworld-nodejs/README.md @@ -1,4 +1,3 @@ -# Hello World - Node.js sample 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 diff --git a/docs/serving/samples/hello-world/helloworld-nodejs/_index.md b/docs/serving/samples/hello-world/helloworld-nodejs/_index.md new file mode 100644 index 000000000..16ac4a9cc --- /dev/null +++ b/docs/serving/samples/hello-world/helloworld-nodejs/_index.md @@ -0,0 +1,7 @@ +--- +title: "Hello World - Node.js" +linkTitle: "Node.js" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/hello-world/helloworld-nodejs/README.md" markdown="true" %}} diff --git a/docs/serving/samples/helloworld-nodejs/index.js b/docs/serving/samples/hello-world/helloworld-nodejs/index.js similarity index 100% rename from docs/serving/samples/helloworld-nodejs/index.js rename to docs/serving/samples/hello-world/helloworld-nodejs/index.js diff --git a/docs/serving/samples/helloworld-nodejs/package-lock.json b/docs/serving/samples/hello-world/helloworld-nodejs/package-lock.json similarity index 100% rename from docs/serving/samples/helloworld-nodejs/package-lock.json rename to docs/serving/samples/hello-world/helloworld-nodejs/package-lock.json diff --git a/docs/serving/samples/helloworld-nodejs/package.json b/docs/serving/samples/hello-world/helloworld-nodejs/package.json similarity index 100% rename from docs/serving/samples/helloworld-nodejs/package.json rename to docs/serving/samples/hello-world/helloworld-nodejs/package.json diff --git a/docs/serving/samples/helloworld-nodejs/service.yaml b/docs/serving/samples/hello-world/helloworld-nodejs/service.yaml similarity index 100% rename from docs/serving/samples/helloworld-nodejs/service.yaml rename to docs/serving/samples/hello-world/helloworld-nodejs/service.yaml diff --git a/docs/serving/samples/helloworld-php/Dockerfile b/docs/serving/samples/hello-world/helloworld-php/Dockerfile similarity index 100% rename from docs/serving/samples/helloworld-php/Dockerfile rename to docs/serving/samples/hello-world/helloworld-php/Dockerfile diff --git a/docs/serving/samples/helloworld-php/README.md b/docs/serving/samples/hello-world/helloworld-php/README.md similarity index 85% rename from docs/serving/samples/helloworld-php/README.md rename to docs/serving/samples/hello-world/helloworld-php/README.md index 1054fdb12..22b1eb792 100644 --- a/docs/serving/samples/helloworld-php/README.md +++ b/docs/serving/samples/hello-world/helloworld-php/README.md @@ -1,4 +1,3 @@ -# Hello World - PHP sample A simple web app written in PHP that you can use for testing. It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not specified, it @@ -36,27 +35,27 @@ recreate the source files from this folder. 1. Create a file named `Dockerfile` and copy the code block below into it. See [official PHP docker image](https://hub.docker.com/_/php/) for more details. - ```docker - # Use the official PHP 7.2 image. - # https://hub.docker.com/_/php - FROM php:7.2.6-apache + ```docker + # Use the official PHP 7.2 image. + # https://hub.docker.com/_/php + FROM php:7.2.6-apache - # Copy local code to the container image. - COPY index.php /var/www/html/ + # Copy local code to the container image. + COPY index.php /var/www/html/ - # Use the PORT environment variable in Apache configuration files. - RUN sed -i 's/80/${PORT}/g' /etc/apache2/sites-available/000-default.conf /etc/apache2/ports.conf + # Use the PORT environment variable in Apache configuration files. + RUN sed -i 's/80/${PORT}/g' /etc/apache2/sites-available/000-default.conf /etc/apache2/ports.conf - # Configure PHP for development. - # Switch to the production php.ini for production operations. - # RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini" - # https://hub.docker.com/_/php#configuration - RUN mv "$PHP_INI_DIR/php.ini-development" "$PHP_INI_DIR/php.ini" + # Configure PHP for development. + # Switch to the production php.ini for production operations. + # RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini" + # https://hub.docker.com/_/php#configuration + RUN mv "$PHP_INI_DIR/php.ini-development" "$PHP_INI_DIR/php.ini" - # Service must listen to $PORT environment variable. - # This default value facilitates local development. - ENV PORT 8080 - ``` + # Service must listen to $PORT environment variable. + # This default value facilitates local development. + ENV PORT 8080 + ``` 1. Create a new file, `service.yaml` and copy the following service definition into the file. Make sure to replace `{username}` with your Docker Hub diff --git a/docs/serving/samples/hello-world/helloworld-php/_index.md b/docs/serving/samples/hello-world/helloworld-php/_index.md new file mode 100644 index 000000000..1f21fb22c --- /dev/null +++ b/docs/serving/samples/hello-world/helloworld-php/_index.md @@ -0,0 +1,7 @@ +--- +title: "Hello World - PHP" +linkTitle: "PHP" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/hello-world/helloworld-php/README.md" markdown="true" %}} diff --git a/docs/serving/samples/helloworld-php/index.php b/docs/serving/samples/hello-world/helloworld-php/index.php similarity index 100% rename from docs/serving/samples/helloworld-php/index.php rename to docs/serving/samples/hello-world/helloworld-php/index.php diff --git a/docs/serving/samples/helloworld-php/service.yaml b/docs/serving/samples/hello-world/helloworld-php/service.yaml similarity index 100% rename from docs/serving/samples/helloworld-php/service.yaml rename to docs/serving/samples/hello-world/helloworld-php/service.yaml diff --git a/docs/serving/samples/helloworld-python/Dockerfile b/docs/serving/samples/hello-world/helloworld-python/Dockerfile similarity index 100% rename from docs/serving/samples/helloworld-python/Dockerfile rename to docs/serving/samples/hello-world/helloworld-python/Dockerfile diff --git a/docs/serving/samples/helloworld-python/README.md b/docs/serving/samples/hello-world/helloworld-python/README.md similarity index 99% rename from docs/serving/samples/helloworld-python/README.md rename to docs/serving/samples/hello-world/helloworld-python/README.md index 323f8e11a..846d530de 100644 --- a/docs/serving/samples/helloworld-python/README.md +++ b/docs/serving/samples/hello-world/helloworld-python/README.md @@ -1,4 +1,3 @@ -# Hello World - Python sample 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 diff --git a/docs/serving/samples/hello-world/helloworld-python/_index.md b/docs/serving/samples/hello-world/helloworld-python/_index.md new file mode 100644 index 000000000..f602ee4f7 --- /dev/null +++ b/docs/serving/samples/hello-world/helloworld-python/_index.md @@ -0,0 +1,7 @@ +--- +title: "Hello World - Python" +linkTitle: "Python" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/hello-world/helloworld-python/README.md" markdown="true" %}} diff --git a/docs/serving/samples/helloworld-python/app.py b/docs/serving/samples/hello-world/helloworld-python/app.py similarity index 100% rename from docs/serving/samples/helloworld-python/app.py rename to docs/serving/samples/hello-world/helloworld-python/app.py diff --git a/docs/serving/samples/helloworld-python/service.yaml b/docs/serving/samples/hello-world/helloworld-python/service.yaml similarity index 100% rename from docs/serving/samples/helloworld-python/service.yaml rename to docs/serving/samples/hello-world/helloworld-python/service.yaml diff --git a/docs/serving/samples/helloworld-ruby/Dockerfile b/docs/serving/samples/hello-world/helloworld-ruby/Dockerfile similarity index 100% rename from docs/serving/samples/helloworld-ruby/Dockerfile rename to docs/serving/samples/hello-world/helloworld-ruby/Dockerfile diff --git a/docs/serving/samples/helloworld-ruby/Gemfile b/docs/serving/samples/hello-world/helloworld-ruby/Gemfile similarity index 100% rename from docs/serving/samples/helloworld-ruby/Gemfile rename to docs/serving/samples/hello-world/helloworld-ruby/Gemfile diff --git a/docs/serving/samples/helloworld-ruby/Gemfile.lock b/docs/serving/samples/hello-world/helloworld-ruby/Gemfile.lock similarity index 100% rename from docs/serving/samples/helloworld-ruby/Gemfile.lock rename to docs/serving/samples/hello-world/helloworld-ruby/Gemfile.lock diff --git a/docs/serving/samples/helloworld-ruby/README.md b/docs/serving/samples/hello-world/helloworld-ruby/README.md similarity index 99% rename from docs/serving/samples/helloworld-ruby/README.md rename to docs/serving/samples/hello-world/helloworld-ruby/README.md index 19e6d1deb..e988c75dd 100644 --- a/docs/serving/samples/helloworld-ruby/README.md +++ b/docs/serving/samples/hello-world/helloworld-ruby/README.md @@ -1,4 +1,3 @@ -# Hello World - Ruby sample 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 diff --git a/docs/serving/samples/hello-world/helloworld-ruby/_index.md b/docs/serving/samples/hello-world/helloworld-ruby/_index.md new file mode 100644 index 000000000..39fa876d2 --- /dev/null +++ b/docs/serving/samples/hello-world/helloworld-ruby/_index.md @@ -0,0 +1,7 @@ +--- +title: "Hello World - Ruby" +linkTitle: "Ruby" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/hello-world/helloworld-ruby/README.md" markdown="true" %}} diff --git a/docs/serving/samples/helloworld-ruby/app.rb b/docs/serving/samples/hello-world/helloworld-ruby/app.rb similarity index 100% rename from docs/serving/samples/helloworld-ruby/app.rb rename to docs/serving/samples/hello-world/helloworld-ruby/app.rb diff --git a/docs/serving/samples/helloworld-ruby/service.yaml b/docs/serving/samples/hello-world/helloworld-ruby/service.yaml similarity index 100% rename from docs/serving/samples/helloworld-ruby/service.yaml rename to docs/serving/samples/hello-world/helloworld-ruby/service.yaml diff --git a/docs/serving/samples/helloworld-scala/.gitignore b/docs/serving/samples/hello-world/helloworld-scala/.gitignore similarity index 100% rename from docs/serving/samples/helloworld-scala/.gitignore rename to docs/serving/samples/hello-world/helloworld-scala/.gitignore diff --git a/docs/serving/samples/helloworld-scala/README.md b/docs/serving/samples/hello-world/helloworld-scala/README.md similarity index 100% rename from docs/serving/samples/helloworld-scala/README.md rename to docs/serving/samples/hello-world/helloworld-scala/README.md diff --git a/docs/serving/samples/helloworld-scala/build.sbt b/docs/serving/samples/hello-world/helloworld-scala/build.sbt similarity index 100% rename from docs/serving/samples/helloworld-scala/build.sbt rename to docs/serving/samples/hello-world/helloworld-scala/build.sbt diff --git a/docs/serving/samples/helloworld-scala/helloworld-scala.yaml b/docs/serving/samples/hello-world/helloworld-scala/helloworld-scala.yaml similarity index 100% rename from docs/serving/samples/helloworld-scala/helloworld-scala.yaml rename to docs/serving/samples/hello-world/helloworld-scala/helloworld-scala.yaml diff --git a/docs/serving/samples/helloworld-scala/project/build.properties b/docs/serving/samples/hello-world/helloworld-scala/project/build.properties similarity index 100% rename from docs/serving/samples/helloworld-scala/project/build.properties rename to docs/serving/samples/hello-world/helloworld-scala/project/build.properties diff --git a/docs/serving/samples/helloworld-scala/project/plugins.sbt b/docs/serving/samples/hello-world/helloworld-scala/project/plugins.sbt similarity index 100% rename from docs/serving/samples/helloworld-scala/project/plugins.sbt rename to docs/serving/samples/hello-world/helloworld-scala/project/plugins.sbt diff --git a/docs/serving/samples/helloworld-scala/src/main/resources/application.conf b/docs/serving/samples/hello-world/helloworld-scala/src/main/resources/application.conf similarity index 100% rename from docs/serving/samples/helloworld-scala/src/main/resources/application.conf rename to docs/serving/samples/hello-world/helloworld-scala/src/main/resources/application.conf diff --git a/docs/serving/samples/helloworld-scala/src/main/scala/klang/HelloWorldScala.scala b/docs/serving/samples/hello-world/helloworld-scala/src/main/scala/klang/HelloWorldScala.scala similarity index 100% rename from docs/serving/samples/helloworld-scala/src/main/scala/klang/HelloWorldScala.scala rename to docs/serving/samples/hello-world/helloworld-scala/src/main/scala/klang/HelloWorldScala.scala diff --git a/docs/serving/samples/knative-routing-go/README.md b/docs/serving/samples/knative-routing-go/README.md index ca774f37a..8cb3671c5 100644 --- a/docs/serving/samples/knative-routing-go/README.md +++ b/docs/serving/samples/knative-routing-go/README.md @@ -1,4 +1,3 @@ -# Routing across Knative Services 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 diff --git a/docs/serving/samples/knative-routing-go/_index.md b/docs/serving/samples/knative-routing-go/_index.md new file mode 100644 index 000000000..088fc3cb1 --- /dev/null +++ b/docs/serving/samples/knative-routing-go/_index.md @@ -0,0 +1,7 @@ +--- +title: "Routing across multiple Knative services - Go" +linkTitle: "Routing services - Go" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/knative-routing-go/README.md" markdown="true" %}} diff --git a/docs/serving/samples/rest-api-go/README.md b/docs/serving/samples/rest-api-go/README.md index 7b40f5a89..bfec9aea9 100644 --- a/docs/serving/samples/rest-api-go/README.md +++ b/docs/serving/samples/rest-api-go/README.md @@ -1,4 +1,3 @@ -# Creating a RESTful Service This sample demonstrates creating and running a simple RESTful service on Knative Serving. The exposed endpoint takes a stock ticker (i.e. stock symbol), diff --git a/docs/serving/samples/rest-api-go/_index.md b/docs/serving/samples/rest-api-go/_index.md new file mode 100644 index 000000000..ac8c2ddb7 --- /dev/null +++ b/docs/serving/samples/rest-api-go/_index.md @@ -0,0 +1,7 @@ +--- +title: "Creating a RESTful Service - Go" +linkTitle: "RESTful service - Go" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/rest-api-go/README.md" markdown="true" %}} diff --git a/docs/serving/samples/source-to-url-go/README.md b/docs/serving/samples/source-to-url-go/README.md index fa4202340..83a221a0d 100644 --- a/docs/serving/samples/source-to-url-go/README.md +++ b/docs/serving/samples/source-to-url-go/README.md @@ -1,4 +1,3 @@ -# Orchestrating a source-to-URL deployment on Kubernetes 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. diff --git a/docs/serving/samples/source-to-url-go/_index.md b/docs/serving/samples/source-to-url-go/_index.md new file mode 100644 index 000000000..b5e08266c --- /dev/null +++ b/docs/serving/samples/source-to-url-go/_index.md @@ -0,0 +1,8 @@ +--- +title: "Orchestrating a source-to-URL deployment on Kubernetes + - Go" +linkTitle: "Build and deploy - Go" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/source-to-url-go/README.md" markdown="true" %}} diff --git a/docs/serving/samples/telemetry-go/README.md b/docs/serving/samples/telemetry-go/README.md index 5a875aed3..edf0400c4 100644 --- a/docs/serving/samples/telemetry-go/README.md +++ b/docs/serving/samples/telemetry-go/README.md @@ -1,4 +1,3 @@ -# Telemetry Sample 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 diff --git a/docs/serving/samples/telemetry-go/_index.md b/docs/serving/samples/telemetry-go/_index.md new file mode 100644 index 000000000..2a432194d --- /dev/null +++ b/docs/serving/samples/telemetry-go/_index.md @@ -0,0 +1,7 @@ +--- +title: "Observability: Monitoring, logging, and tracing sample - Go" +linkTitle: "Observability - Go" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/telemetry-go/README.md" markdown="true" %}} diff --git a/docs/serving/samples/thumbnailer-go/README.md b/docs/serving/samples/thumbnailer-go/README.md index 156cddf99..485378d69 100644 --- a/docs/serving/samples/thumbnailer-go/README.md +++ b/docs/serving/samples/thumbnailer-go/README.md @@ -1,4 +1,3 @@ -# Thumbnailer External Dependencies Demo This is a walk-through example that demonstrates deploying a dockerized application that accesses external dependencies to Knative Serving. In this demo diff --git a/docs/serving/samples/thumbnailer-go/_index.md b/docs/serving/samples/thumbnailer-go/_index.md new file mode 100644 index 000000000..dbb0293bb --- /dev/null +++ b/docs/serving/samples/thumbnailer-go/_index.md @@ -0,0 +1,7 @@ +--- +title: "Thumbnailer External Dependencies Demo - Go" +linkTitle: "Deploy, build, and serve - Go" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/thumbnailer-go/README.md" markdown="true" %}} diff --git a/docs/serving/samples/traffic-splitting/README.md b/docs/serving/samples/traffic-splitting/README.md index 35c9b73db..7d838604b 100644 --- a/docs/serving/samples/traffic-splitting/README.md +++ b/docs/serving/samples/traffic-splitting/README.md @@ -1,4 +1,3 @@ -# Simple Traffic Splitting Between Revisions This samples builds off the [Creating a RESTful Service](../rest-api-go) sample to illustrate applying a revision, then using that revision for manual traffic diff --git a/docs/serving/samples/traffic-splitting/_index.md b/docs/serving/samples/traffic-splitting/_index.md new file mode 100644 index 000000000..fae7a98ce --- /dev/null +++ b/docs/serving/samples/traffic-splitting/_index.md @@ -0,0 +1,7 @@ +--- +title: "Simple Traffic Splitting Between Revisions" +linkTitle: "Traffic splitting" +weight: 1 +--- + +{{% readfile file="docs/serving/samples/traffic-splitting/README.md" markdown="true" %}}