Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add type:docs + enable relative links #990

Merged
merged 1 commit into from Mar 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions _index.md
@@ -0,0 +1,8 @@
---
title: "Knative Documentation Version 0.3"
linkTitle: "Documentation"
weight: 10
type: "docs"
---

{{% readfile file="README.md" relative="true" markdown="true" %}}
2 changes: 1 addition & 1 deletion community/samples/_index.md
Expand Up @@ -10,4 +10,4 @@ contributed and maintained sample apps.

Use the following table to view the instructions and sample code in the knative/docs repo.

{{% readfile file="community/samples/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
2 changes: 1 addition & 1 deletion contributing/_index.md
Expand Up @@ -15,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="contributing/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
6 changes: 2 additions & 4 deletions docs/_index.md
Expand Up @@ -2,9 +2,7 @@
title: "Welcome to Knative"
linkTitle: "Documentation"
weight: 10
menu:
main:
weight: 20
type: "docs"
---

{{% readfile file="docs/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/build/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Knative Build"
linkTitle: "Build Component"
weight: 20
type: "docs"
---

{{% readfile file="docs/build/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
2 changes: 1 addition & 1 deletion docs/eventing/_index.md
Expand Up @@ -5,4 +5,4 @@ weight: 60
type: "docs"
---

{{% readfile file="docs/eventing/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
2 changes: 1 addition & 1 deletion docs/eventing/channels/_index.md
Expand Up @@ -5,4 +5,4 @@ weight: 40
type: "docs"
---

{{% readfile file="docs/eventing/channels/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
2 changes: 1 addition & 1 deletion docs/eventing/debugging/_index.md
Expand Up @@ -5,4 +5,4 @@ weight: 80
type: "docs"
---

{{% readfile file="docs/eventing/debugging/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
2 changes: 1 addition & 1 deletion docs/eventing/samples/cronjob-source/_index.md
Expand Up @@ -5,4 +5,4 @@ weight: 10
type: "docs"
---

{{% readfile file="docs/eventing/samples/cronjob-source/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
2 changes: 1 addition & 1 deletion docs/eventing/samples/gcp-pubsub-source/_index.md
Expand Up @@ -5,4 +5,4 @@ weight: 20
type: "docs"
---

{{% readfile file="docs/eventing/samples/gcp-pubsub-source/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
2 changes: 1 addition & 1 deletion docs/eventing/samples/github-source/_index.md
Expand Up @@ -5,4 +5,4 @@ weight: 30
type: "docs"
---

{{% readfile file="docs/eventing/samples/github-source/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
2 changes: 1 addition & 1 deletion docs/eventing/samples/iot-core/_index.md
Expand Up @@ -5,4 +5,4 @@ weight: 40
type: "docs"
---

{{% readfile file="docs/eventing/samples/iot-core/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
2 changes: 1 addition & 1 deletion docs/eventing/samples/kubernetes-event-source/_index.md
Expand Up @@ -5,4 +5,4 @@ weight: 50
type: "docs"
---

{{% readfile file="docs/eventing/samples/kubernetes-event-source/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
2 changes: 1 addition & 1 deletion docs/eventing/samples/writing-a-source/_index.md
Expand Up @@ -5,4 +5,4 @@ weight: 60
type: "docs"
---

{{% readfile file="docs/eventing/samples/writing-a-source/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
2 changes: 1 addition & 1 deletion docs/eventing/sources/_index.md
Expand Up @@ -5,4 +5,4 @@ weight: 20
type: "docs"
---

{{% readfile file="docs/eventing/sources/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/install/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Installing Knative"
#linkTitle: "Installing"
weight: 20
type: "docs"
---

{{% readfile file="docs/install/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
2 changes: 1 addition & 1 deletion docs/reference/build-api.md
Expand Up @@ -5,4 +5,4 @@ weight: 20
type: "docs"
---

{{% readfile file="docs/reference/build.md" %}}
{{% readfile file="build.md" relative="true" %}}
2 changes: 1 addition & 1 deletion docs/reference/eventing/_index.md
Expand Up @@ -5,4 +5,4 @@ weight: 30
type: "docs"
---

{{% readfile file="docs/reference/eventing/eventing.md" %}}
{{% readfile file="eventing.md" relative="true" %}}
2 changes: 1 addition & 1 deletion docs/reference/eventing/eventing-sources-api.md
Expand Up @@ -5,4 +5,4 @@ weight: 50
type: "docs"
---

{{% readfile file="docs/reference/eventing/eventing-sources.md" %}}
{{% readfile file="eventing-sources.md" relative="true" %}}
2 changes: 1 addition & 1 deletion docs/reference/serving-api.md
Expand Up @@ -5,4 +5,4 @@ weight: 50
type: "docs"
---

{{% readfile file="docs/reference/serving.md" %}}
{{% readfile file="serving.md" relative="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Knative Serving"
linkTitle: "Serving Component"
weight: 20
type: "docs"
---

{{% readfile file="docs/serving/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/fluentd/_index.md
Expand Up @@ -2,8 +2,9 @@
title: "Fluentd container image requirements"
linkTitle: "Fluentd requirements"
weight: 10
type: "docs"
---



{{% readfile file="docs/serving/fluentd/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Knative Serving Sample Applications"
linkTitle: "Sample Apps"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/autoscale-go/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Autoscale Sample App - Go"
linkTitle: "Autoscaling - Go"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/autoscale-go/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/build-private-repo-go/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Deploying to Knative from a Private GitHub Repo - Go"
linkTitle: "Private GitHub repo - Go"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/build-private-repo-go/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/buildpack-app-dotnet/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Buildpack Sample App - .NET"
linkTitle: "Buildpack app - .NET"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/buildpack-app-dotnet/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/buildpack-function-nodejs/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Buildpack Sample Function - Node.js"
linkTitle: "Buildpack function - Node.js"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/buildpack-function-nodejs/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/gitwebhook-go/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "GitHub webhook sample - Go"
linkTitle: "GitHub Webhook - Go"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/gitwebhook-go/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/grpc-ping-go/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "gRPC server - Go"
#linkTitle: ""
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/grpc-ping-go/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/hello-world/helloworld-csharp/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Hello world - .NET Core"
linkTitle: ".NET"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/hello-world/helloworld-csharp/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/hello-world/helloworld-go/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Hello World - Go"
linkTitle: "Go"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/hello-world/helloworld-go/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/hello-world/helloworld-java/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Hello World - Spring Boot Java"
linkTitle: "Java"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/hello-world/helloworld-java/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/hello-world/helloworld-kotlin/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Hello World - Kotlin"
linkTitle: "Kotlin"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/hello-world/helloworld-kotlin/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/hello-world/helloworld-nodejs/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Hello World - Node.js"
linkTitle: "Node.js"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/hello-world/helloworld-nodejs/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/hello-world/helloworld-php/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Hello World - PHP"
linkTitle: "PHP"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/hello-world/helloworld-php/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/hello-world/helloworld-python/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Hello World - Python"
linkTitle: "Python"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/hello-world/helloworld-python/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/hello-world/helloworld-ruby/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Hello World - Ruby"
linkTitle: "Ruby"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/hello-world/helloworld-ruby/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/hello-world/helloworld-scala/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Hello World - Scala using Akka HTTP"
linkTitle: "Scala"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/hello-world/helloworld-scala/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/knative-routing-go/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Routing across multiple Knative services - Go"
linkTitle: "Routing services - Go"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/knative-routing-go/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/rest-api-go/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Creating a RESTful Service - Go"
linkTitle: "RESTful service - Go"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/rest-api-go/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
6 changes: 3 additions & 3 deletions docs/serving/samples/source-to-url-go/_index.md
@@ -1,8 +1,8 @@
---
title: "Orchestrating a source-to-URL deployment on Kubernetes
- Go"
title: "Orchestrating a source-to-URL deployment on Kubernetes - Go"
linkTitle: "Build and deploy - Go"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/source-to-url-go/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/telemetry-go/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Observability: Monitoring, logging, and tracing sample - Go"
linkTitle: "Observability - Go"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/telemetry-go/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/thumbnailer-go/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Thumbnailer External Dependencies Demo - Go"
linkTitle: "Deploy, build, and serve - Go"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/thumbnailer-go/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}
3 changes: 2 additions & 1 deletion docs/serving/samples/traffic-splitting/_index.md
Expand Up @@ -2,6 +2,7 @@
title: "Simple Traffic Splitting Between Revisions"
linkTitle: "Traffic splitting"
weight: 1
type: "docs"
---

{{% readfile file="docs/serving/samples/traffic-splitting/README.md" markdown="true" %}}
{{% readfile file="README.md" relative="true" markdown="true" %}}