Skip to content

Commit

Permalink
Update unreleased documentation (#721)
Browse files Browse the repository at this point in the history 
* Update versions.json

* Deployed 6474f10 to unreleased in versions with MkDocs 1.5.3 and mike 2.0.0

* Sort docs versions

---------

Co-authored-by: GitHub Actions Bot <github-actions-bot@example.com>
  • Loading branch information
@github-actions
github-actions[bot] and GitHub Actions Bot authored Apr 18, 2024
1 parent fde812c commit ab4135f
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 144 deletions.
193 changes: 50 additions & 143 deletions versions/unreleased/getting-started/installation/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -563,11 +563,11 @@
</li>

<li class="md-nav__item">
<a href="#installing-the-bleeding-edge" class="md-nav__link">
<a href="#checking-your-installation" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Installing the bleeding edge
Checking your installation
</span>

</span>
Expand All @@ -576,11 +576,11 @@
</li>

<li class="md-nav__item">
<a href="#installing-for-development" class="md-nav__link">
<a href="#windows-installation" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Installing for development
Windows installation
</span>

</span>
Expand All @@ -589,11 +589,11 @@
</li>

<li class="md-nav__item">
<a href="#checking-your-installation" class="md-nav__link">
<a href="#linux-installation" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Checking your installation
Linux installation
</span>

</span>
Expand All @@ -604,32 +604,6 @@
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#windows-installation-notes" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Windows installation notes
</span>

</span>
</a>

</li>

<li class="md-nav__item">
<a href="#linux-installation-notes" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Linux installation notes
</span>

</span>
</a>

</li>

<li class="md-nav__item">
Expand All @@ -646,11 +620,11 @@
</li>

<li class="md-nav__item">
<a href="#proxies" class="md-nav__link">
<a href="#installing-for-development" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Proxies
Installing for development
</span>

</span>
Expand All @@ -659,20 +633,6 @@
</li>

<li class="md-nav__item">
<a href="#external-requirements" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
External requirements
</span>

</span>
</a>

<nav class="md-nav" aria-label="External requirements">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#sqlite" class="md-nav__link">
<span class="md-ellipsis">

Expand All @@ -683,7 +643,8 @@
</span>
</a>

</li>
<nav class="md-nav" aria-label="SQLite">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#install-sqlite-on-rhel" class="md-nav__link">
Expand All @@ -704,11 +665,11 @@
</li>

<li class="md-nav__item">
<a href="#using-prefect-in-an-environment-with-http-proxies" class="md-nav__link">
<a href="#http-proxies" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Using Prefect in an environment with HTTP proxies
HTTP Proxies
</span>

</span>
Expand Down Expand Up @@ -8989,11 +8950,11 @@
</li>

<li class="md-nav__item">
<a href="#installing-the-bleeding-edge" class="md-nav__link">
<a href="#checking-your-installation" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Installing the bleeding edge
Checking your installation
</span>

</span>
Expand All @@ -9002,11 +8963,11 @@
</li>

<li class="md-nav__item">
<a href="#installing-for-development" class="md-nav__link">
<a href="#windows-installation" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Installing for development
Windows installation
</span>

</span>
Expand All @@ -9015,11 +8976,11 @@
</li>

<li class="md-nav__item">
<a href="#checking-your-installation" class="md-nav__link">
<a href="#linux-installation" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Checking your installation
Linux installation
</span>

</span>
Expand All @@ -9030,32 +8991,6 @@
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#windows-installation-notes" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Windows installation notes
</span>

</span>
</a>

</li>

<li class="md-nav__item">
<a href="#linux-installation-notes" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Linux installation notes
</span>

</span>
</a>

</li>

<li class="md-nav__item">
Expand All @@ -9072,11 +9007,11 @@
</li>

<li class="md-nav__item">
<a href="#proxies" class="md-nav__link">
<a href="#installing-for-development" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Proxies
Installing for development
</span>

</span>
Expand All @@ -9085,20 +9020,6 @@
</li>

<li class="md-nav__item">
<a href="#external-requirements" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
External requirements
</span>

</span>
</a>

<nav class="md-nav" aria-label="External requirements">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#sqlite" class="md-nav__link">
<span class="md-ellipsis">

Expand All @@ -9109,7 +9030,8 @@
</span>
</a>

</li>
<nav class="md-nav" aria-label="SQLite">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#install-sqlite-on-rhel" class="md-nav__link">
Expand All @@ -9130,11 +9052,11 @@
</li>

<li class="md-nav__item">
<a href="#using-prefect-in-an-environment-with-http-proxies" class="md-nav__link">
<a href="#http-proxies" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Using Prefect in an environment with HTTP proxies
HTTP Proxies
</span>

</span>
Expand Down Expand Up @@ -9209,40 +9131,13 @@ <h3 id="installing-the-latest-version">Installing the latest version<a class="he
</code></pre></div>
</div>

<p>To install a specific version, specify the version number like this:</p>
<p>To install a specific version, specify the version number, like this:</p>
<div class="terminal">
<div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>-U<span class="w"> </span><span class="s2">&quot;prefect==2.16.2&quot;</span>
</code></pre></div>
</div>

<p>See available release versions in the <a href="https://github.com/PrefectHQ/prefect/blob/main/RELEASE-NOTES.md">Prefect Release Notes</a>.</p>
<h3 id="installing-the-bleeding-edge">Installing the bleeding edge<a class="headerlink" href="#installing-the-bleeding-edge" title="Permanent link">&para;</a></h3>
<p>If you'd like to test with the most up-to-date code, you can install directly off the <code>main</code> branch on GitHub:</p>
<div class="terminal">
<div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>-U<span class="w"> </span>git+https://github.com/PrefectHQ/prefect
</code></pre></div>
</div>

<div class="admonition warning">
<p class="admonition-title">The <code>main</code> branch may not be stable</p>
<p>Please be aware that this method installs unreleased code and may not be stable.</p>
</div>
<h3 id="installing-for-development">Installing for development<a class="headerlink" href="#installing-for-development" title="Permanent link">&para;</a></h3>
<p>If you'd like to install a version of Prefect for development:</p>
<ol>
<li>Clone the <a href="https://github.com/PrefectHQ/prefect">Prefect repository</a>.</li>
<li>Install an editable version of the Python package with <code>pip install -e</code>.</li>
<li>Install pre-commit hooks.</li>
</ol>
<div class="terminal">
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/PrefectHQ/prefect.git
$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>prefect
$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span><span class="s2">&quot;.[dev]&quot;</span>
$<span class="w"> </span>pre-commit<span class="w"> </span>install
</code></pre></div>
</div>

<p>See our <a href="/contributing/overview/">Contributing</a> guide for more details about standards and practices for contributing to Prefect.</p>
<p>See available release versions in the <a href="https://github.com/PrefectHQ/prefect/blob/main/RELEASE-NOTES.md">Release Notes</a>.</p>
<h3 id="checking-your-installation">Checking your installation<a class="headerlink" href="#checking-your-installation" title="Permanent link">&para;</a></h3>
<p>To confirm that Prefect was installed correctly, run the command <code>prefect version</code> to print the version and environment details to your console.</p>
<div class="terminal">
Expand All @@ -9262,14 +9157,14 @@ <h3 id="checking-your-installation">Checking your installation<a class="headerli
</code></pre></div>
</div>

<h2 id="windows-installation-notes">Windows installation notes<a class="headerlink" href="#windows-installation-notes" title="Permanent link">&para;</a></h2>
<h3 id="windows-installation">Windows installation<a class="headerlink" href="#windows-installation" title="Permanent link">&para;</a></h3>
<p>You can install and run Prefect via Windows PowerShell, the Windows Command Prompt, or <a href="https://docs.conda.io/projects/conda/en/latest/user-guide/install/windows.html"><code>conda</code></a>. After installation, you may need to manually add the Python local packages <code>Scripts</code> folder to your <code>Path</code> environment variable.</p>
<p>The <code>Scripts</code> folder path looks something like this (the username and Python version may be different on your system):</p>
<div class="highlight"><pre><span></span><code>C:<span class="se">\U</span>sers<span class="se">\M</span>yUserNameHere<span class="se">\A</span>ppData<span class="se">\L</span>ocal<span class="se">\P</span>ackages<span class="se">\P</span>ythonSoftwareFoundation.Python.3.11_qbz5n2kfra8p0<span class="se">\L</span>ocalCache<span class="se">\l</span>ocal-packages<span class="se">\P</span>ython311<span class="se">\S</span>cripts
</code></pre></div>
<p>Watch the <code>pip install</code> output messages for the <code>Scripts</code> folder path on your system.</p>
<p>If you're using Windows Subsystem for Linux (WSL), see <a href="#linux-installation-notes">Linux installation notes</a>.</p>
<h2 id="linux-installation-notes">Linux installation notes<a class="headerlink" href="#linux-installation-notes" title="Permanent link">&para;</a></h2>
<h3 id="linux-installation">Linux installation<a class="headerlink" href="#linux-installation" title="Permanent link">&para;</a></h3>
<p>Linux is a popular operating system for running Prefect. You can use <a href="/ui/cloud/">Prefect Cloud</a> as your API server, or <a href="/host/">host your own Prefect server</a> backed by <a href="/concepts/database/#configuring_a_postgresql_database">PostgreSQL</a>.</p>
<p>For development, you can use <a href="/concepts/database/#configuring_a_sqlite_database">SQLite</a> 2.24 or newer as your database. Note that certain Linux versions of SQLite can be problematic. Compatible versions include Ubuntu 22.04 LTS and Ubuntu 20.04 LTS.</p>
<p>Alternatively, you can <a href="#install-sqlite-on-rhel">install SQLite on Red Hat Custom Linux (RHEL)</a> or use the <code>conda</code> virtual environment manager and configure a compatible SQLite version.</p>
Expand All @@ -9280,13 +9175,25 @@ <h2 id="using-a-self-signed-ssl-certificate">Using a self-signed SSL certificate
<p>If the certificate is not part of your system bundle, you can set the
<code>PREFECT_API_TLS_INSECURE_SKIP_VERIFY</code> to <code>True</code> to disable certificate verification altogether.</p>
<p><strong><em>Note:</em></strong> Disabling certificate validation is insecure and only suggested as an option for testing!</p>
<h2 id="proxies">Proxies<a class="headerlink" href="#proxies" title="Permanent link">&para;</a></h2>
<p>Prefect supports communicating via proxies through environment variables. Simply set <code>HTTPS_PROXY</code> and <code>SSL_CERT_FILE</code> in your environment, and the underlying network libraries will route Prefect’s requests appropriately. Read more about using Prefect Cloud with proxies <a href="https://discourse.prefect.io/t/using-prefect-cloud-with-proxies/1696">here</a>.</p>
<h2 id="external-requirements">External requirements<a class="headerlink" href="#external-requirements" title="Permanent link">&para;</a></h2>
<h3 id="sqlite">SQLite<a class="headerlink" href="#sqlite" title="Permanent link">&para;</a></h3>
<p>You can use <a href="/ui/cloud/">Prefect Cloud</a> as your API server, or <a href="/host/">host your own Prefect server</a> backed by <a href="/concepts/database/#configuring_a_postgresql_database">PostgreSQL</a>.</p>
<p>By default, a local Prefect server instance uses SQLite as the backing database. SQLite is not packaged with the Prefect installation. Most systems will already have SQLite installed, because it is typically bundled as a part of Python.</p>
<p>The Prefect CLI command <code>prefect version</code> prints environment details to your console, including the server database. For example:</p>
<h2 id="installing-for-development">Installing for development<a class="headerlink" href="#installing-for-development" title="Permanent link">&para;</a></h2>
<p>If you'd like to install a version of Prefect for development:</p>
<ol>
<li>Clone the <a href="https://github.com/PrefectHQ/prefect">Prefect repository</a>.</li>
<li>Install an editable version of the Python package with <code>pip install -e</code>.</li>
<li>Install pre-commit hooks.</li>
</ol>
<div class="terminal">
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/PrefectHQ/prefect.git
$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>prefect
$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span><span class="s2">&quot;.[dev]&quot;</span>
$<span class="w"> </span>pre-commit<span class="w"> </span>install
</code></pre></div>
</div>

<p>See the <a href="/contributing/overview/">Contributing</a> guide for more details about standards and practices for contributing to Prefect.</p>
<h2 id="sqlite">SQLite<a class="headerlink" href="#sqlite" title="Permanent link">&para;</a></h2>
<p>You can use <a href="/ui/cloud/">Prefect Cloud</a> as your API server, or <a href="/host/">host your own Prefect server</a>. By default, a local Prefect server instance uses SQLite as the backing database. SQLite is not packaged with the Prefect installation, but most Python environments will already have SQLite installed.</p>
<p>The Prefect CLI command <code>prefect version</code> prints environment details to your console, including the server type. For example:</p>
<div class="terminal">
<div class="highlight"><pre><span></span><code>$ prefect version
Version: 2.10.21
Expand Down Expand Up @@ -9336,15 +9243,15 @@ <h3 id="install-sqlite-on-rhel">Install SQLite on RHEL<a class="headerlink" href
</code></pre></div>
</div>

<h2 id="using-prefect-in-an-environment-with-http-proxies">Using Prefect in an environment with HTTP proxies<a class="headerlink" href="#using-prefect-in-an-environment-with-http-proxies" title="Permanent link">&para;</a></h2>
<h2 id="http-proxies">HTTP Proxies<a class="headerlink" href="#http-proxies" title="Permanent link">&para;</a></h2>
<p>If you are using Prefect Cloud or hosting your own Prefect server instance, the Prefect library
will connect to the API via any proxies you have listed in the <code>HTTP_PROXY</code>,
<code>HTTPS_PROXY</code>, or <code>ALL_PROXY</code> environment variables. You may also use the <code>NO_PROXY</code>
environment variable to specify which hosts should not be sent through the proxy.</p>
<p>For more information about these environment variables, see the <a href="https://everything.curl.dev/usingcurl/proxies/env">cURL
documentation</a>.</p>
documentation</a>. Read more about using Prefect Cloud with proxies <a href="https://discourse.prefect.io/t/using-prefect-cloud-with-proxies/1696">here</a>.</p>
<h2 id="next-steps">Next steps<a class="headerlink" href="#next-steps" title="Permanent link">&para;</a></h2>
<p>Now that you have Prefect installed and your environment configured, you may want to check out the <a href="/tutorial/">Tutorial</a> to get more familiar with Prefect.</p>
<p>Now that you have Prefect installed and your environment configured, check out the <a href="/tutorial/">Tutorial</a> to get more familiar with Prefect.</p>



Expand Down
2 changes: 1 addition & 1 deletion versions/unreleased/search/search_index.json
View file

Large diffs are not rendered by default.

Binary file modified versions/unreleased/sitemap.xml.gz
View file
Binary file not shown.

0 comments on commit ab4135f

Please sign in to comment.