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

Pipelines Docs Cleanup #6117

Merged
merged 1 commit into from
Feb 13, 2023
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/auth.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
<!--
---
linkTitle: "Authentication"
weight: 1000
weight: 301
---
-->

# Authentication at Run Time

This document describes how Tekton handles authentication when executing
Expand Down
7 changes: 7 additions & 0 deletions docs/bundle-resolver.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
<!--
---
linkTitle: "Bundles Resolver"
weight: 308
---
-->

# Bundles Resolver

## Resolver Type
Expand Down
7 changes: 7 additions & 0 deletions docs/cluster-resolver.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
<!--
---
linkTitle: "Cluster Resolver"
weight: 310
---
-->

# Cluster Resolver

## Resolver Type
Expand Down
4 changes: 2 additions & 2 deletions docs/compute-resources.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--
---
linkTitle: "LimitRange"
weight: 300
linkTitle: "Compute Resources Limits"
weight: 408
---
-->

Expand Down
16 changes: 0 additions & 16 deletions docs/conditions.md

This file was deleted.

3 changes: 2 additions & 1 deletion docs/container-contract.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/customruns.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--
---
linkTitle: "CustomRuns"
weight: 800
weight: 206
---
-->

Expand Down
5 changes: 3 additions & 2 deletions docs/debug.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
<!--
---
linkTitle: "Debug"
weight: 11
weight: 108
---
-->

# Debug

- [Overview](#overview)
Expand Down Expand Up @@ -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`.
4 changes: 2 additions & 2 deletions docs/deprecations.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--
---
linkTitle: "Deprecations"
weight: 5000
weight: 107
---
-->

Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/enabling-ha.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--
---
linkTitle: "HA Support"
weight: 1500
linkTitle: "High Availability Support"
weight: 106
---
-->

Expand Down
3 changes: 2 additions & 1 deletion docs/events.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
7 changes: 7 additions & 0 deletions docs/git-resolver.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
<!--
---
linkTitle: "Git Resolver"
weight: 309
---
-->

# Simple Git Resolver

## Resolver Type
Expand Down
3 changes: 2 additions & 1 deletion docs/hermetic.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
11 changes: 9 additions & 2 deletions docs/how-to-write-a-resolver.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
7 changes: 7 additions & 0 deletions docs/hub-resolver.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
<!--
---
linkTitle: "Hub Resolver"
weight: 311
---
-->

# Hub Resolver

Use resolver type `hub`.
Expand Down
2 changes: 1 addition & 1 deletion docs/install.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--
---
title: "Install Tekton Pipelines"
linkTitle: "Tekton Pipelines"
linkTitle: "Install Tekton Pipelines"
weight: 101
description: >
Install Tekton Pipelines on your cluster
Expand Down
3 changes: 2 additions & 1 deletion docs/labels.md
Original file line number Diff line number Diff line change
@@ -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/)
Expand Down
3 changes: 2 additions & 1 deletion docs/logs.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/matrix.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--
---
linkTitle: "Matrix"
weight: 11
weight: 406
---
-->

Expand Down
3 changes: 2 additions & 1 deletion docs/metrics.md
Original file line number Diff line number Diff line change
@@ -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`.
Expand Down
145 changes: 0 additions & 145 deletions docs/migrating-from-knative-build.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/migrating-v1alpha1-to-v1beta1.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--
---
linkTitle: "Migrating from Tekton v1alpha1"
weight: 4000
weight: 102
---
-->

Expand Down
Loading