From 6e2ea18666a292eeb7ce84154820bf3a6194cc94 Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Fri, 12 Jan 2024 23:56:36 +0100 Subject: [PATCH 1/2] Document core development ideas --- docs/docs/92-development/01-getting-started.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/docs/92-development/01-getting-started.md b/docs/docs/92-development/01-getting-started.md index 0889afa5b61..eb84bdac90b 100644 --- a/docs/docs/92-development/01-getting-started.md +++ b/docs/docs/92-development/01-getting-started.md @@ -1,5 +1,12 @@ # Getting started +## Core ideas + +- A configuration should never be [turing complete](https://en.wikipedia.org/wiki/Turing_completeness) (We have agents to exec things 🙂). +- If possible follow the [KISS principle](https://en.wikipedia.org/wiki/KISS_principle). +- What is used most should be default. +- Keep different topics separated, so you can write plugins, port new ideas ... more easily, see [Architecture](./05-architecture.md). + You can develop on your local computer by following the [steps below](#preparation-for-local-development) or you can start with a fully prepared online setup using [Gitpod](https://github.com/gitpod-io/gitpod) and [Gitea](https://github.com/go-gitea/gitea). ## Gitpod From 487adc9b229ed0433589b1adb097541823b2adda Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Sat, 13 Jan 2024 00:41:12 +0100 Subject: [PATCH 2/2] Update docs/docs/92-development/01-getting-started.md --- docs/docs/92-development/01-getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/92-development/01-getting-started.md b/docs/docs/92-development/01-getting-started.md index eb84bdac90b..367e5828420 100644 --- a/docs/docs/92-development/01-getting-started.md +++ b/docs/docs/92-development/01-getting-started.md @@ -2,7 +2,7 @@ ## Core ideas -- A configuration should never be [turing complete](https://en.wikipedia.org/wiki/Turing_completeness) (We have agents to exec things 🙂). +- A (e.g. pipeline) configuration should never be [turing complete](https://en.wikipedia.org/wiki/Turing_completeness) (We have agents to exec things 🙂). - If possible follow the [KISS principle](https://en.wikipedia.org/wiki/KISS_principle). - What is used most should be default. - Keep different topics separated, so you can write plugins, port new ideas ... more easily, see [Architecture](./05-architecture.md).