Skip to content

Commit

Permalink
update refs
Browse files Browse the repository at this point in the history
Signed-off-by: nikki everett <[email protected]>
  • Loading branch information
nikki everett committed Sep 5, 2024
1 parent 96de795 commit 3dbbb9e
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/user_guide/advanced_composition/map_tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ To begin, import the required libraries:
:lines: 1
```

Here's a simple workflow that uses {py:func}`map_task <flytekit:flytekit.map_task>`:
Here's a simple workflow that uses {py:func}`map_task <flytekit.map_task>`:

```{rli} https://raw.githubusercontent.com/flyteorg/flytesnacks/69dbe4840031a85d79d9ded25f80397c6834752d/examples/advanced_composition/advanced_composition/map_task.py
:caption: advanced_composition/map_task.py
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/advanced_composition/subworkflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ These external invocations of a workflow, initiated using launch plans from a pa
are termed as external workflows. They may have separate parallelism constraints since the context is not shared.

:::{tip}
If your deployment uses {ref}`multiple Kubernetes clusters <flyte:deployment-deployment-multicluster>`,
If your deployment uses {ref}`multiple Kubernetes clusters <deployment-deployment-multicluster>`,
external workflows may offer a way to distribute the workload of a workflow across multiple clusters.
:::

Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide/development_cycle/registering_workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ pre-defined cadence, and leverage the Flyte backend plugins like Spark.
This guide assumes that you:
- Have a local Flyte cluster running with `flytectl demo start` as described in {ref}`"Running workflows locally" <getting_started_running_workflow_local_cluster>` guide.
- Followed the {doc}`Creating a Flyte project <../getting_started_with_workflow_development/creating_a_flyte_project>`
- Followed the {doc}`Creating a Flyte project <../first_workflow/creating_a_flyte_project>`
guide to create a minimal Flyte project.
```

Expand Down Expand Up @@ -48,7 +48,7 @@ The following diagram provides a summarized view of the different registration p

The quickest way to register a task or workflow to a Flyte cluster is with the
`pyflyte run` CLI command. Assuming that you're inside the `my_project` directory
that we created in {doc}`Creating a Flyte project <../getting_started_with_workflow_development/creating_a_flyte_project>`,
that we created in {doc}`Creating a Flyte project <../first_workflow/creating_a_flyte_project>`,
you can invoke it like so:

```{prompt} bash $
Expand Down Expand Up @@ -342,7 +342,7 @@ you're:
You can also perform the equivalent of the three methods of registration using
a {py:class}`~flytekit.remote.remote.FlyteRemote` object. You can learn more
about how to do this {ref}`here <flytekit:design-control-plane>`.
about how to do this {ref}`here <design-control-plane>`.
```

## CI/CD with Flyte and GitHub Actions
Expand Down
4 changes: 2 additions & 2 deletions docs/user_guide/environment_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## Prerequisites

- Make sure you have [docker](https://docs.docker.com/get-docker/) and [git](https://git-scm.com/) installed.
- Install {doc}`flytectl <flytectl:index>`, the commandline interface for Flyte.
- Install {doc}`flytectl <../api/flytectl/index>`, the commandline interface for Flyte.

## Repo setup

Expand Down Expand Up @@ -167,7 +167,7 @@ These examples will explicitly show you which images to use for running these ex
image you want to use with the `--image` option in `pyflyte run`.
:::

🎉 Congrats! Now you can run all the examples in the {ref}`userguide` 🎉!
🎉 Congrats! Now you can run all the examples in the {ref}`user_guide` 🎉!

## Configuring the demo cluster to use additional resources

Expand Down
4 changes: 2 additions & 2 deletions docs/user_guide/extending/backend_plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ specification, `flytekit` plugin implementation, and `flytepropeller` plugin imp

### Interface specification

Usually Flyte extensions need information that is not covered by a {ref}`Flyte TaskTemplate <protos/docs/core/core:tasktemplate>`. The TaskTemplate consists of a
Usually Flyte extensions need information that is not covered by a {ref}`Flyte TaskTemplate <ref_flyteidl.core.TaskTemplate>`. The TaskTemplate consists of a
the interface, task_type identifier, some metadata and other fields.

```{note}
An important field to note here is {ref}`custom <protos/docs/core/core:tasktemplate>`. The custom field is essentially an unstructured JSON. This makes it possible to extend a task-template beyond the default supported targets {ref}`container <protos/docs/core/core:tasktemplate>`.
An important field to note here is {ref}`custom <ref_flyteidl.core.TaskTemplate>`. The custom field is essentially an unstructured JSON. This makes it possible to extend a task-template beyond the default supported targets {ref}`container <ref_flyteidl.core.TaskTemplate>`.
The motivation of the `custom`` field is to marshal a JSON structure that specifies information beyond what a regular TaskTemplate can capture. The actual structure of the JSON is known only to the implemented backend-plugin and the SDK components. The core Flyte platform, does not understand of look into the specifics of this structure.
```
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/first_workflow/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Machine learning engineers, data engineers, and data analysts often represent th
* - {doc}`Installing development tools <installing_development_tools>`
- Install the tools needed to create Flyte projects and run workflows and tasks.
* - {doc}`Creating a Flyte project <../getting_started_with_workflow_development/creating_a_flyte_project>`
* - {doc}`Creating a Flyte project <creating_a_flyte_project>`
- Create a Flyte project that contains workflow code and essential configuration files.
* - {doc}`Flyte project components <flyte_project_components>`
- Understand the directory structure, configuration files, and code in a Flyte project.
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/productionizing/schedules.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
.. tags:: Basic
```

{ref}`flyte:divedeep-launchplans` can be set to run automatically on a schedule using the Flyte Native Scheduler.
{ref}`divedeep-launchplans` can be set to run automatically on a schedule using the Flyte Native Scheduler.
For workflows that depend on knowing the kick-off time, Flyte supports passing in the scheduled time (not the actual time, which may be a few seconds off) as an argument to the workflow.

Check out a demo of how the Native Scheduler works:
Expand Down
4 changes: 2 additions & 2 deletions docs/user_guide/quickstart_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ def hello_world_wf(name: str = 'world') -> str:
return res
```

To learn more about tasks and workflows, see the {ref}`"Workflow code" section<getting_started_workflow_code>` of {doc}`"Flyte project components"<getting_started_with_workflow_development/flyte_project_components>`.
To learn more about tasks and workflows, see the {ref}`"Workflow code" section<getting_started_workflow_code>` of {doc}`"Flyte project components"<first_workflow/flyte_project_components>`.

## Next steps

To create a productionizable Flyte project to structure your code according to software engineering best practices, and that can be used to package your code for deployment to a Flyte cluster, see {doc}`"Getting started with workflow development" <getting_started_with_workflow_development/index>`.
To create a productionizable Flyte project to structure your code according to software engineering best practices, and that can be used to package your code for deployment to a Flyte cluster, see {doc}`"Getting started with workflow development" <first_workflow/index>`.

0 comments on commit 3dbbb9e

Please sign in to comment.