Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates for Flyte docs overhaul #1726

Merged
merged 23 commits into from
Oct 4, 2024
Merged

Updates for Flyte docs overhaul #1726

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
009cc51
moved to flyte repo
Sep 3, 2024
0509ad5
update refs
Sep 5, 2024
6dcc113
update refs in examples
Sep 5, 2024
5cff22a
configure pydata theme
Sep 10, 2024
7f71b7c
restructure integrations docs
Sep 10, 2024
41ea88f
restructure tutorials
Sep 10, 2024
694eae5
fix contributing guide link
Sep 10, 2024
5edc04a
remove double h1
Sep 11, 2024
4639e14
remove unneceesary captions
Sep 11, 2024
fd8a26f
move deprecated integrations back to flytesnacks and remove unnecessa…
Sep 26, 2024
225f7be
Merge branch 'nikki/docs/refresh' of github.com:flyteorg/flytesnacks …
Sep 26, 2024
3bef359
merge master and fix merge conflict
Sep 26, 2024
f550c0e
fix regression
Sep 27, 2024
6cb9d63
Merge branch 'master' into nikki/docs/refresh
Sep 30, 2024
8f52cce
linting
Sep 30, 2024
3111231
update docs-requirements.txt from new docs-requirements.in
Sep 30, 2024
1d86a35
update README
Sep 30, 2024
3e61d92
Regenerate all requirements files using python 3.9
eapolinario Oct 2, 2024
7dff2de
Regenerate readthedocs requirements files using python 3.12
eapolinario Oct 2, 2024
fcc54d9
fix formatting for deprecated plugins
Oct 2, 2024
d58c064
Add pandas to requirements.in in a bunch of places
eapolinario Oct 2, 2024
e12d11b
Install pandas in e2e-tests
eapolinario Oct 2, 2024
e939a09
use ref for docs contributing guide
Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/checks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ version: 2
build:
os: "ubuntu-22.04"
tools:
python: "3.11"
python: "3.12"
apt_packages:
- pandoc

Expand Down
14 changes: 6 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand All @@ -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).

Expand All @@ -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.
Loading
Loading