Update unreleased documentation (#518)

* Update versions.json * Deployed 0f26c55 to unreleased in versions with MkDocs 1.5.3 and mike 2.0.0 * Sort docs versions --------- Co-authored-by: GitHub Actions Bot <[email protected]>
PrefectHQ · Dec 20, 2023 · f09f41e · f09f41e
1 parent 4909479
commit f09f41e
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 47 deletions.
diff --git a/versions/unreleased/api-ref/prefect/workers/process/index.html b/versions/unreleased/api-ref/prefect/workers/process/index.html
@@ -7206,9 +7206,7 @@ <h1 id="prefect.workers.process" class="doc doc-heading">
 
   <div class="doc doc-contents first">
 
-      <p><span class="badge-api beta"/></p>
-<p>Module containing the Process worker used for executing flow runs as subprocesses.</p>
-<p>Note this module is in <strong>beta</strong>. The interfaces within may change without notice.</p>
+      <p>Module containing the Process worker used for executing flow runs as subprocesses.</p>
 <p>To start a Process worker, run the following command:</p>
 <div class="highlight"><pre><span></span><code>prefect<span class="w"> </span>worker<span class="w"> </span>start<span class="w"> </span>--pool<span class="w"> </span><span class="s1">&#39;my-work-pool&#39;</span><span class="w"> </span>--type<span class="w"> </span>process
 </code></pre></div>
@@ -7247,7 +7245,11 @@ <h2 id="prefect.workers.process.ProcessJobConfiguration" class="doc doc-heading"
 
             <details class="quote">
               <summary>Source code in <code>prefect/workers/process.py</code></summary>
-              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 86</span>
+              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 82</span>
+<span class="normal"> 83</span>
+<span class="normal"> 84</span>
+<span class="normal"> 85</span>
+<span class="normal"> 86</span>
 <span class="normal"> 87</span>
 <span class="normal"> 88</span>
 <span class="normal"> 89</span>
@@ -7274,11 +7276,7 @@ <h2 id="prefect.workers.process.ProcessJobConfiguration" class="doc doc-heading"
 <span class="normal">110</span>
 <span class="normal">111</span>
 <span class="normal">112</span>
-<span class="normal">113</span>
-<span class="normal">114</span>
-<span class="normal">115</span>
-<span class="normal">116</span>
-<span class="normal">117</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">ProcessJobConfiguration</span><span class="p">(</span><span class="n">BaseJobConfiguration</span><span class="p">):</span>
+<span class="normal">113</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">ProcessJobConfiguration</span><span class="p">(</span><span class="n">BaseJobConfiguration</span><span class="p">):</span>
     <span class="n">stream_output</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
     <span class="n">working_dir</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Path</span><span class="p">]</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 
@@ -7343,12 +7341,12 @@ <h3 id="prefect.workers.process.ProcessJobConfiguration.validate_command" class=
 
           <details class="quote">
             <summary>Source code in <code>prefect/workers/process.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">90</span>
-<span class="normal">91</span>
-<span class="normal">92</span>
-<span class="normal">93</span>
-<span class="normal">94</span>
-<span class="normal">95</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@validator</span><span class="p">(</span><span class="s2">&quot;working_dir&quot;</span><span class="p">)</span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">86</span>
+<span class="normal">87</span>
+<span class="normal">88</span>
+<span class="normal">89</span>
+<span class="normal">90</span>
+<span class="normal">91</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@validator</span><span class="p">(</span><span class="s2">&quot;working_dir&quot;</span><span class="p">)</span>
 <span class="k">def</span> <span class="nf">validate_command</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">v</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Make sure that the working directory is formatted for the current platform.&quot;&quot;&quot;</span>
     <span class="k">if</span> <span class="n">v</span><span class="p">:</span>
@@ -7389,8 +7387,8 @@ <h2 id="prefect.workers.process.ProcessWorkerResult" class="doc doc-heading">
 
             <details class="quote">
               <summary>Source code in <code>prefect/workers/process.py</code></summary>
-              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">139</span>
-<span class="normal">140</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">ProcessWorkerResult</span><span class="p">(</span><span class="n">BaseWorkerResult</span><span class="p">):</span>
+              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">135</span>
+<span class="normal">136</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">ProcessWorkerResult</span><span class="p">(</span><span class="n">BaseWorkerResult</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Contains information about the final state of a completed process&quot;&quot;&quot;</span>
 </code></pre></div></td></tr></table></div>
             </details>

diff --git a/versions/unreleased/guides/managed-execution/index.html b/versions/unreleased/guides/managed-execution/index.html
@@ -7432,7 +7432,7 @@
 
 
 
-<h1 id="managed-execution">Managed Execution <span class="badge cloud"></span> <span class="badge-api beta"/><a class="headerlink" href="#managed-execution" title="Permanent link">&para;</a></h1>
+<h1 id="managed-execution">Managed Execution <span class="badge cloud"></span> <span class="badge beta"/><a class="headerlink" href="#managed-execution" title="Permanent link">&para;</a></h1>
 <p>Prefect Cloud can run your flows on your behalf with <strong>prefect:managed</strong> work pools. Flows run with this work pool do not require a worker or cloud provider account. Prefect handles the infrastructure and code execution for you.</p>
 <p>Managed execution is a great option for users who want to get started quickly, with no infrastructure setup.</p>
 <div class="admonition warning">
@@ -7490,12 +7490,16 @@ <h2 id="limitations">Limitations<a class="headerlink" href="#limitations" title=
 <p>All limitations listed below may change without warning during the beta period.
 We will update this page as we make changes.</p>
 <h3 id="concurrency-work-pools">Concurrency &amp; work pools<a class="headerlink" href="#concurrency-work-pools" title="Permanent link">&para;</a></h3>
-<p>Free tier accounts are limited to:
-- Maximum of 1 concurrent flow run per workspace across all <code>prefect:managed</code> pools.
-- Maximum of 1 managed execution work pool per workspace.</p>
-<p>Pro tier and above accounts are limited to:
-- Maximum of 10 concurrent flow runs per workspace across all <code>prefect:managed</code> pools.
-- Maximum of 5 managed execution work pools per workspace.</p>
+<p>Free tier accounts are limited to:</p>
+<ul>
+<li>Maximum of 1 concurrent flow run per workspace across all <code>prefect:managed</code> pools.</li>
+<li>Maximum of 1 managed execution work pool per workspace.</li>
+</ul>
+<p>Pro tier and above accounts are limited to:</p>
+<ul>
+<li>Maximum of 10 concurrent flow runs per workspace across all <code>prefect:managed</code> pools.</li>
+<li>Maximum of 5 managed execution work pools per workspace.</li>
+</ul>
 <h3 id="images">Images<a class="headerlink" href="#images" title="Permanent link">&para;</a></h3>
 <p>At this time, managed execution requires that you run the official Prefect Docker image: <code>prefecthq/prefect:2-latest</code>. However, as noted above, you can install Python package dependencies at runtime. If you need to use your own image, we recommend using another type of work pool.</p>
 <h3 id="code-storage">Code storage<a class="headerlink" href="#code-storage" title="Permanent link">&para;</a></h3>

diff --git a/versions/unreleased/guides/prefect-deploy/index.html b/versions/unreleased/guides/prefect-deploy/index.html
@@ -7696,7 +7696,8 @@ <h1 id="deploying-flows-to-work-pools-and-workers">Deploying Flows to Work Pools
 <p>In this guide, we will configure a deployment that uses a work pool for for dynamically provisioned infrastructure.</p>
 <p>All Prefect flow runs are tracked by the API. The API does not require prior registration of flows.
 With Prefect, you can call a flow locally or on a remote environment and it will be tracked.</p>
-<p>A deployment turns your workflow into an application that can be interacted with and managed via the Prefect API. A deployment enables you to:</p>
+<p>A deployment turns your workflow into an application that can be interacted with and managed via the Prefect API.
+A deployment enables you to:</p>
 <ul>
 <li>Schedule flow runs.</li>
 <li>Specify event triggers for flow runs.</li>
@@ -7714,13 +7715,11 @@ <h2 id="work-pool-based-deployments">Work pool-based deployments<a class="header
 Work pool-based deployments contain information about the infrastructure type and configuration for your workflow execution.</p>
 <p>Work pool-based deployment infrastructure options include the following:</p>
 <ul>
-<li>Process - runs flow in a subprocess. Generally better off using <code>.serve</code></li>
+<li>Process - runs flow in a subprocess. In most cases, you're better off using <code>.serve</code>.</li>
 <li><a href="/guides/deployment/docker/">Docker</a> - runs flows in an ephemeral Docker container.</li>
 <li><a href="/guides/deployment/kubernetes/">Kubernetes</a> - runs flows as a Kubernetes Job.</li>
+<li><a href="/guides/deployment/serverless-workers/">Serverless Cloud Provider options</a> - runs flows in a Docker container in a serverless cloud provider environment, such as AWS ECS, Azure Container Instance, Google Cloud Run, or Vertex AI.</li>
 </ul>
-<!-- - [Serverless Cloud Provider options] TK - Jeff PR in progress, awaiting ACI PR in progress - runs flows in a Docker container in a serverless cloud provider environment, such as AWS ECS, Azure Container Instance, Google Cloud Run, or Vertex AI. -->
-
-<p>Work pool-based deployments also allow you to assign a work queue name to prioritize work and allow you to limit concurrent runs at the work pool level.</p>
 <p>The following diagram provides a high-level overview of the conceptual elements involved in defining a work-pool based deployment that is polled by a worker and executes a flow run based on that deployment.</p>
 <pre class="mermaid"><code>%%{
   init: {
@@ -7761,21 +7760,26 @@ <h2 id="work-pool-based-deployments">Work pool-based deployments<a class="header
 <p class="admonition-title">Additional work pool options available with Prefect Cloud</p>
 <p>Prefect Cloud offers other flavors of work pools that don't require a worker:</p>
 <ul>
-<li><a href="/guides/deployment/push-work-pools">Push Work Pools</a> - serverless cloud options that don't require a worker because Prefect Cloud submits them to your cloud provider on your behalf.</li>
+<li>
+<p><a href="/guides/deployment/push-work-pools">Push Work Pools</a> - serverless cloud options that don't require a worker because Prefect Cloud submits them to your serverless cloud infrastructure on your behalf. Prefect can auto-provision your cloud infrastructure for you and set it up to use your work pool.</p>
+</li>
+<li>
+<p><a href="/guides/managed-execution/">Managed Execution</a> Prefect Cloud submits and runs your deployment on serverless infrastructure. No cloud provider account required.</p>
+</li>
 </ul>
-<!-- - <a href="">Managed Execution</a> TK - Prefect Cloud submits and runs your deployment on serverless infrastructure TK - Jake PR in progress -->
 </div>
 <p>In this guide, we focus on deployments that require a worker.</p>
-<p>When creating a deployment that uses a work pool, we must answer <em>two</em> basic questions:</p>
+<p>Work pool-based deployments that use a worker also allow you to assign a work queue name to prioritize work and allow you to limit concurrent runs at the work pool level.</p>
+<p>When creating a deployment that uses a work pool and worker, we must answer <em>two</em> basic questions:</p>
 <ul>
 <li>What instructions does a <a href="/concepts/work-pools/">worker</a> need to set up an execution environment for our flow? For example, a flow may have Python package requirements, unique Kubernetes settings, or Docker networking configuration.</li>
 <li>How should the flow code be accessed?</li>
 </ul>
 <h2 id="creating-work-pool-based-deployments">Creating work pool-based deployments<a class="headerlink" href="#creating-work-pool-based-deployments" title="Permanent link">&para;</a></h2>
 <p>The <a href="/tutorial/deployments/">tutorial</a> shows how you can create a deployment with a long-running process using <code>.serve</code> and how to move to a <a href="/tutorial/workers/">work-pool-based deployment</a> setup with <code>.deploy</code>.
 See the discussion of when you might want to move to work-pool-based deployments <a href="/tutorial/workers/#why-workers-and-work-pools">there</a>.</p>
-<p>In this guide, we will explore how to use <code>.deploy</code> in more depth and discuss <code>prefect.yaml</code>, a YAML-based alternative for managing deployments.</p>
-<p>Use the tabs below to explore both deployment creation options.</p>
+<p>In this guide, we show how to use <code>.deploy</code> in more depth and discuss <code>prefect.yaml</code>, a YAML-based alternative for managing deployments.</p>
+<p>Use the tabs below to explore these two deployment creation options.</p>
 <div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">.deploy</label><label for="__tabbed_1_2">prefect.yaml</label></div>
 <div class="tabbed-content">
 <div class="tabbed-block">

diff --git a/versions/unreleased/search/search_index.json b/versions/unreleased/search/search_index.json
diff --git a/versions/unreleased/sitemap.xml.gz b/versions/unreleased/sitemap.xml.gz
diff --git a/versions/unreleased/stylesheets/extra.css b/versions/unreleased/stylesheets/extra.css
@@ -199,16 +199,12 @@ to force column width */
     border-radius: 5px;
 }
 
-/* .experimental::before {
-    background-color: #fccc3e;
-    content: "Experimental";
-} */
-
 .beta::before {
     background-color: #ffffff00;
     color: rgb(131, 131, 131);
     border: 1px solid rgb(131, 131, 131);
     content: "Beta";
+    vertical-align: middle;
 }
 
 .experimental::before {
@@ -219,13 +215,6 @@ to force column width */
     vertical-align: middle;
 }
 
-.beta::before {
-    background-color: #ffffff00;
-    color: rgb(131, 131, 131);
-    border: 1px solid rgb(131, 131, 131);
-    content: "Beta";
-}
-
 .cloud::before {
     background-color: #799AF7;
     content: "Prefect Cloud";