Updates for Flyte docs overhaul (#1726)

* moved to flyte repo Signed-off-by: nikki everett <[email protected]> * update refs Signed-off-by: nikki everett <[email protected]> * update refs in examples Signed-off-by: nikki everett <[email protected]> * configure pydata theme Signed-off-by: nikki everett <[email protected]> * restructure integrations docs Signed-off-by: nikki everett <[email protected]> * restructure tutorials Signed-off-by: nikki everett <[email protected]> * fix contributing guide link Signed-off-by: nikki everett <[email protected]> * remove double h1 Signed-off-by: nikki everett <[email protected]> * remove unneceesary captions Signed-off-by: nikki everett <[email protected]> * move deprecated integrations back to flytesnacks and remove unnecessary captions from tutorials and integrations toctrees Signed-off-by: nikki everett <[email protected]> * fix regression Signed-off-by: nikki everett <[email protected]> * linting Signed-off-by: nikki everett <[email protected]> * update docs-requirements.txt from new docs-requirements.in Signed-off-by: nikki everett <[email protected]> * update README Signed-off-by: nikki everett <[email protected]> * Regenerate all requirements files using python 3.9 Signed-off-by: Eduardo Apolinario <[email protected]> * Regenerate readthedocs requirements files using python 3.12 Signed-off-by: Eduardo Apolinario <[email protected]> * fix formatting for deprecated plugins Signed-off-by: nikki everett <[email protected]> * Add pandas to requirements.in in a bunch of places Signed-off-by: Eduardo Apolinario <[email protected]> * Install pandas in e2e-tests Signed-off-by: Eduardo Apolinario <[email protected]> * use ref for docs contributing guide Signed-off-by: nikki everett <[email protected]> --------- Signed-off-by: nikki everett <[email protected]> Signed-off-by: Eduardo Apolinario <[email protected]> Co-authored-by: Eduardo Apolinario <[email protected]>
flyteorg · Oct 4, 2024 · caadd26 · caadd26
1 parent a1dde19
commit caadd26
Show file tree

Hide file tree

Showing 40 changed files with 550 additions and 1,103 deletions.
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -293,7 +293,7 @@ jobs:
           pip install uv
           uv venv
           source .venv/bin/activate
-          uv pip install "flytekit>=1.12.2" flytekitplugins-deck-standard torch tabulate pyarrow
+          uv pip install "flytekit>=1.12.2" flytekitplugins-deck-standard torch tabulate pyarrow pandas
           pip freeze
       - name: Checkout flytesnacks
         uses: actions/checkout@v3

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -7,7 +7,7 @@ version: 2
 build:
   os: "ubuntu-22.04"
   tools:
-    python: "3.11"
+    python: "3.12"
   apt_packages:
     - pandoc
 

diff --git a/README.md b/README.md
@@ -3,10 +3,10 @@
         <img src="https://raw.githubusercontent.com/flyteorg/static-resources/main/common/flyte_circle_gradient_1_4x4.png" alt="Flyte Logo" width="100">
     </p>
     <h1 align="center">
-        Flyte User Guide & Tutorials
+        Flyte tutorials and integrations examples
     </h1>
     <p align="center">
-        Flytesnacks encompasses code examples showcasing Flytekit Python
+        Flytesnacks encompasses tutorials and integrations examples showcasing Flytekit Python
     </p>
     <p align="center">
         <a href="https://slack.flyte.org">
@@ -30,11 +30,9 @@
 
 > To get the hang of Python SDK, refer to the [Getting Started](https://docs.flyte.org/en/latest/getting_started.html) tutorial before exploring the examples.
 
-The [User Guide](https://docs.flyte.org/projects/cookbook/en/latest/index.html) section has code examples, tips, and tricks that showcase the usage of Flyte features and integrations.
+The [Tutorials](https://docs.flyte.org/en/latest/flytesnacks/tutorials/index.html) section has real-world examples, ranging from machine learning training, data processing to feature engineering.
 
-The [Tutorials](https://docs.flyte.org/projects/cookbook/en/latest/tutorials.html) section has real-world examples, ranging from machine learning training, data processing to feature engineering.
-
-the [Integrations](https://docs.flyte.org/projects/cookbook/en/latest/integrations.html) section demonstrates how to use Flyte with other tools and frameworks.
+the [Integrations](https://docs.flyte.org/en/latest/flytesnacks/integrations/index.html) section demonstrates how to use Flyte with other tools and frameworks.
 
 > Flytesnacks currently has all examples in Python (Flytekit Python SDK).
 
@@ -44,12 +42,12 @@ the [Integrations](https://docs.flyte.org/projects/cookbook/en/latest/integratio
     </h2>
 </html>
 
-You can find the detailed contribution guide [here](docs/contribute.md).
+You can find the detailed contribution guide [here](https://docs.flyte.org/en/latest/community/contribute_docs.html#contributing-tutorials-and-integrations-examples).
 
 <html>
     <h2 id="file-an-issue">
         🐞 File an Issue
     </h2>
 </html>
 
-Refer to the [issues](https://docs.flyte.org/en/latest/community/contribute.html##file-an-issue) section in the contribution guide if you'd like to file an issue.
+Refer to the [issues](https://docs.flyte.org/en/latest/community/contribute.html#file-an-issue) section in the contribution guide if you'd like to file an issue.