generic overview

PrefectHQ · Sep 7, 2023 · 44fe764 · 44fe764
1 parent 317ceea
commit 44fe764
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/charts/prefect-worker/README.md b/charts/prefect-worker/README.md
@@ -1,8 +1,10 @@
 # prefect-worker
 
-Prefect Worker application bundle
+## Overview
 
-**Homepage:** <https://github.com/PrefectHQ>
+[Workers](https://docs.prefect.io/latest/concepts/work-pools/#worker-overview) are lightweight polling services that retrieve scheduled runs from a work pool and execute them.
+
+Workers each have a type corresponding to the execution environment to which they will submit flow runs. Workers are only able to join work pools that match their type. As a result, when deployments are assigned to a work pool, you know in which execution environment scheduled flow runs for that deployment will run.
 
 ## Installing the Chart
 

diff --git a/charts/prefect-worker/README.md.gotmpl b/charts/prefect-worker/README.md.gotmpl
@@ -1,7 +1,10 @@
 {{ template "chart.header" . }}
-{{ template "chart.description" . }}
 
-{{ template "chart.homepageLine" . }}
+## Overview
+
+[Workers](https://docs.prefect.io/latest/concepts/work-pools/#worker-overview) are lightweight polling services that retrieve scheduled runs from a work pool and execute them.
+
+Workers each have a type corresponding to the execution environment to which they will submit flow runs. Workers are only able to join work pools that match their type. As a result, when deployments are assigned to a work pool, you know in which execution environment scheduled flow runs for that deployment will run.
 
 ## Installing the Chart