From 48c867b9d644d8f2c0a31657a1df667081b5963e Mon Sep 17 00:00:00 2001 From: Elias Norrby Date: Tue, 18 May 2021 20:33:46 +0200 Subject: [PATCH] Add/update documentation frontmatter Some documentation files had no frontmatter block, making them invisible in the sidebar navigation on the website (since they were missing the linkTitle property). Fixed by adding the frontmatter block. Additionally, update weights to adjust the order of links: - Installation at the top - Deprecations at the bottom - Migration guides just before Deprecations Increase weight values to facilitate insertion of future documents. --- docs/auth.md | 2 +- docs/conditions.md | 2 +- docs/container-contract.md | 2 +- docs/deprecations.md | 2 +- docs/enabling-ha.md | 7 +++++++ docs/events.md | 2 +- docs/install.md | 7 +++++++ docs/labels.md | 2 +- docs/logs.md | 2 +- docs/metrics.md | 2 +- docs/migrating-from-knative-build.md | 2 +- docs/migrating-v1alpha1-to-v1beta1.md | 7 +++++++ docs/pipelineruns.md | 2 +- docs/pipelines.md | 2 +- docs/podtemplates.md | 2 +- docs/resources.md | 2 +- docs/runs.md | 2 +- docs/taskruns.md | 2 +- docs/tasks.md | 2 +- docs/tekton-bundle-contracts.md | 4 ++-- docs/tekton-controller-performance-configuration.md | 7 +++++++ docs/variables.md | 2 +- docs/workspaces.md | 2 +- 23 files changed, 48 insertions(+), 20 deletions(-) diff --git a/docs/auth.md b/docs/auth.md index e8307069316..bddd4b21858 100644 --- a/docs/auth.md +++ b/docs/auth.md @@ -1,7 +1,7 @@ # Authentication at Run Time diff --git a/docs/conditions.md b/docs/conditions.md index 3d89f4d1c99..fccd141b10e 100644 --- a/docs/conditions.md +++ b/docs/conditions.md @@ -1,7 +1,7 @@ # Conditions diff --git a/docs/container-contract.md b/docs/container-contract.md index 4052ee5631c..bee8a2c315b 100644 --- a/docs/container-contract.md +++ b/docs/container-contract.md @@ -1,7 +1,7 @@ # Container Contract diff --git a/docs/deprecations.md b/docs/deprecations.md index 51ff5c902d4..deff9b68e0d 100644 --- a/docs/deprecations.md +++ b/docs/deprecations.md @@ -1,7 +1,7 @@ diff --git a/docs/enabling-ha.md b/docs/enabling-ha.md index 15e7a1e8bf9..9fde70dc4f0 100644 --- a/docs/enabling-ha.md +++ b/docs/enabling-ha.md @@ -1,3 +1,10 @@ + + # HA Support for Tekton Pipeline Controllers - [Overview](#overview) diff --git a/docs/events.md b/docs/events.md index 0edd18b4b4c..e1563d1c142 100644 --- a/docs/events.md +++ b/docs/events.md @@ -1,7 +1,7 @@ # Events in Tekton diff --git a/docs/install.md b/docs/install.md index e988092cb8e..669ab1e48a9 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,3 +1,10 @@ + + # Installing Tekton Pipelines This guide explains how to install Tekton Pipelines. It covers the following topics: diff --git a/docs/labels.md b/docs/labels.md index 8a75986a547..f376915b17c 100644 --- a/docs/labels.md +++ b/docs/labels.md @@ -1,7 +1,7 @@ # Labels diff --git a/docs/logs.md b/docs/logs.md index 5000172a0f4..2dd3295924b 100644 --- a/docs/logs.md +++ b/docs/logs.md @@ -1,7 +1,7 @@ # Execution Logs diff --git a/docs/metrics.md b/docs/metrics.md index 4acc202df3a..fc7dfc67136 100644 --- a/docs/metrics.md +++ b/docs/metrics.md @@ -1,7 +1,7 @@ # Pipeline Controller Metrics diff --git a/docs/migrating-from-knative-build.md b/docs/migrating-from-knative-build.md index 717f422b452..47e0a87a6cb 100644 --- a/docs/migrating-from-knative-build.md +++ b/docs/migrating-from-knative-build.md @@ -1,7 +1,7 @@ # Migrating from Knative Build diff --git a/docs/migrating-v1alpha1-to-v1beta1.md b/docs/migrating-v1alpha1-to-v1beta1.md index b213ec38a98..ca917c4817c 100644 --- a/docs/migrating-v1alpha1-to-v1beta1.md +++ b/docs/migrating-v1alpha1-to-v1beta1.md @@ -1,3 +1,10 @@ + + # Migrating From Tekton `v1alpha1` to Tekton `v1beta1` - [Changes to fields](#changes-to-fields) diff --git a/docs/pipelineruns.md b/docs/pipelineruns.md index a52cbfa06da..1404c2e7ac6 100644 --- a/docs/pipelineruns.md +++ b/docs/pipelineruns.md @@ -1,7 +1,7 @@ # PipelineRuns diff --git a/docs/pipelines.md b/docs/pipelines.md index c31438e55c8..61a417f1cee 100644 --- a/docs/pipelines.md +++ b/docs/pipelines.md @@ -1,7 +1,7 @@ # Pipelines diff --git a/docs/podtemplates.md b/docs/podtemplates.md index bd3b180005c..b7f52801838 100644 --- a/docs/podtemplates.md +++ b/docs/podtemplates.md @@ -1,7 +1,7 @@ # Pod templates diff --git a/docs/resources.md b/docs/resources.md index d74a52532ef..ff3f0817ea5 100644 --- a/docs/resources.md +++ b/docs/resources.md @@ -1,7 +1,7 @@ # PipelineResources diff --git a/docs/runs.md b/docs/runs.md index d4df1efe441..5c316a276c5 100644 --- a/docs/runs.md +++ b/docs/runs.md @@ -1,7 +1,7 @@ diff --git a/docs/taskruns.md b/docs/taskruns.md index 9e1033dc80b..785cf49a645 100644 --- a/docs/taskruns.md +++ b/docs/taskruns.md @@ -1,7 +1,7 @@ diff --git a/docs/tasks.md b/docs/tasks.md index 199384c3762..5522cbc06d3 100644 --- a/docs/tasks.md +++ b/docs/tasks.md @@ -1,7 +1,7 @@ # Tasks diff --git a/docs/tekton-bundle-contracts.md b/docs/tekton-bundle-contracts.md index 4150a1ab924..5cbe901e28e 100644 --- a/docs/tekton-bundle-contracts.md +++ b/docs/tekton-bundle-contracts.md @@ -1,7 +1,7 @@ @@ -97,4 +97,4 @@ layers: Except as otherwise noted, the content of this page is licensed under the [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/), and code samples are licensed under the -[Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). \ No newline at end of file +[Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). diff --git a/docs/tekton-controller-performance-configuration.md b/docs/tekton-controller-performance-configuration.md index 4b1fc63340b..df5b1f6e6a1 100644 --- a/docs/tekton-controller-performance-configuration.md +++ b/docs/tekton-controller-performance-configuration.md @@ -1,3 +1,10 @@ + + # Tekton Controller Performance Configuration Configure ThreadsPerController, QPS and Burst diff --git a/docs/variables.md b/docs/variables.md index 1deccfcc3a1..3f75282b8bc 100644 --- a/docs/variables.md +++ b/docs/variables.md @@ -1,7 +1,7 @@ # Variable Substitutions Supported by `Tasks` and `Pipelines` diff --git a/docs/workspaces.md b/docs/workspaces.md index 98658359e11..ba729236ff0 100644 --- a/docs/workspaces.md +++ b/docs/workspaces.md @@ -1,7 +1,7 @@ # Workspaces