Skip to content

Commit 3a9dd6a

Browse files
geriomtekton-robot
geriom
authored and
tekton-robot
committed
Pipelines Docs Cleanup
- Update weights to group similar docs on website - Add missing front matter to docs where it's missing - Delete obsolete docs
1 parent f595f81 commit 3a9dd6a

40 files changed

+132
-200
lines changed

‎docs/auth.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
<!--
22
---
33
linkTitle: "Authentication"
4-
weight: 1000
4+
weight: 301
55
---
66
-->
7+
78
# Authentication at Run Time
89

910
This document describes how Tekton handles authentication when executing

‎docs/bundle-resolver.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
<!--
2+
---
3+
linkTitle: "Bundles Resolver"
4+
weight: 308
5+
---
6+
-->
7+
18
# Bundles Resolver
29

310
## Resolver Type

‎docs/cluster-resolver.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
<!--
2+
---
3+
linkTitle: "Cluster Resolver"
4+
weight: 310
5+
---
6+
-->
7+
18
# Cluster Resolver
29

310
## Resolver Type

‎docs/compute-resources.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--
22
---
3-
linkTitle: "LimitRange"
4-
weight: 300
3+
linkTitle: "Compute Resources Limits"
4+
weight: 408
55
---
66
-->
77

‎docs/conditions.md

-16
This file was deleted.

‎docs/container-contract.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
<!--
22
---
33
linkTitle: "Container Contract"
4-
weight: 1700
4+
weight: 401
55
---
66
-->
7+
78
# Container Contract
89

910
Each container image that executes a `Step` in a [`Task`](tasks.md) must

‎docs/customruns.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--
22
---
33
linkTitle: "CustomRuns"
4-
weight: 800
4+
weight: 206
55
---
66
-->
77

‎docs/debug.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
<!--
22
---
33
linkTitle: "Debug"
4-
weight: 11
4+
weight: 108
55
---
66
-->
7+
78
# Debug
89

910
- [Overview](#overview)
@@ -82,4 +83,4 @@ to reflect step number. eg: Step 0 will have `/tekton/debug/info/0`, Step 1 will
8283
breakpoint for failed step 0. Running this script would create `/tekton/run/0` and `/tekton/run/0.breakpointexit`.
8384

8485
`/tekton/debug/scripts/debug-fail-continue` : Mark the step as completed with failure by writing to `/tekton/run`. eg: User wants to exit
85-
breakpoint for failed step 0. Running this script would create `/tekton/run/0.err` and `/tekton/run/0.breakpointexit`.
86+
breakpoint for failed step 0. Running this script would create `/tekton/run/0.err` and `/tekton/run/0.breakpointexit`.

‎docs/deprecations.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--
22
---
33
linkTitle: "Deprecations"
4-
weight: 5000
4+
weight: 107
55
---
66
-->
77

@@ -36,4 +36,4 @@ See [TEP-0074](https://github.com/tektoncd/community/blob/main/teps/0074-depreca
3636

3737
- 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
3838

39-
- The [`tekton_pipelines_controller_cloudevent_count`](https://github.com/tektoncd/pipeline/blob/main/docs/metrics.md) metric
39+
- The [`tekton_pipelines_controller_cloudevent_count`](https://github.com/tektoncd/pipeline/blob/main/docs/metrics.md) metric

‎docs/enabling-ha.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--
22
---
3-
linkTitle: "HA Support"
4-
weight: 1500
3+
linkTitle: "High Availability Support"
4+
weight: 106
55
---
66
-->
77

‎docs/events.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
<!--
22
---
33
linkTitle: "Events"
4-
weight: 700
4+
weight: 302
55
---
66
-->
7+
78
# Events in Tekton
89

910
Tekton's controllers emits [Kubernetes events](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#event-v1-core)

‎docs/git-resolver.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
<!--
2+
---
3+
linkTitle: "Git Resolver"
4+
weight: 309
5+
---
6+
-->
7+
18
# Simple Git Resolver
29

310
## Resolver Type

‎docs/hermetic.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
<!--
22
---
33
linkTitle: "Hermetic"
4-
weight: 1650
4+
weight: 410
55
---
66
-->
7+
78
# Hermetic Execution Mode
89
A Hermetic Build is a release engineering best practice for increasing the reliability and consistency of software builds.
910
They are self-contained, and do not depend on anything outside of the build environment.

‎docs/how-to-write-a-resolver.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1-
# How To Write a Resolver
1+
<!--
2+
---
3+
linkTitle: "How to write a Resolver"
4+
weight: 104
5+
---
6+
-->
7+
8+
# How to write a Resolver
29

3-
This howto will outline the steps a developer needs to take when creating
10+
This how-to will outline the steps a developer needs to take when creating
411
a new (very basic) Resolver. Rather than focus on support for a particular version
512
control system or cloud platform this Resolver will simply respond with
613
with some hard-coded YAML.

‎docs/hub-resolver.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
<!--
2+
---
3+
linkTitle: "Hub Resolver"
4+
weight: 311
5+
---
6+
-->
7+
18
# Hub Resolver
29

310
Use resolver type `hub`.

‎docs/install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--
22
---
33
title: "Install Tekton Pipelines"
4-
linkTitle: "Tekton Pipelines"
4+
linkTitle: "Install Tekton Pipelines"
55
weight: 101
66
description: >
77
Install Tekton Pipelines on your cluster

‎docs/labels.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
<!--
22
---
33
linkTitle: "Labels and Annotations"
4-
weight: 1300
4+
weight: 305
55
---
66
-->
7+
78
# Labels and Annotations
89

910
Tekton allows you to use custom [Kubernetes Labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)

‎docs/logs.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
<!--
22
---
33
linkTitle: "Logs"
4-
weight: 1100
4+
weight: 303
55
---
66
-->
7+
78
# Execution Logs
89

910
Tekton stores execution logs for [`TaskRuns`](taskruns.md) and [`PipelineRuns`](pipelineruns.md) within

‎docs/matrix.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--
22
---
33
linkTitle: "Matrix"
4-
weight: 11
4+
weight: 406
55
---
66
-->
77

‎docs/metrics.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
<!--
22
---
33
linkTitle: "Pipeline Metrics"
4-
weight: 1200
4+
weight: 304
55
---
66
-->
7+
78
# Pipeline Controller Metrics
89

910
The following pipeline metrics are available at `controller-service` on port `9090`.

‎docs/migrating-from-knative-build.md

-145
This file was deleted.

‎docs/migrating-v1alpha1-to-v1beta1.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--
22
---
33
linkTitle: "Migrating from Tekton v1alpha1"
4-
weight: 4000
4+
weight: 102
55
---
66
-->
77

0 commit comments

Comments
 (0)