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

Adds "commented" website front matter to docs #2283

Merged
merged 1 commit into from
Mar 25, 2020
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
11 changes: 10 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
<!--
---
title: "Tasks and Pipelines"
linkTitle: "Tasks and Pipelines"
weight: 2
description: >
Building Blocks of Tekton CI/CD Workflow
---
-->
# Tekton Pipelines

Tekton Pipelines is a Kubernetes extension that installs and runs on your Kubernetes cluster.
Expand Down Expand Up @@ -39,7 +48,7 @@ Tekton Pipelines defines the following entities:

## Getting started

To get started, complete the [Tekton Pipelines Tutorial](tutorial.md) and go through our
To get started, complete the [Tekton Pipelines Tutorial](https://github.com/tektoncd/pipeline/blob/master/docs/tutorial.md) and go through our
[examples](https://github.com/tektoncd/pipeline/tree/master/examples).

## Understanding Tekton Pipelines
Expand Down
6 changes: 6 additions & 0 deletions docs/auth.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
---
linkTitle: "Authentication"
weight: 6
---
-->
# Authentication

This document defines how authentication is provided during execution of a
Expand Down
6 changes: 6 additions & 0 deletions docs/conditions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
---
linkTitle: "Conditions"
weight: 10
---
-->
# Conditions

This document defines `Conditions` and their capabilities.
Expand Down
6 changes: 6 additions & 0 deletions docs/container-contract.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
---
linkTitle: "Container Contracts"
weight: 7
---
-->
# Container Contract

Each container image used as a step in a [`Task`](tasks.md) must comply with a
Expand Down
6 changes: 6 additions & 0 deletions docs/labels.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
---
linkTitle: "Labels"
weight: 9
---
-->
# Labels

In order to make it easier to identify objects that are all part of the same
Expand Down
6 changes: 6 additions & 0 deletions docs/logs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
---
linkTitle: "Logs"
weight: 8
---
-->
# Logs

Logs for [`PipelineRuns`](pipelineruns.md) and [`TaskRuns`](taskruns.md) are
Expand Down
6 changes: 6 additions & 0 deletions docs/metrics.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
---
linkTitle: "Pipeline Metrics"
weight: 13
---
-->
# Pipeline Controller Metrics

Following pipeline metrics are exposed at `controller-service` on port `9090`
Expand Down
6 changes: 6 additions & 0 deletions docs/migrating-from-knative-build.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
---
linkTitle: "Migration from KNative Build"
weight: 12
---
-->
# Migrating from [Knative Build](https://github.com/knative/build)

This doc describes a process for users who are familiar with Knative `Build` and
Expand Down
6 changes: 6 additions & 0 deletions docs/pipelineruns.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
---
linkTitle: "PipelineRuns"
weight: 4
---
-->
# PipelineRuns

This document defines `PipelineRuns` and their capabilities.
Expand Down
6 changes: 6 additions & 0 deletions docs/pipelines.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
---
linkTitle: "Pipelines"
weight: 3
---
-->
# Pipelines

This document defines `Pipelines` and their capabilities.
Expand Down
8 changes: 7 additions & 1 deletion docs/podtemplates.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
---
linkTitle: "Pod Templates"
weight: 11
---
-->
# PodTemplates

A pod template specifies a subset of
Expand All @@ -6,7 +12,7 @@ configuration that will be used as the basis for the `Task` pod.

This allows to customize some Pod specific field per `Task` execution, aka `TaskRun`.

Alternatively, you can also define a default pod template in tekton config, see [here](./install.md)
Alternatively, you can also define a default pod template in tekton config, see [here](https://github.com/tektoncd/pipeline/blob/master/docs/install.md)
When a pod template is specified for a `PipelineRun` or `TaskRun`, the default pod template is ignored, i.e.
both templates are **NOT** merged, it's always one or the other.

Expand Down
6 changes: 6 additions & 0 deletions docs/resources.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
---
linkTitle: "PipelineResources"
weight: 5
---
-->
# PipelineResources

`PipelineResources` in a pipeline are the set of objects that are going to be
Expand Down
6 changes: 6 additions & 0 deletions docs/taskruns.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
---
linkTitle: "TaskRuns"
weight: 2
---
-->
# TaskRuns

Use the `TaskRun` resource object to create and run on-cluster processes to
Expand Down
6 changes: 6 additions & 0 deletions docs/tasks.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--
---
linkTitle: "Tasks"
weight: 1
---
-->
# Tasks

A `Task` (or a [`ClusterTask`](#clustertask)) is a collection of sequential
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ specific to a given cloud computing service.

## Before you begin

Before you begin this tutorial, make sure you have [installed and configured](install.md)
Before you begin this tutorial, make sure you have [installed and configured](https://github.com/tektoncd/pipeline/blob/master/docs/install.md)
the latest release of Tekton on your Kubernetes cluster, including the
[Tekton CLI](https://github.com/tektoncd/cli).

Expand Down