Skip to content

Commit

Permalink
Add installation instructions to website
Browse files Browse the repository at this point in the history
This adds the installation instructions to the website under the same
section, for visibility and ease of navigation. There's no new
information from what you can find on the repo docs for each component,
but the installation instructions are presented in a cohesive way,
following the same style and structure to provide a better experience
for the user.

This also fixes some minor formatting errors and updates links in the
"Getting started" tutorials.
  • Loading branch information
geriom committed May 10, 2022
1 parent 4930334 commit 9d471db
Show file tree
Hide file tree
Showing 9 changed files with 842 additions and 10 deletions.
2 changes: 1 addition & 1 deletion content/en/docs/Concepts/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Concepts"
linkTitle: "Concepts"
weight: 2
weight: 3
description: >
Conceptual and technical information about Tekton
---
Expand Down
20 changes: 11 additions & 9 deletions content/en/docs/Getting Started/pipelines.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,31 @@
<!--
---
title: "Getting Started with Pipelines"
linkTitle: "Getting Started with Pipelines"
weight: 2
description: >
Create and run your first Tekton pipeline
---
-->

This tutorial shows you how to:

- Create two tasks.
- Create a pipeline containing your tasks.
- Use `PipelineRun` to instantiate and run the pipeline containing your tasks.
1. Create two tasks.
1. Create a pipeline containing your tasks.
1. Use `PipelineRun` to instantiate and run the pipeline containing your tasks.

For this tutorial we are going to use [minikube][minikube] to run the commands
locally.

## Prerequisites

- Complete the [Getting started with tasks](/docs/getting-started/tasks/)
tutorial. *Do not clean up your resources*, skip the last section.
1. Complete the [Getting started with tasks](/docs/getting-started/tasks/)
tutorial. *Do not clean up your resources*, skip the last section.

- [Install the Tekton CLI](/docs/cli/).
1. [Install the Tekton CLI](/docs/installation/tkn-cli/), which provides `tkn`
command.

## Creating and running a second task
## Create and run a second task

You already have a *Hello World!* task. To create a second *Goodbye World!*
task:
Expand Down Expand Up @@ -54,7 +56,7 @@ task:
When a task is part of a pipeline you don't have to instantiate it, the pipeline
is going to take care of that.

## Creating and running a pipeline
## Create and run a pipeline

A **[pipeline](/docs/pipelines/pipelines/)** defines an ordered series of tasks
arranged in a specific execution order as part of your CI/CD workflow.
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/Getting Started/tasks.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
<!--
---
title: "Getting started with Tasks"
likTitle: "Tasks"
weight: 1
description: >
Set up and run your first Tekton task
---
-->

This tutorial shows you how to

Expand Down
22 changes: 22 additions & 0 deletions content/en/docs/Installation/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!--
---
title: "Installation"
linkTitle: "Installation"
weight: 2
description: >
Install Tekton components on you cluster
---
-->

This section provides instructions to install different Tekton components on
your cluster. To proceed with the installation you must already have a cluster
with the correct permissions and [kubectl] installed and configured.

If you are going to test Tekton locally on your computer, we recommend trying
either [Minikube] or [Kind]. The [Getting Started][getting-started] guides show
how to run several simple examples using Minikube.

[minikube]: https://minikube.sigs.k8s.io/docs/start/
[kind]: https://kind.sigs.k8s.io/docs/user/quick-start/
[kubectl]: https://kubernetes.io/docs/tasks/tools/#kubectl
[getting-started]: /docs/getting-started/
Loading

0 comments on commit 9d471db

Please sign in to comment.