add airflow and snowflake agent pages and update existing agents docs

Signed-off-by: nikki everett <[email protected]>
flyteorg · Feb 2, 2024 · d317113 · d317113
1 parent 4dd0bd0
commit d317113
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 14 deletions.
diff --git a/docs/deployment/agents/airflow.rst b/docs/deployment/agents/airflow.rst
@@ -0,0 +1,6 @@
+.. _deployment-agent-setup-airflow:
+
+Airflow agent
+=================
+
+This guide provides an overview of how to set up the Airflow agent in your Flyte deployment.
diff --git a/docs/deployment/agents/bigquery.rst b/docs/deployment/agents/bigquery.rst
@@ -1,6 +1,6 @@
 .. _deployment-agent-setup-bigquery:
 
-Google BigQuery Agent
+Google BigQuery agent
 ======================
 
 This guide provides an overview of setting up BigQuery agent in your Flyte deployment.

diff --git a/docs/deployment/agents/databricks.rst b/docs/deployment/agents/databricks.rst
@@ -1,6 +1,6 @@
 .. _deployment-agent-setup-databricks:
 
-Databricks Agent
+Databricks agent
 =================
 
 This guide provides an overview of how to set up Databricks agent in your Flyte deployment.

diff --git a/docs/deployment/agents/index.md b/docs/deployment/agents/index.md
@@ -2,31 +2,36 @@
 
 # Agent Setup
 
-.. tags:: Agent, Integration, Data, Advanced
+```{tags} Agent, Integration, Data, Advanced
+```
 
 To set configure your Flyte deployment for agents, see the documentation below.
 
 ```{list-table}
 :header-rows: 0
 :widths: 20 30
 
+* - {ref}`Airflow Agent <deployment-agent-setup-airflow>`
+  - Configuring your Flyte deployment for the Airflow agent
 * - {ref}`Bigquery Agent <deployment-agent-setup-bigquery>`
-  - Guide to setting up the Bigquery agent.
+  - Configuring your Flyte deployment for the Bigquery agent.
+* - {ref}`Databricks Agent <deployment-agent-setup-databricks>`
+  - Configuring your Flyte deployment for the Databricks agent.
 * - {ref}`MMCloud Agent <deployment-agent-setup-mmcloud>`
-  - Guide to setting up the MMCloud agent.
+  - Configuring your Flyte deployment for the MMCloud agent.
 * - {ref}`Sensor Agent <deployment-agent-setup-sensor>`
-  - Guide to setting up the Sensor agent.
-* - {ref}`Databricks Agent <deployment-agent-setup-databricks>`
-  - Guide to setting up the Databricks agent.
+  - Configuring your Flyte deployment for the sensor agent.
 ```
 
 ```{toctree}
 :maxdepth: 1
 :name: Agent setup
 :hidden:
 
+airflow
 bigquery
-mmcloud
 databricks
+mmcloud
 sensor
+snowflake
 ```
diff --git a/docs/deployment/agents/sensor.rst b/docs/deployment/agents/sensor.rst
@@ -1,13 +1,13 @@
 .. _deployment-agent-setup-sensor:
 
-Sensor Agent
+Sensor agent
 =================
 
-Sensor enables users to continuously check for a file or a condition to be met periodically.
+The sensor agent enables users to continuously check for a file or a condition to be met periodically.
 
 When the condition is met, the sensor will complete.
 
-This guide provides an overview of how to set up Sensor in your Flyte deployment.
+This guide provides an overview of how to set up the sensor agent in your Flyte deployment.
 
 Spin up a cluster
 -----------------
@@ -43,7 +43,7 @@ Spin up a cluster
 Specify agent configuration
 ----------------------------
 
-Enable the Sensor agent by adding the following config to the relevant YAML file(s):
+Enable the sensor agent by adding the following config to the relevant YAML file(s):
 
 .. tabs::
 
@@ -77,7 +77,7 @@ Enable the Sensor agent by adding the following config to the relevant YAML file
 
     .. group-tab:: Flyte core
 
-      Create a file named ``values-override.yaml`` and add the following configuration to it.
+      Create a file named ``values-override.yaml`` and add the following configuration to it:
 
       .. code-block:: yaml
 

diff --git a/docs/deployment/agents/snowflake.rst b/docs/deployment/agents/snowflake.rst
@@ -0,0 +1,6 @@
+.. _deployment-agent-setup-snowflake:
+
+Snowflake agent
+=================
+
+This guide provides an overview of how to set up the Snowflake agent in your Flyte deployment.