first iteration: docs restructure (#1103)

* restructure docs Signed-off-by: Samhita Alla <[email protected]> * Revert "restructure docs" This reverts commit ac154eb. * restructure docs Signed-off-by: Samhita Alla <[email protected]> * reorganize folders (#1094) * 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 examples in the basics section of the docs (#1096) * 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]> * rename folders Signed-off-by: Samhita Alla <[email protected]> * downgrade flytekit version Signed-off-by: Samhita Alla <[email protected]> * fix reference task and lp Signed-off-by: Samhita Alla <[email protected]> * incorporate suggestions Signed-off-by: Samhita Alla <[email protected]> * remove numbers Signed-off-by: Samhita Alla <[email protected]> * nit Signed-off-by: Samhita Alla <[email protected]> * fix folder name Signed-off-by: Samhita Alla <[email protected]> --------- 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: 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]>
flyteorg · Sep 5, 2023 · 1565219 · 1565219
1 parent facef9b
commit 1565219
Show file tree

Hide file tree

Showing 142 changed files with 2,508 additions and 2,796 deletions.
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -5,38 +5,37 @@ on:
     branches:
       - master
     paths-ignore:
-      - 'docs/**'
+      - "docs/**"
   pull_request:
     paths-ignore:
-      - 'docs/**'
+      - "docs/**"
 jobs:
-
   lint:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.11"]
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Cache pip
-      uses: actions/cache@v2
-      with:
-        # This path is specific to Ubuntu
-        path: ~/.cache/pip
-        # Look to see if there is a cache hit for the corresponding requirements files
-        key: ${{ format('{0}-pip-{1}', runner.os, hashFiles('dev-requirements.txt')) }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r dev-requirements.txt
-    - name: Pip info
-      run: python -m pip list
-    - name: Lint
-      run: pre-commit run --all --show-diff-on-failure
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Cache pip
+        uses: actions/cache@v2
+        with:
+          # This path is specific to Ubuntu
+          path: ~/.cache/pip
+          # Look to see if there is a cache hit for the corresponding requirements files
+          key: ${{ format('{0}-pip-{1}', runner.os, hashFiles('dev-requirements.txt')) }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r dev-requirements.txt
+      - name: Pip info
+        run: python -m pip list
+      - name: Lint
+        run: pre-commit run --all --show-diff-on-failure
 
   # This is the build system for the new example directory structure
   list_examples:
@@ -70,7 +69,7 @@ jobs:
       - uses: actions/checkout@v2
         with:
           fetch-depth: "0"
-      - name: 'Set example name'
+      - name: "Set example name"
         id: example_id
         run: echo "EXAMPLE_NAME=$(basename -- ${{ matrix.directory }})" >> "$GITHUB_OUTPUT"
       - name: Build & Push Docker Image to Github Registry
@@ -91,7 +90,7 @@ jobs:
   bump_version:
     name: Bump Version
     if: ${{ github.event_name != 'pull_request' }}
-    needs: [ trigger_serialize_register_examples, push_example_image_to_github ] # Only to ensure it can successfully build
+    needs: [trigger_serialize_register_examples, push_example_image_to_github] # Only to ensure it can successfully build
     uses: flyteorg/flytetools/.github/workflows/bump_version.yml@master
     secrets:
       FLYTE_BOT_PAT: ${{ secrets.FLYTE_BOT_PAT }}
@@ -122,7 +121,7 @@ jobs:
   release_workflow:
     name: Publish artifacts to github release
     runs-on: ubuntu-latest
-    needs: [ prerelease ]
+    needs: [prerelease]
     steps:
       - uses: actions/checkout@v2
         with:
@@ -152,7 +151,7 @@ jobs:
 
   make_release:
     name: Mark github pre-release as Release
-    needs: [ release_workflow ]
+    needs: [release_workflow]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

diff --git a/.github/workflows/docs_build.yml b/.github/workflows/docs_build.yml
@@ -15,10 +15,10 @@ jobs:
       - uses: actions/checkout@v3
         with:
           fetch-depth: "0"
-      - name: Set up Python 3.9
+      - name: Set up Python 3.11
         uses: actions/setup-python@v4
         with:
-          python-version: 3.9
+          python-version: 3.11
       - name: Report Sphinx Warnings
         id: sphinx-warnings
         # NOTE: myst-nb build warnings are logged in docs/_build/reports/*.err.log

diff --git a/.github/workflows/serialize_example.yml b/.github/workflows/serialize_example.yml
@@ -30,7 +30,7 @@ jobs:
       - uses: actions/checkout@v2
         with:
           fetch-depth: "0"
-      - name: 'Set example id'
+      - name: "Set example id"
         id: example_id
         run: echo "EXAMPLE_ID=$(echo ${{ matrix.directory }} | sed 's@/@-@g' | sed 's@_@-@g' )" >> "$GITHUB_OUTPUT"
       - name: Build docker image and serialize examples
@@ -43,7 +43,6 @@ jobs:
           name: snacks-${{ steps.example_id.outputs.EXAMPLE_ID }}
           path: ${{ matrix.directory }}/**/*.pb
 
-
   # Download all artifacts generated from the previous job. Startup a sandbox cluster then register all of them.
   register:
     name: Register example to sandbox

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -5,9 +5,9 @@
 # Required
 version: 2
 build:
-  os: "ubuntu-20.04"
+  os: "ubuntu-22.04"
   tools:
-    python: "3.9"
+    python: "3.11"
   apt_packages:
     - pandoc
 

diff --git a/dev-requirements.in b/dev-requirements.in
@@ -1,5 +1,5 @@
-flytekit>=1.7.0
-black==22.3.0
+flytekit
+black
 coverage
 flake8
 pre-commit