From d29cba2946b1d81090856ece27667cec3be6a270 Mon Sep 17 00:00:00 2001
From: Earl Warren <contact@earl-warren.org>
Date: Mon, 1 Sep 2025 11:32:19 +0000
Subject: [PATCH] chore: explain the difference between `job_level` and `level`
 (#922)

<!--start release-notes-assistant-->
<!--URL:https://code.forgejo.org/forgejo/runner-->
- other
  - [PR](https://code.forgejo.org/forgejo/runner/pulls/922): <!--number 922 --><!--line 0 --><!--description Y2hvcmU6IGV4cGxhaW4gdGhlIGRpZmZlcmVuY2UgYmV0d2VlbiBgam9iX2xldmVsYCBhbmQgYGxldmVsYA==-->chore: explain the difference between `job_level` and `level`<!--description-->
<!--end release-notes-assistant-->

Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/922
Reviewed-by: msrd0 <msrd0@noreply.code.forgejo.org>
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
---
 internal/pkg/config/config.example.yaml | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/internal/pkg/config/config.example.yaml b/internal/pkg/config/config.example.yaml
index ec12a8a1..14decb32 100644
--- a/internal/pkg/config/config.example.yaml
+++ b/internal/pkg/config/config.example.yaml
@@ -3,10 +3,19 @@
 # You don't have to copy this file to your instance,
 # just run `forgejo-runner generate-config > config.yaml` to generate a config file.
 
+#
+# The value of level or job_level can be trace, debug, info, warn, error or fatal
+#
 log:
-  # The level of logging, can be trace, debug, info, warn, error, fatal
+  #
+  # What is displayed in the output of the runner process but not sent
+  # to the Forgejo instance.
+  #
   level: info
-  # The level of logging for jobs, can be trace, debug, info, earn, error, fatal
+  #
+  # What is sent to the Forgejo instance and therefore
+  # visible in the web UI for a given job.
+  #
   job_level: info
 
 runner: