Pipelines Docs Cleanup

- Update weights to group similar docs on website - Add missing front matter to docs where it's missing - Delete obsolete docs
chitrangpatel · Feb 13, 2023 · 3a9dd6a · 3a9dd6a
1 parent f595f81
commit 3a9dd6a
Show file tree

Hide file tree

Showing 40 changed files with 132 additions and 200 deletions.
diff --git a/docs/auth.md b/docs/auth.md
@@ -1,9 +1,10 @@
 <!--
 ---
 linkTitle: "Authentication"
-weight: 1000
+weight: 301
 ---
 -->
+
 # Authentication at Run Time
 
 This document describes how Tekton handles authentication when executing

diff --git a/docs/bundle-resolver.md b/docs/bundle-resolver.md
@@ -1,3 +1,10 @@
+<!--
+---
+linkTitle: "Bundles Resolver"
+weight: 308
+---
+-->
+
 # Bundles Resolver
 
 ## Resolver Type

diff --git a/docs/cluster-resolver.md b/docs/cluster-resolver.md
@@ -1,3 +1,10 @@
+<!--
+---
+linkTitle: "Cluster Resolver"
+weight: 310
+---
+-->
+
 # Cluster Resolver
 
 ## Resolver Type

diff --git a/docs/compute-resources.md b/docs/compute-resources.md
@@ -1,7 +1,7 @@
 <!--
 ---
-linkTitle: "LimitRange"
-weight: 300
+linkTitle: "Compute Resources Limits"
+weight: 408
 ---
 -->
 

diff --git a/docs/conditions.md b/docs/conditions.md
diff --git a/docs/container-contract.md b/docs/container-contract.md
@@ -1,9 +1,10 @@
 <!--
 ---
 linkTitle: "Container Contract"
-weight: 1700
+weight: 401
 ---
 -->
+
 # Container Contract
 
 Each container image that executes a `Step` in a [`Task`](tasks.md) must

diff --git a/docs/customruns.md b/docs/customruns.md
@@ -1,7 +1,7 @@
 <!--
 ---
 linkTitle: "CustomRuns"
-weight: 800
+weight: 206
 ---
 -->
 

diff --git a/docs/debug.md b/docs/debug.md
@@ -1,9 +1,10 @@
 <!--
 ---
 linkTitle: "Debug"
-weight: 11
+weight: 108
 ---
 -->
+
 # Debug
 
 - [Overview](#overview)
@@ -82,4 +83,4 @@ to reflect step number. eg: Step 0 will have `/tekton/debug/info/0`, Step 1 will
 breakpoint for failed step 0. Running this script would create `/tekton/run/0` and `/tekton/run/0.breakpointexit`.
 
 `/tekton/debug/scripts/debug-fail-continue` : Mark the step as completed with failure by writing to `/tekton/run`. eg: User wants to exit
-breakpoint for failed step 0. Running this script would create `/tekton/run/0.err` and `/tekton/run/0.breakpointexit`.
+breakpoint for failed step 0. Running this script would create `/tekton/run/0.err` and `/tekton/run/0.breakpointexit`.
diff --git a/docs/deprecations.md b/docs/deprecations.md
@@ -1,7 +1,7 @@
 <!--
 ---
 linkTitle: "Deprecations"
-weight: 5000
+weight: 107
 ---
 -->
 
@@ -36,4 +36,4 @@ See [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-depreca
 
 - The [kubeconfigwriter](https://github.com/tektoncd/pipeline/blob/release-v0.43.x/pkg/apis/pipeline/images.go#L36) and [imagedigestexporter](https://github.com/tektoncd/pipeline/blob/release-v0.43.x/pkg/apis/pipeline/images.go#L46) images, used by the Cluster PipelineResource and Image PipelineResource, respectively
 
-- The [`tekton_pipelines_controller_cloudevent_count`](https://github.com/tektoncd/pipeline/blob/main/docs/metrics.md) metric
+- The [`tekton_pipelines_controller_cloudevent_count`](https://github.com/tektoncd/pipeline/blob/main/docs/metrics.md) metric
diff --git a/docs/enabling-ha.md b/docs/enabling-ha.md
@@ -1,7 +1,7 @@
 <!--
 ---
-linkTitle: "HA Support"
-weight: 1500
+linkTitle: "High Availability Support"
+weight: 106
 ---
 -->
 

diff --git a/docs/events.md b/docs/events.md
@@ -1,9 +1,10 @@
 <!--
 ---
 linkTitle: "Events"
-weight: 700
+weight: 302
 ---
 -->
+
 # Events in Tekton
 
 Tekton's controllers emits [Kubernetes events](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#event-v1-core)

diff --git a/docs/git-resolver.md b/docs/git-resolver.md
@@ -1,3 +1,10 @@
+<!--
+---
+linkTitle: "Git Resolver"
+weight: 309
+---
+-->
+
 # Simple Git Resolver
 
 ## Resolver Type

diff --git a/docs/hermetic.md b/docs/hermetic.md
@@ -1,9 +1,10 @@
 <!--
 ---
 linkTitle: "Hermetic"
-weight: 1650
+weight: 410
 ---
 -->
+
 # Hermetic Execution Mode
 A Hermetic Build is a release engineering best practice for increasing the reliability and consistency of software builds.
 They are self-contained, and do not depend on anything outside of the build environment.

diff --git a/docs/how-to-write-a-resolver.md b/docs/how-to-write-a-resolver.md
@@ -1,6 +1,13 @@
-# How To Write a Resolver
+<!--
+---
+linkTitle: "How to write a Resolver"
+weight: 104
+---
+-->
+
+# How to write a Resolver
 
-This howto will outline the steps a developer needs to take when creating
+This how-to will outline the steps a developer needs to take when creating
 a new (very basic) Resolver. Rather than focus on support for a particular version
 control system or cloud platform this Resolver will simply respond with
 with some hard-coded YAML.

diff --git a/docs/hub-resolver.md b/docs/hub-resolver.md
@@ -1,3 +1,10 @@
+<!--
+---
+linkTitle: "Hub Resolver"
+weight: 311
+---
+-->
+
 # Hub Resolver
 
 Use resolver type `hub`.

diff --git a/docs/install.md b/docs/install.md
@@ -1,7 +1,7 @@
 <!--
 ---
 title: "Install Tekton Pipelines"
-linkTitle: "Tekton Pipelines"
+linkTitle: "Install Tekton Pipelines"
 weight: 101
 description: >
   Install Tekton Pipelines on your cluster

diff --git a/docs/labels.md b/docs/labels.md
@@ -1,9 +1,10 @@
 <!--
 ---
 linkTitle: "Labels and Annotations"
-weight: 1300
+weight: 305
 ---
 -->
+
 # Labels and Annotations
 
 Tekton allows you to use custom [Kubernetes Labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)

diff --git a/docs/logs.md b/docs/logs.md
@@ -1,9 +1,10 @@
 <!--
 ---
 linkTitle: "Logs"
-weight: 1100
+weight: 303
 ---
 -->
+
 # Execution Logs
 
 Tekton stores execution logs for [`TaskRuns`](taskruns.md) and [`PipelineRuns`](pipelineruns.md) within

diff --git a/docs/matrix.md b/docs/matrix.md
@@ -1,7 +1,7 @@
 <!--
 ---
 linkTitle: "Matrix"
-weight: 11
+weight: 406
 ---
 -->
 

diff --git a/docs/metrics.md b/docs/metrics.md
@@ -1,9 +1,10 @@
 <!--
 ---
 linkTitle: "Pipeline Metrics"
-weight: 1200
+weight: 304
 ---
 -->
+
 # Pipeline Controller Metrics
 
 The following pipeline metrics are available at `controller-service` on port `9090`.

diff --git a/docs/migrating-from-knative-build.md b/docs/migrating-from-knative-build.md
diff --git a/docs/migrating-v1alpha1-to-v1beta1.md b/docs/migrating-v1alpha1-to-v1beta1.md
@@ -1,7 +1,7 @@
 <!--
 ---
 linkTitle: "Migrating from Tekton v1alpha1"
-weight: 4000
+weight: 102
 ---
 -->