From fee25583b00b395b7d9b35931f3e1bcd555592d9 Mon Sep 17 00:00:00 2001 From: pat-s Date: Tue, 10 Dec 2024 11:45:45 +0100 Subject: [PATCH] chore: rewrite intro --- docs/docs/10-intro/index.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/docs/docs/10-intro/index.md b/docs/docs/10-intro/index.md index 7d9ced179..86601492c 100644 --- a/docs/docs/10-intro/index.md +++ b/docs/docs/10-intro/index.md @@ -1,26 +1,25 @@ # Welcome to Woodpecker -Woodpecker is a CI/CD tool. It is designed to be lightweight, simple to use and fast. Before we dive into the details, let's have a look at some of the basics. +Woodpecker is a CI/CD tool. It is designed to be lightweight (< 200 MB memory consumption), simple to use and fast and can be used with many different Git providers and backends (docker, kubernetes, local). -## Have you ever heard of CI/CD or pipelines? +## The "CI/CD" concept -Don't worry if you haven't. We'll guide you through the basics. CI/CD stands for Continuous Integration and Continuous Deployment. It's basically like a conveyor belt that moves your code from development to production doing all kinds of -checks, tests and routines along the way. A typical pipeline might include the following steps: +CI/CD stands for "Continuous Integration” and “Continuous Deployment.” +It is a streamlined process that moves your code from development to production while performing various checks, tests, and routines along the way. +A standard CI/CD pipeline typically includes steps such as: 1. Running tests -2. Building your application -3. Deploying your application +2. Building the application +3. Deploying the application -[Have a deeper look into the idea of CI/CD](https://www.redhat.com/en/topics/devops/what-is-ci-cd) +RedHat has written an [article which explains the concept in more detail](https://www.redhat.com/en/topics/devops/what-is-ci-cd). -## Do you know containers? +## Containers at the core -If you are already using containers in your daily workflow, you'll for sure love Woodpecker. If not yet, you'll be amazed how easy it is to get started with [containers](https://opencontainers.org/). +In contrast to other CI/CD applications, Woodpecker solely focuses on using containers for executing workflows. +If you are already using containers in your daily workflow, you'll for sure love Woodpecker. -## Already have access to a Woodpecker instance? +## Convinced? Get started by deploying your own Woodpecker instance -Then you might want to jump directly into it and [start creating your first pipelines](../20-usage/10-intro.md). - -## Want to start from scratch and deploy your own Woodpecker instance? - -Woodpecker is [pretty lightweight](../30-administration/00-getting-started.md#hardware-requirements) and will even run on your Raspberry Pi. You can follow the [deployment guide](../30-administration/00-getting-started.md) to set up your own Woodpecker instance. +Woodpecker is [pretty lightweight](../30-administration/00-getting-started.md#hardware-requirements) and can even run on a Raspberry Pi without much impact. +To set up your own Woodpecker instance, follow the [deployment guide](../30-administration/00-getting-started.md).