From 95f97bd66e27d6d3629ab4239b7f3726396bec0d Mon Sep 17 00:00:00 2001
From: Sebastian Serth <Sebastian.Serth@hpi.de>
Date: Sun, 17 Oct 2021 23:11:41 +0200
Subject: [PATCH] Add documentation to code_ocean.yml

---
 config/code_ocean.yml.ci      |  2 ++
 config/code_ocean.yml.example | 37 +++++++++++++++++++++++++++++++++--
 2 files changed, 37 insertions(+), 2 deletions(-)

diff --git a/config/code_ocean.yml.ci b/config/code_ocean.yml.ci
index 1c531f9e..92b4eb01 100644
--- a/config/code_ocean.yml.ci
+++ b/config/code_ocean.yml.ci
@@ -13,4 +13,6 @@ test:
     enabled: true
     strategy: poseidon
     url: https://runners.example.org
+    ca_file: /example/certificates/ca.crt
+    token: SECRET
     unused_runner_expiration_time: 180
diff --git a/config/code_ocean.yml.example b/config/code_ocean.yml.example
index 712db04a..049ac305 100644
--- a/config/code_ocean.yml.example
+++ b/config/code_ocean.yml.example
@@ -1,37 +1,70 @@
 default: &default
   flowr:
+    # When enabled, flowr can assist learners with related search results from
+    # StackOverflow.com regarding exceptions that occurred during code execution.
+    # The search is initiated through the learners' browser and displayed in the output pane.
     enabled: false
+    # The number of search results to be displayed
     answers_per_query: 3
+
   code_pilot:
+    # When enabled, CodePilot can be used by learners to request individual help by a tutor
+    # through a video conferencing system. Optionally, it also provides access to recordings
+    # of previous sessions. Support for CodePilot is currently in beta.
     enabled: false
+    # The root URL of CodePilot
     url: //localhost:3000
+
   codeharbor:
+    # When enabled, CodeHarbor is integrated in the teachers' view and allows importing
+    # and exporting exercises from CodeOcean using the ProFormA XML format to CodeHarbor.
     enabled: false
+    # The root URL of CodeHarbor
+    url: https://codeharbor.openhpi.de
+
   codeocean_events:
+    # When enabled, learner-specific events within the editor are stored and can be used
+    # as part of learning analytics. This setting enables the JavaScript event handlers.
     enabled: false
+
   prometheus_exporter:
+    # When enabled, a dedicated endpoint using the Prometheus format is offered and might
+    # be used by a Prometheus-compatible monitoring system. Exported metrics include absolute
+    # counters of all relations with specific support for Request-for-Comments.
     enabled: false
+
   runner_management:
+    # When enabled, CodeOcean delegates the handling and management of (containerized) runners
+    # to a dedicated runner management. Otherwise, code executions are performed locally using
+    # Docker and without pre-warming support (one container per execution).
     enabled: false
+    # The strategy to use. Possible values are: poseidon, docker_container_pool
     strategy: poseidon
+    # The root URL of the runner management to use
     url: https://runners.example.org
+    # The root certificate authority to trust for TLS connections to the runner management (Poseidon only)
     ca_file: /example/certificates/ca.crt
+    # The authorization token for connections to the runner management (Poseidon only)
+    # If TLS support is not enabled, this token is transmitted in clear text!
     token: SECRET
+    # The maximum time in seconds a runner may idle  at the runner management before
+    # it is removed. Each interaction with the runner resets this time (Poseidon only)
     unused_runner_expiration_time: 180
 
+
 development:
   <<: *default
   flowr:
     enabled: true
-    answers_per_query: 3
   codeharbor:
     enabled: true
-    url: https://codeharbor.openhpi.de
+
 
 production:
   <<: *default
   prometheus_exporter:
     enabled: true
 
+
 test:
   <<: *default