From fa0003eb827485d2485b1c0d8f16e481e7b13f04 Mon Sep 17 00:00:00 2001
From: pollfly <75068813+pollfly@users.noreply.github.com>
Date: Wed, 17 Jul 2024 09:50:55 +0300
Subject: [PATCH] Add ClearML Agent deployment options (#877)

---
 docs/clearml_agent.md                           | 17 +++++++++++------
 docs/clearml_agent/clearml_agent_deployment.md  |  7 +++++++
 .../clearml_agent/clearml_agent_google_colab.md |  8 --------
 sidebars.js                                     |  2 +-
 4 files changed, 19 insertions(+), 15 deletions(-)
 delete mode 100644 docs/clearml_agent/clearml_agent_google_colab.md

diff --git a/docs/clearml_agent.md b/docs/clearml_agent.md
index 7674e69f..d58f01e1 100644
--- a/docs/clearml_agent.md
+++ b/docs/clearml_agent.md
@@ -59,12 +59,17 @@ original values:
 * Modified recorded command line arguments will have the ClearML agent inject the new values in their stead
 * Code-level configuration instrumented with [`Task.connect()`](references/sdk/task.md#connect) will be overridden by modified hyperparameters
 
-For more information, see [ClearML Agent Reference](clearml_agent/clearml_agent_ref.md), 
-and [configuration options](configs/clearml_conf.md#agent-section).
-
+ClearML Agent can be deployed in various setups to suit different workflows and infrastructure needs:
+* [Bare Metal](clearml_agent/clearml_agent_deployment.md#spinning-up-an-agent)
+* [Kubernetes](clearml_agent/clearml_agent_deployment.md#kubernetes)
+* [Slurm](clearml_agent/clearml_agent_deployment.md#slurm)
+* [Google Colab](guides/ide/google_colab.md)
 
 ## References
 
-* See [ClearML Agent CLI](clearml_agent/clearml_agent_ref.md) for a reference for `clearml-agent`'s CLI commands. 
-* See [ClearML Agent Environment Variables](clearml_agent/clearml_agent_env_var.md) for a list of environment variables
-to configure ClearML Agent
\ No newline at end of file
+For more information, see the following:
+* [ClearML Agent CLI](clearml_agent/clearml_agent_ref.md) for a reference for `clearml-agent`'s CLI commands. 
+* [ClearML Agent Environment Variables](clearml_agent/clearml_agent_env_var.md) for a list of environment variables
+to configure ClearML Agent
+* [Agent Section](configs/clearml_conf.md#agent-section) for a list of options to configure the ClearML Agent in the 
+`clearml.conf`
\ No newline at end of file
diff --git a/docs/clearml_agent/clearml_agent_deployment.md b/docs/clearml_agent/clearml_agent_deployment.md
index 6475708a..abe9e6f4 100644
--- a/docs/clearml_agent/clearml_agent_deployment.md
+++ b/docs/clearml_agent/clearml_agent_deployment.md
@@ -239,6 +239,13 @@ If you are running Slurm with Singularity containers support, set the following:
    clearml-agent-slurm --singularity-mode --template-files slurm.example_singularity.template --queue default
    ```
 
+## Google Colab
+
+ClearML Agent can run on a [Google Colab](https://colab.research.google.com/) instance. This helps users to leverage 
+compute resources provided by Google Colab and send experiments for execution on it. 
+
+Check out [this tutorial](../guides/ide/google_colab.md) on how to run a ClearML Agent on Google Colab!
+
 ## Explicit Task Execution
 
 ClearML Agent can also execute specific tasks directly, without listening to a queue.
diff --git a/docs/clearml_agent/clearml_agent_google_colab.md b/docs/clearml_agent/clearml_agent_google_colab.md
deleted file mode 100644
index 376f87d4..00000000
--- a/docs/clearml_agent/clearml_agent_google_colab.md
+++ /dev/null
@@ -1,8 +0,0 @@
----
-title: Google Colab
----
-
-ClearML Agent can run on a [Google Colab](https://colab.research.google.com/) instance. This helps users to leverage 
-compute resources provided by Google Colab and send experiments for execution on it. 
-
-Check out [this tutorial](../guides/ide/google_colab.md) on how to run a ClearML Agent on Google Colab!
\ No newline at end of file
diff --git a/sidebars.js b/sidebars.js
index 21c49b43..afa606f0 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -41,7 +41,7 @@ module.exports = {
             'clearml_agent/clearml_agent_execution_env', 'clearml_agent/clearml_agent_env_caching',
             'clearml_agent/clearml_agent_dynamic_gpus', 'clearml_agent/clearml_agent_fractional_gpus',
             'clearml_agent/clearml_agent_services_mode', 'clearml_agent/clearml_agent_docker',
-            'clearml_agent/clearml_agent_google_colab', 'clearml_agent/clearml_agent_scheduling'
+            'clearml_agent/clearml_agent_scheduling'
         ]},
         {'Cloud Autoscaling': [
             'cloud_autoscaling/autoscaling_overview',