Update unreleased documentation (#809)

* Update versions.json * Deployed c85b974 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 · Sep 3, 2024 · 878d6ba · 878d6ba
1 parent 3d2315e
commit 878d6ba
Show file tree

Hide file tree

Showing 341 changed files with 3,926 additions and 3,534 deletions.
diff --git a/versions/unreleased/404.html b/versions/unreleased/404.html
@@ -197,7 +197,8 @@
 
 <div style="text-align:center">
     <strong>
-        Prefect 3 is live! See the docs at <a href="https://docs-3.prefect.io" target="_blank" rel="noopener"> docs-3.prefect.io </a>
+        Prefect 3 is Generally Available! See the docs at <a href="https://docs.prefect.io" target="_blank" rel="noopener">
+            docs.prefect.io </a>
     </strong>
 </div>
 

diff --git a/versions/unreleased/api-ref/index.html b/versions/unreleased/api-ref/index.html
@@ -210,7 +210,8 @@
 
 <div style="text-align:center">
     <strong>
-        Prefect 3 is live! See the docs at <a href="https://docs-3.prefect.io" target="_blank" rel="noopener"> docs-3.prefect.io </a>
+        Prefect 3 is Generally Available! See the docs at <a href="https://docs.prefect.io" target="_blank" rel="noopener">
+            docs.prefect.io </a>
     </strong>
 </div>
 

diff --git a/versions/unreleased/api-ref/prefect/agent/index.html b/versions/unreleased/api-ref/prefect/agent/index.html
@@ -210,7 +210,8 @@
 
 <div style="text-align:center">
     <strong>
-        Prefect 3 is live! See the docs at <a href="https://docs-3.prefect.io" target="_blank" rel="noopener"> docs-3.prefect.io </a>
+        Prefect 3 is Generally Available! See the docs at <a href="https://docs.prefect.io" target="_blank" rel="noopener">
+            docs.prefect.io </a>
     </strong>
 </div>
 
@@ -13298,7 +13299,7 @@ <h1 id="prefect.agent" class="doc doc-heading">
 
     <div class="doc doc-contents first">
 
-      <p>DEPRECATION WARNING:</p>
+        <p>DEPRECATION WARNING:</p>
 <p>This module is deprecated as of March 2024 and will not be available after September 2024.
 Agents have been replaced by workers, which offer enhanced functionality and better performance.</p>
 <p>For upgrade instructions, see https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/.</p>
@@ -14649,7 +14650,7 @@ <h3 id="prefect.agent.PrefectAgent.cancel_run" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>Cancel a flow run by killing its infrastructure</p>
+        <p>Cancel a flow run by killing its infrastructure</p>
 
             <details class="quote">
               <summary>Source code in <code>prefect/agent.py</code></summary>
@@ -14809,7 +14810,7 @@ <h3 id="prefect.agent.PrefectAgent.get_and_submit_flow_runs" class="doc doc-head
 
     <div class="doc doc-contents ">
 
-      <p>The principle method on agents. Queries for scheduled flow runs and submits
+        <p>The principle method on agents. Queries for scheduled flow runs and submits
 them for execution in parallel.</p>
 
             <details class="quote">
@@ -14986,7 +14987,7 @@ <h3 id="prefect.agent.PrefectAgent.get_work_queues" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>Loads the work queue objects corresponding to the agent's target work
+        <p>Loads the work queue objects corresponding to the agent's target work
 queues. If any of them don't exist, they are created.</p>
 
             <details class="quote">
@@ -15133,7 +15134,7 @@ <h3 id="prefect.agent.PrefectAgent.submit_run" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>Submit a flow run to the infrastructure</p>
+        <p>Submit a flow run to the infrastructure</p>
 
             <details class="quote">
               <summary>Source code in <code>prefect/agent.py</code></summary>

diff --git a/versions/unreleased/api-ref/prefect/artifacts/index.html b/versions/unreleased/api-ref/prefect/artifacts/index.html
@@ -210,7 +210,8 @@
 
 <div style="text-align:center">
     <strong>
-        Prefect 3 is live! See the docs at <a href="https://docs-3.prefect.io" target="_blank" rel="noopener"> docs-3.prefect.io </a>
+        Prefect 3 is Generally Available! See the docs at <a href="https://docs.prefect.io" target="_blank" rel="noopener">
+            docs.prefect.io </a>
     </strong>
 </div>
 
@@ -13364,7 +13365,7 @@ <h1 id="prefect.artifacts" class="doc doc-heading">
 
     <div class="doc doc-contents first">
 
-      <p>Interface for creating and reading artifacts.</p>
+        <p>Interface for creating and reading artifacts.</p>
 
 
 
@@ -13393,7 +13394,7 @@ <h2 id="prefect.artifacts.Artifact" class="doc doc-heading">
               Bases: <code><a class="autorefs autorefs-internal" title="prefect.client.schemas.actions.ArtifactCreate" href="../client/schemas/#prefect.client.schemas.actions.ArtifactCreate">ArtifactCreate</a></code></p>
 
 
-      <p>An artifact is a piece of data that is created by a flow or task run.
+        <p>An artifact is a piece of data that is created by a flow or task run.
 https://docs.prefect.io/latest/concepts/artifacts/</p>
 
 
@@ -13699,7 +13700,7 @@ <h3 id="prefect.artifacts.Artifact.create" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>A method to create an artifact.</p>
+        <p>A method to create an artifact.</p>
 
 
 <p><span class="doc-section-title">Parameters:</span></p>
@@ -13830,7 +13831,7 @@ <h3 id="prefect.artifacts.Artifact.get" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>A method to get an artifact.</p>
+        <p>A method to get an artifact.</p>
 
 
 <p><span class="doc-section-title">Parameters:</span></p>
@@ -13973,7 +13974,7 @@ <h3 id="prefect.artifacts.Artifact.get_or_create" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>A method to get or create an artifact.</p>
+        <p>A method to get or create an artifact.</p>
 
 
 <p><span class="doc-section-title">Parameters:</span></p>
@@ -14250,7 +14251,7 @@ <h2 id="prefect.artifacts.create_link_artifact" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>Create a link artifact.</p>
+        <p>Create a link artifact.</p>
 
 
 <p><span class="doc-section-title">Parameters:</span></p>
@@ -14432,7 +14433,7 @@ <h2 id="prefect.artifacts.create_markdown_artifact" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>Create a markdown artifact.</p>
+        <p>Create a markdown artifact.</p>
 
 
 <p><span class="doc-section-title">Parameters:</span></p>
@@ -14590,7 +14591,7 @@ <h2 id="prefect.artifacts.create_table_artifact" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>Create a table artifact.</p>
+        <p>Create a table artifact.</p>
 
 
 <p><span class="doc-section-title">Parameters:</span></p>

diff --git a/versions/unreleased/api-ref/prefect/automations/index.html b/versions/unreleased/api-ref/prefect/automations/index.html
@@ -210,7 +210,8 @@
 
 <div style="text-align:center">
     <strong>
-        Prefect 3 is live! See the docs at <a href="https://docs-3.prefect.io" target="_blank" rel="noopener"> docs-3.prefect.io </a>
+        Prefect 3 is Generally Available! See the docs at <a href="https://docs.prefect.io" target="_blank" rel="noopener">
+            docs.prefect.io </a>
     </strong>
 </div>
 
@@ -14030,7 +14031,7 @@ <h3 id="prefect.automations.Automation.create" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>Create a new automation.</p>
+        <p>Create a new automation.</p>
 <p>auto_to_create = Automation(
     name="woodchonk",
     trigger=EventTrigger(
@@ -14119,7 +14120,7 @@ <h3 id="prefect.automations.Automation.delete" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>auto = Automation.read(id = 123)
+        <p>auto = Automation.read(id = 123)
 auto.delete()</p>
 
             <details class="quote">
@@ -14172,7 +14173,7 @@ <h3 id="prefect.automations.Automation.disable" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>Disable an automation.
+        <p>Disable an automation.
 auto = Automation.read(id = 123)
 auto.disable()</p>
 
@@ -14228,7 +14229,7 @@ <h3 id="prefect.automations.Automation.enable" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>Enable an automation.
+        <p>Enable an automation.
 auto = Automation.read(id = 123)
 auto.enable()</p>
 
@@ -14285,7 +14286,7 @@ <h3 id="prefect.automations.Automation.read" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>Read an automation by ID or name.
+        <p>Read an automation by ID or name.
 automation = Automation.read(name="woodchonk")</p>
 <p>or</p>
 <p>automation = Automation.read(id=UUID("b3514963-02b1-47a5-93d1-6eeb131041cb"))</p>
@@ -14374,7 +14375,7 @@ <h3 id="prefect.automations.Automation.update" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>Updates an existing automation.
+        <p>Updates an existing automation.
 auto = Automation.read(id=123)
 auto.name = "new name"
 auto.update()</p>
@@ -14434,7 +14435,7 @@ <h2 id="prefect.automations.AutomationCore" class="doc doc-heading">
               Bases: <code><span title="prefect._internal.schemas.bases.PrefectBaseModel">PrefectBaseModel</span></code></p>
 
 
-      <p>Defines an action a user wants to take when a certain number of events
+        <p>Defines an action a user wants to take when a certain number of events
 do or don't happen to the matching resources</p>
 
               <details class="quote">
@@ -14547,7 +14548,7 @@ <h2 id="prefect.automations.CompositeTrigger" class="doc doc-heading">
               Bases: <code><a class="autorefs autorefs-internal" title="prefect.events.schemas.automations.Trigger" href="#prefect.automations.Trigger">Trigger</a></code>, <code><span title="abc.ABC">ABC</span></code></p>
 
 
-      <p>Requires some number of triggers to have fired within the given time period.</p>
+        <p>Requires some number of triggers to have fired within the given time period.</p>
 
               <details class="quote">
                 <summary>Source code in <code>prefect/events/schemas/automations.py</code></summary>
@@ -14605,7 +14606,7 @@ <h2 id="prefect.automations.CompoundTrigger" class="doc doc-heading">
               Bases: <code><a class="autorefs autorefs-internal" title="prefect.events.schemas.automations.CompositeTrigger" href="#prefect.automations.CompositeTrigger">CompositeTrigger</a></code></p>
 
 
-      <p>A composite trigger that requires some number of triggers to have
+        <p>A composite trigger that requires some number of triggers to have
 fired within the given time period</p>
 
               <details class="quote">
@@ -14709,7 +14710,7 @@ <h3 id="prefect.automations.CompoundTrigger.describe_for_cli" class="doc doc-hea
 
     <div class="doc doc-contents ">
 
-      <p>Return a human-readable description of this trigger for the CLI</p>
+        <p>Return a human-readable description of this trigger for the CLI</p>
 
             <details class="quote">
               <summary>Source code in <code>prefect/events/schemas/automations.py</code></summary>
@@ -14774,7 +14775,7 @@ <h2 id="prefect.automations.EventTrigger" class="doc doc-heading">
               Bases: <code><a class="autorefs autorefs-internal" title="prefect.events.schemas.automations.ResourceTrigger" href="#prefect.automations.ResourceTrigger">ResourceTrigger</a></code></p>
 
 
-      <p>A trigger that fires based on the presence or absence of events within a given
+        <p>A trigger that fires based on the presence or absence of events within a given
 period of time.</p>
 
               <details class="quote">
@@ -15016,7 +15017,7 @@ <h3 id="prefect.automations.EventTrigger.describe_for_cli" class="doc doc-headin
 
     <div class="doc doc-contents ">
 
-      <p>Return a human-readable description of this trigger for the CLI</p>
+        <p>Return a human-readable description of this trigger for the CLI</p>
 
             <details class="quote">
               <summary>Source code in <code>prefect/events/schemas/automations.py</code></summary>
@@ -15091,7 +15092,7 @@ <h2 id="prefect.automations.MetricTrigger" class="doc doc-heading">
               Bases: <code><a class="autorefs autorefs-internal" title="prefect.events.schemas.automations.ResourceTrigger" href="#prefect.automations.ResourceTrigger">ResourceTrigger</a></code></p>
 
 
-      <p>A trigger that fires based on the results of a metric query.</p>
+        <p>A trigger that fires based on the results of a metric query.</p>
 
               <details class="quote">
                 <summary>Source code in <code>prefect/events/schemas/automations.py</code></summary>
@@ -15176,7 +15177,7 @@ <h3 id="prefect.automations.MetricTrigger.describe_for_cli" class="doc doc-headi
 
     <div class="doc doc-contents ">
 
-      <p>Return a human-readable description of this trigger for the CLI</p>
+        <p>Return a human-readable description of this trigger for the CLI</p>
 
             <details class="quote">
               <summary>Source code in <code>prefect/events/schemas/automations.py</code></summary>
@@ -15231,7 +15232,7 @@ <h2 id="prefect.automations.MetricTriggerQuery" class="doc doc-heading">
               Bases: <code><span title="prefect._internal.schemas.bases.PrefectBaseModel">PrefectBaseModel</span></code></p>
 
 
-      <p>Defines a subset of the Trigger subclass, which is specific
+        <p>Defines a subset of the Trigger subclass, which is specific
 to Metric automations, that specify the query configurations
 and breaching conditions for the Automation</p>
 
@@ -15361,7 +15362,7 @@ <h2 id="prefect.automations.ResourceSpecification" class="doc doc-heading">
               Bases: <code><span title="prefect._internal.schemas.bases.PrefectBaseModel">PrefectBaseModel</span></code></p>
 
 
-      <p>A specification that may match zero, one, or many resources, used to target or
+        <p>A specification that may match zero, one, or many resources, used to target or
 select a set of resources in a query or automation.  A resource must match at least
 one value of all of the provided labels</p>
 
@@ -15565,7 +15566,7 @@ <h2 id="prefect.automations.ResourceTrigger" class="doc doc-heading">
               Bases: <code><a class="autorefs autorefs-internal" title="prefect.events.schemas.automations.Trigger" href="#prefect.automations.Trigger">Trigger</a></code>, <code><span title="abc.ABC">ABC</span></code></p>
 
 
-      <p>Base class for triggers that may filter by the labels of resources.</p>
+        <p>Base class for triggers that may filter by the labels of resources.</p>
 
               <details class="quote">
                 <summary>Source code in <code>prefect/events/schemas/automations.py</code></summary>
@@ -15637,7 +15638,7 @@ <h2 id="prefect.automations.SequenceTrigger" class="doc doc-heading">
               Bases: <code><a class="autorefs autorefs-internal" title="prefect.events.schemas.automations.CompositeTrigger" href="#prefect.automations.CompositeTrigger">CompositeTrigger</a></code></p>
 
 
-      <p>A composite trigger that requires some number of triggers to have fired
+        <p>A composite trigger that requires some number of triggers to have fired
 within the given time period in a specific order</p>
 
               <details class="quote">
@@ -15711,7 +15712,7 @@ <h3 id="prefect.automations.SequenceTrigger.describe_for_cli" class="doc doc-hea
 
     <div class="doc doc-contents ">
 
-      <p>Return a human-readable description of this trigger for the CLI</p>
+        <p>Return a human-readable description of this trigger for the CLI</p>
 
             <details class="quote">
               <summary>Source code in <code>prefect/events/schemas/automations.py</code></summary>
@@ -15776,7 +15777,7 @@ <h2 id="prefect.automations.Trigger" class="doc doc-heading">
               Bases: <code><span title="prefect._internal.schemas.bases.PrefectBaseModel">PrefectBaseModel</span></code>, <code><span title="abc.ABC">ABC</span></code></p>
 
 
-      <p>Base class describing a set of criteria that must be satisfied in order to trigger
+        <p>Base class describing a set of criteria that must be satisfied in order to trigger
 an automation.</p>
 
               <details class="quote">
@@ -15920,7 +15921,7 @@ <h3 id="prefect.automations.Trigger.describe_for_cli" class="doc doc-heading">
 
     <div class="doc doc-contents ">
 
-      <p>Return a human-readable description of this trigger for the CLI</p>
+        <p>Return a human-readable description of this trigger for the CLI</p>
 
             <details class="quote">
               <summary>Source code in <code>prefect/events/schemas/automations.py</code></summary>