Skip to content

Commit 9e3bccd

Browse files
skaegitekton-robot
authored andcommitted
Fix broken markdown links in our doc
To check for broken links I ran `find . -name \*.md -exec markdown-link-check -q {} \;` in the docs folder.
1 parent 9e8e752 commit 9e3bccd

File tree

3 files changed

+49
-40
lines changed

3 files changed

+49
-40
lines changed

docs/pipelineruns.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,18 @@ Creation of a `PipelineRun` will trigger the creation of
1111

1212
---
1313

14-
- [Syntax](#syntax)
15-
- [Resources](#resources)
16-
- [Params](#params)
17-
- [Service account](#service-account)
18-
- [Service accounts](#service-accounts)
19-
- [Pod Template](#pod-template)
14+
- [PipelineRuns](#pipelineruns)
15+
- [Syntax](#syntax)
16+
- [Specifying a pipeline](#specifying-a-pipeline)
17+
- [Resources](#resources)
18+
- [Params](#params)
19+
- [Service Account](#service-account)
20+
- [Service Accounts](#service-accounts)
21+
- [Pod Template](#pod-template)
22+
- [PersistentVolumeClaims](#persistentvolumeclaims)
2023
- [Workspaces](#workspaces)
21-
- [Cancelling a PipelineRun](#cancelling-a-pipelinerun)
22-
- [Examples](https://github.com/tektoncd/pipeline/tree/master/examples/v1beta1/pipelineruns)
23-
- [Logs](logs.md)
24-
- [LimitRanges](#limitranges)
24+
- [Cancelling a PipelineRun](#cancelling-a-pipelinerun)
25+
- [LimitRanges](#limitranges)
2526

2627
## Syntax
2728

@@ -374,7 +375,7 @@ workspaces:
374375
secretName: my-secret
375376
```
376377

377-
_For a complete example see [workspace.yaml](../examples/v1beta1/pipelineruns/workspace.yaml)._
378+
_For a complete example see [workspaces.yaml](../examples/v1beta1/pipelineruns/workspaces.yaml)._
378379

379380
## Cancelling a PipelineRun
380381

docs/pipelines.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,23 @@ This document defines `Pipelines` and their capabilities.
44

55
---
66

7-
- [Syntax](#syntax)
8-
- [Declared resources](#declared-resources)
9-
- [Workspaces](#declared-workspaces)
10-
- [Parameters](#parameters)
11-
- [Pipeline Tasks](#pipeline-tasks)
12-
- [From](#from)
13-
- [RunAfter](#runAfter)
14-
- [Retries](#retries)
15-
- [Conditions](#conditions)
16-
- [Timeout](#timeout)
17-
- [Results](#results)
18-
- [Ordering](#ordering)
19-
- [Examples](#examples)
7+
- [Pipelines](#pipelines)
8+
- [Syntax](#syntax)
9+
- [Description](#description)
10+
- [Declared resources](#declared-resources)
11+
- [Declared Workspaces](#declared-workspaces)
12+
- [Workspaces Don't Imply Task Ordering (Yet)](#workspaces-dont-imply-task-ordering-yet)
13+
- [Parameters](#parameters)
14+
- [Usage](#usage)
15+
- [Pipeline Tasks](#pipeline-tasks)
16+
- [from](#from)
17+
- [runAfter](#runafter)
18+
- [retries](#retries)
19+
- [conditions](#conditions)
20+
- [Timeout](#timeout)
21+
- [Results](#results)
22+
- [Ordering](#ordering)
23+
- [Examples](#examples)
2024

2125
## Syntax
2226

@@ -448,7 +452,7 @@ params:
448452

449453
In this example the previous pipeline task has name "previous-task-name" and its result is declared in the Task definition as having name "bar-result".
450454

451-
For a complete example demonstrating Task Results in a Pipeline see the [pipelinerun example](../examples/pipelineruns/task_results_example.yaml).
455+
For a complete example demonstrating Task Results in a Pipeline see the [pipelinerun example](../examples/v1beta1/pipelineruns/task_results_example.yaml).
452456

453457
### Ordering
454458

docs/taskruns.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,26 @@ A `TaskRun` runs until all `steps` have completed or until a failure occurs.
1111

1212
---
1313

14-
- [Syntax](#syntax)
15-
- [Specifying a `Task`](#specifying-a-task)
16-
- [Parameters](#parameters)
17-
- [Providing resources](#providing-resources)
18-
- [Overriding where resources are copied from](#overriding-where-resources-are-copied-from)
19-
- [Service Account](#service-account)
14+
- [TaskRuns](#taskruns)
15+
- [Syntax](#syntax)
16+
- [Specifying a task](#specifying-a-task)
17+
- [Parameters](#parameters)
18+
- [Providing resources](#providing-resources)
19+
- [Configuring Default Timeout](#configuring-default-timeout)
20+
- [Service Account](#service-account)
2021
- [Pod Template](#pod-template)
2122
- [Workspaces](#workspaces)
22-
- [Status](#status)
23-
- [Steps](#steps)
24-
- [Task Results](#results)
25-
- [Cancelling a TaskRun](#cancelling-a-taskrun)
26-
- [Examples](#examples)
27-
- [Sidecars](#sidecars)
28-
- [Logs](logs.md)
29-
- [LimitRanges](#limitranges)
23+
- [Status](#status)
24+
- [Steps](#steps)
25+
- [Results](#results)
26+
- [Cancelling a TaskRun](#cancelling-a-taskrun)
27+
- [Examples](#examples)
28+
- [Example TaskRun](#example-taskrun)
29+
- [Example with embedded specs](#example-with-embedded-specs)
30+
- [Example Task Reuse](#example-task-reuse)
31+
- [Using a `ServiceAccount`](#using-a-serviceaccount)
32+
- [Sidecars](#sidecars)
33+
- [LimitRanges](#limitranges)
3034

3135
---
3236

@@ -307,7 +311,7 @@ workspaces:
307311
secretName: my-secret
308312
```
309313

310-
_For a complete example see [workspace.yaml](../examples/taskruns/workspace.yaml)._
314+
_For a complete example see [workspace.yaml](../examples/v1beta1/taskruns/workspace.yaml)._
311315

312316
## Status
313317

0 commit comments

Comments
 (0)