Skip to content

Commit

Permalink
move docs around, update redirects
Browse files Browse the repository at this point in the history
Signed-off-by: nikki everett <nikki@union.ai>
  • Loading branch information
neverett committed May 2, 2024
1 parent 0d7abc3 commit 996ed39
Show file tree
Hide file tree
Showing 9 changed files with 341 additions and 565 deletions.
8 changes: 7 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,13 @@
"user_guide/data_types_and_io/flytefile": "../../data_types_and_io/flytefile.html",
"user_guide/data_types_and_io/pickle_type": "../../data_types_and_io/pickle_type.html",
"user_guide/data_types_and_io/pytorch_type": "../../data_types_and_io/pytorch_type.html",
"user_guide/data_types_and_io/structureddataset": "../../data_types_and_io/structureddataset.html"
"user_guide/data_types_and_io/structureddataset": "../../data_types_and_io/structureddataset.html",
"user_guide/testing/index": "../../development_cycle/testing",
"user_guide/testing/mocking_tasks": "../../development_cycle/testing",
"flyte_fundamentals/index": "../core_concepts/index.html",
"flyte_fundamentals/registering_workflows": "../development_cycle/registering_workflows.html",
"flyte_fundamentals/tasks_workflows_and_launch_plans": "../core_concepts/index.html",
"flyte_fundamentals/optimizing_tasks": "../core_concepts/tasks/index.html"
}


Expand Down
325 changes: 324 additions & 1 deletion docs/core_concepts/tasks/task_caching.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/development_cycle/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ registering_workflows
interactive_tasks
setting_up_ci_cd_deployment
task_resource_validation
testing
automation_with_flyteremote
```
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# Mocking tasks
(testing)=

# Testing

The `flytekit` python SDK provides a few utilities for making it easier to test
your tasks and workflows in your test suite. For more details, you can also refer
to the {py:mod}`~flytekit.testing` module in the API reference.

## Mocking tasks

A lot of the tasks that you write you can run locally, but some of them you will not be able to, usually because they are tasks that depend on a third-party only available on the backend. Hive tasks are a common example, as most users will not have access to the service that executes Hive queries from their development environment. However, it's still useful to be able to locally run a workflow that calls such a task. In these instances, flytekit provides a couple of utilities to help navigate this.

Expand Down
2 changes: 0 additions & 2 deletions docs/flyte_fundamentals/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,7 @@ cluster, see the {ref}`Deployment Guide <deployment>`.
:maxdepth: -1
:hidden:
tasks_workflows_and_launch_plans
running_and_scheduling_workflows
visualizing_task_input_and_output
optimizing_tasks
extending_flyte
```
209 changes: 0 additions & 209 deletions docs/flyte_fundamentals/optimizing_tasks.md

This file was deleted.

Loading

0 comments on commit 996ed39

Please sign in to comment.