first iteration: docs restructure #1103

samhita-alla · 2023-08-30T07:10:41Z

This PR rearranges the docs examples and updates those found in the basics section, as well as the decks and decorating tasks examples.

Signed-off-by: Samhita Alla <[email protected]>

This reverts commit ac154eb.

Signed-off-by: Samhita Alla <[email protected]>

* Sandbox notifications example (#1072) * Fix merge_sort.py code bug If the count variable is set to 25, then the code will only sort the first 24 numbers. Signed-off-by: Hacker-Davinci <[email protected]> * Fix merge_sort.py code bug If the count variable is set to 25, then the code will only sort the first 24 numbers. Signed-off-by: Hacker-Davinci <[email protected]> * fix the variable naming error Signed-off-by: Future Outlier <[email protected]> * Delete merge_sort.py Signed-off-by: Future-Outlier <[email protected]> * Create merge_sort.py Signed-off-by: Future-Outlier <[email protected]> * sandbox notifications example Signed-off-by: Future Outlier <[email protected]> --------- Signed-off-by: Hacker-Davinci <[email protected]> Signed-off-by: Future Outlier <[email protected]> Signed-off-by: Future-Outlier <[email protected]> Co-authored-by: Future Outlier <[email protected]> Signed-off-by: Samhita Alla <[email protected]> * Fix linting error (#1074) Signed-off-by: Kevin Su <[email protected]> Signed-off-by: Samhita Alla <[email protected]> * Update agent doc (#1073) Signed-off-by: Hongxin Liang <[email protected]> Signed-off-by: Samhita Alla <[email protected]> * Bump gitpython from 3.1.31 to 3.1.32 in /examples/snowflake_plugin (#1078) Bumps [gitpython](https://github.com/gitpython-developers/GitPython) from 3.1.31 to 3.1.32. - [Release notes](https://github.com/gitpython-developers/GitPython/releases) - [Changelog](https://github.com/gitpython-developers/GitPython/blob/main/CHANGES) - [Commits](gitpython-developers/GitPython@3.1.31...3.1.32) --- updated-dependencies: - dependency-name: gitpython dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Samhita Alla <[email protected]> * add type datetime.date (#1084) Signed-off-by: troychiu <[email protected]> Co-authored-by: Samhita Alla <[email protected]> Signed-off-by: Samhita Alla <[email protected]> * revise documentation for plugins requiring flyte backend setup (#1062) * revise documentation for plugins requiring flyte backend setup Signed-off-by: Samhita Alla <[email protected]> * nit Signed-off-by: Samhita Alla <[email protected]> * update docs Signed-off-by: Samhita Alla <[email protected]> * update requirements Signed-off-by: Samhita Alla <[email protected]> * downgrade pydantic Signed-off-by: Samhita Alla <[email protected]> * revert requirements update Signed-off-by: Samhita Alla <[email protected]> * revert requirements update Signed-off-by: Samhita Alla <[email protected]> * generate requirements in databricks Signed-off-by: Samhita Alla <[email protected]> * add envd Signed-off-by: Samhita Alla <[email protected]> * ray isort Signed-off-by: Samhita Alla <[email protected]> * sort imports Signed-off-by: Samhita Alla <[email protected]> * lint Signed-off-by: Samhita Alla <[email protected]> * add envd to plugin requirements Signed-off-by: Samhita Alla <[email protected]> * lint Signed-off-by: Samhita Alla <[email protected]> * add requirements.txt file Signed-off-by: Samhita Alla <[email protected]> * fix requirements Signed-off-by: Samhita Alla <[email protected]> * modify imagespec registry Signed-off-by: Samhita Alla <[email protected]> * lint Signed-off-by: Samhita Alla <[email protected]> * tf dependencies Signed-off-by: Samhita Alla <[email protected]> * modify deps and add registry Signed-off-by: Samhita Alla <[email protected]> * modify registry Signed-off-by: Samhita Alla <[email protected]> * mpi protobuf Signed-off-by: Samhita Alla <[email protected]> * add placeholder Signed-off-by: Samhita Alla <[email protected]> * incorporate suggestions Signed-off-by: Samhita Alla <[email protected]> --------- Signed-off-by: Samhita Alla <[email protected]> * rearrange folders Signed-off-by: Samhita Alla <[email protected]> * downgrade pyyaml version Signed-off-by: Samhita Alla <[email protected]> * lint Signed-off-by: Samhita Alla <[email protected]> * update deps Signed-off-by: Samhita Alla <[email protected]> * new line Signed-off-by: Samhita Alla <[email protected]> * update dockerfiles Signed-off-by: Samhita Alla <[email protected]> * update requirements Signed-off-by: Samhita Alla <[email protected]> * update requirements Signed-off-by: Samhita Alla <[email protected]> * lint Signed-off-by: Samhita Alla <[email protected]> * remove python 3.8-10 Signed-off-by: Samhita Alla <[email protected]> * update requirements Signed-off-by: Samhita Alla <[email protected]> * validate Signed-off-by: Samhita Alla <[email protected]> * add envd Signed-off-by: Samhita Alla <[email protected]> * debug Signed-off-by: Samhita Alla <[email protected]> * debug Signed-off-by: Samhita Alla <[email protected]> * final Signed-off-by: Samhita Alla <[email protected]> --------- Signed-off-by: Hacker-Davinci <[email protected]> Signed-off-by: Future Outlier <[email protected]> Signed-off-by: Future-Outlier <[email protected]> Signed-off-by: Samhita Alla <[email protected]> Signed-off-by: Kevin Su <[email protected]> Signed-off-by: Hongxin Liang <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: troychiu <[email protected]> Co-authored-by: Future-Outlier <[email protected]> Co-authored-by: Future Outlier <[email protected]> Co-authored-by: Kevin Su <[email protected]> Co-authored-by: Honnix <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Yi Chiu <[email protected]>

* update basics Signed-off-by: Samhita Alla <[email protected]> * nit Signed-off-by: Samhita Alla <[email protected]> * lint Signed-off-by: Samhita Alla <[email protected]> * update dockerfile and code Signed-off-by: Samhita Alla <[email protected]> * lint Signed-off-by: Samhita Alla <[email protected]> * add envd Signed-off-by: Samhita Alla <[email protected]> * registry Signed-off-by: Samhita Alla <[email protected]> * fix resource allocation example Signed-off-by: Samhita Alla <[email protected]> * modify the name of the launch plan Signed-off-by: Samhita Alla <[email protected]> * gh action Signed-off-by: Samhita Alla <[email protected]> * modify lp name Signed-off-by: Samhita Alla <[email protected]> * fix reference lp name Signed-off-by: Samhita Alla <[email protected]> --------- Signed-off-by: Samhita Alla <[email protected]>

Signed-off-by: Samhita Alla <[email protected]>

.github/workflows/checks.yml

docs/contribute.md

docs/getting_started/run_schedule.md

docs/getting_started/tasks_and_workflows.md

docs/index.md

docs/integrations.md

cosmicBboy · 2023-08-31T20:28:50Z

docs/integrations.md

@@ -146,7 +143,7 @@ Because Flyte uses executable docker containers as the smallest unit of compute,
 :header-rows: 0
 :widths: 20 30

-* - {doc}`Raw Container Tasks <auto_examples/containerization/raw_container>`
+* - {doc}`Raw Container Tasks <auto_examples/04_customizing_dependencies/raw_container>`


why are we numbering these?

note that 04_customizing_dependencies is not a valid (importable) python module name. Let's go for it if we don't care about that. We also risk locking ourselves into a particular order... what if we decide to re-order these sections? We'll then have to rename all of the directories and example modules to reflect the new ordering.

If we really want the numbering for readability purposes when a developer clones the flytesnacks repo, we can create a table of contents in the readme to enforce a particular ordering.

Ketan really wants to tidy things up. He wants to make it super easy to contribute to the docs. While we don't have to be strict about it, Ketan believes reorganizing folders in the examples directory will simplify contributing to the docs.

What do you suggest we do?

I guess I'm skeptical that numbering the examples folders will actually make it easier to contribute.

We can solve this by working on a way to link an example page to the github python file (I can help add this functionality, this was supported with the old sphinx gallery setup).

I just want to future proof these names so that we don't have to update a bunch of places if/when we decide to restructure the docs again. For example, adding a new section in the middle will require bumping the numbers of all the subsequent sections. Same with deleting/merging a section. @kumare3

Alright then, I'll remove the numbers. After we merge this PR, could you please add the functionality you mentioned?

@cosmicBboy, can you approve this PR?

examples/05_local_development/README.md

Signed-off-by: Samhita Alla <[email protected]>

examples/productionizing/productionizing/reference_launch_plan.py

examples/productionizing/productionizing/reference_task.py

Signed-off-by: Samhita Alla <[email protected]>

samhita-alla and others added 6 commits July 31, 2023 17:40

restructure docs

ac154eb

Signed-off-by: Samhita Alla <[email protected]>

Revert "restructure docs"

d24e80b

This reverts commit ac154eb.

restructure docs

c943733

Signed-off-by: Samhita Alla <[email protected]>

merge master

e2e8eea

Signed-off-by: Samhita Alla <[email protected]>

samhita-alla requested review from kumare3 and wild-endeavor as code owners August 30, 2023 07:10

samhita-alla added 3 commits August 31, 2023 11:31

rename folders

30dd8ce

Signed-off-by: Samhita Alla <[email protected]>

downgrade flytekit version

5f8be64

Signed-off-by: Samhita Alla <[email protected]>

fix reference task and lp

78fec5d

Signed-off-by: Samhita Alla <[email protected]>

cosmicBboy reviewed Aug 31, 2023

View reviewed changes

samhita-alla added 5 commits September 1, 2023 15:43

incorporate suggestions

4c2aef9

Signed-off-by: Samhita Alla <[email protected]>

Merge remote-tracking branch 'origin/master' into docs-restructure

104b56b

Merge remote-tracking branch 'origin/master' into docs-restructure

59bd74f

remove numbers

a412e9e

Signed-off-by: Samhita Alla <[email protected]>

nit

14f26fb

Signed-off-by: Samhita Alla <[email protected]>

cosmicBboy reviewed Sep 4, 2023

View reviewed changes

examples/productionizing/productionizing/reference_launch_plan.py Outdated Show resolved Hide resolved

examples/productionizing/productionizing/reference_task.py Outdated Show resolved Hide resolved

fix folder name

4d740d8

Signed-off-by: Samhita Alla <[email protected]>

cosmicBboy approved these changes Sep 5, 2023

View reviewed changes

samhita-alla merged commit 1565219 into master Sep 5, 2023

samhita-alla deleted the docs-restructure branch September 5, 2023 16:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

first iteration: docs restructure #1103

first iteration: docs restructure #1103

samhita-alla commented Aug 30, 2023 •

edited

Loading

cosmicBboy Aug 31, 2023 •

edited

Loading

samhita-alla Sep 1, 2023

cosmicBboy Sep 1, 2023 •

edited

Loading

samhita-alla Sep 3, 2023 •

edited

Loading

samhita-alla Sep 4, 2023

first iteration: docs restructure #1103

first iteration: docs restructure #1103

Conversation

samhita-alla commented Aug 30, 2023 • edited Loading

cosmicBboy Aug 31, 2023 • edited Loading

Choose a reason for hiding this comment

samhita-alla Sep 1, 2023

Choose a reason for hiding this comment

cosmicBboy Sep 1, 2023 • edited Loading

Choose a reason for hiding this comment

samhita-alla Sep 3, 2023 • edited Loading

Choose a reason for hiding this comment

samhita-alla Sep 4, 2023

Choose a reason for hiding this comment

samhita-alla commented Aug 30, 2023 •

edited

Loading

cosmicBboy Aug 31, 2023 •

edited

Loading

cosmicBboy Sep 1, 2023 •

edited

Loading

samhita-alla Sep 3, 2023 •

edited

Loading