Skip to content

Commit

Permalink
Fix relative links to new file locations
Browse files Browse the repository at this point in the history
Signed-off-by: Elliot Gunton <[email protected]>
  • Loading branch information
elliotgunton committed Dec 4, 2023
1 parent 148913e commit 8ae9bfb
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
5 changes: 2 additions & 3 deletions docs/examples/workflows/upstream/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,5 @@

The "Upstream" collection contains examples
[directly from the Argo Workflows repository](https://github.com/argoproj/argo-workflows/tree/6e97c7d/examples), such as
the [DAG Diamond example](workflows/upstream/dag_diamond.md), to demonstrate how the YAML spec maps to Hera classes.
These examples are generated and compared in Hera's CI/CD pipeline to ensure that all the examples are possible to
recreate in Hera.
the [DAG Diamond example](dag_diamond.md), to demonstrate how the YAML spec maps to Hera classes. These examples are
generated and compared in Hera's CI/CD pipeline to ensure that all the examples are possible to recreate in Hera.
2 changes: 1 addition & 1 deletion docs/user-guides/scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ There are two ways to specify output Artifacts and Parameters.

Function return annotations can be used to specify the output type information for output Artifacts and Parameters, and
the function should return a value or tuple. An example can be seen
[here](../examples/workflows/script_annotations_outputs.md).
[here](../examples/workflows/experimental/script_annotations_outputs.md).

For a simple hello world output artifact example we currently have:
```python
Expand Down
4 changes: 2 additions & 2 deletions docs/walk-through/advanced-hera-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,8 @@ set. We list graduated features here so you can keep up to date.
### `RunnerScriptConstructor`

The `RunnerScriptConstructor` found in `hera.workflows.script` and seen in the
[callable script example](../examples/workflows/callable_script.md) is a robust way to run Python functions on Argo.
The image used by the script should be built from the source code package itself and its dependencies, so that the
[callable script example](../examples/workflows/scripts/callable_script.md) is a robust way to run Python functions on
Argo. The image used by the script should be built from the source code package itself and its dependencies, so that the
source code's functions, dependencies, and Hera itself are available to run. The `RunnerScriptConstructor` is also
compatible with Pydantic so supports deserializing inputs to Python objects and serializing outputs to json strings.

Expand Down
2 changes: 1 addition & 1 deletion docs/walk-through/artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Artifacts are mainly used for outputs that are very large or are of non-text fil

## Artifacts in Hera

Here, we are looking at the [Script Artifact Passing](../examples/workflows/script_artifact_passing.md) example.
Here, we are looking at the [Script Artifact Passing](../examples/workflows/scripts/script_artifact_passing.md) example.

<details><summary>Click here to see the full example
</summary>
Expand Down
2 changes: 1 addition & 1 deletion docs/walk-through/loops.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ def create_orders():
> **Note:** we must import any modules used within the function itself, as Hera currently only passes the source lines
> of the function to Argo. If you need to import modules not in the standard Python image, use a custom image as
> described in [the `script` decorator](hello-world.md#the-script-decorator) section, or see the **experimental**
> [callable script](../examples/workflows/callable_script.md) example.
> [callable script](../examples/workflows/scripts/callable_script.md) example.
Now we can construct a Workflow that calls `create_orders`, and passes its `result` to `make_bubble_tea`. We'll need to
hold onto the `Step` returned from the `create_orders` call, and change `with_items` to `with_param` to use `.result`.
Expand Down
3 changes: 2 additions & 1 deletion docs/walk-through/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,8 @@ my_second_key=my_second_value
## Custom Types

Currently, custom types are only supported in the "script runner" experimental feature. See an example usage
[here](../examples/workflows/callable_script.md). Please note this is an experimental feature so support is limited for now.
[here](../examples/workflows/scripts/callable_script.md). Please note this is an experimental feature so support is
limited for now.

## Passing Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/walk-through/pydantic-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ Hera offers some features that explicitly rely on Pydantic. This includes the He
validate the function call. Using Pydantic classes in your function parameters unlocks the powerful serializing and
de-serializing features of Pydantic when running on Argo. Your functions can return objects that are serialized, passed
to another `Step` as a string argument, and then de-serialized in another function. This flow can be seen in
[the callable scripts example](../examples/workflows/callable_script.md).
[the callable scripts example](../examples/workflows/scripts/callable_script.md).

0 comments on commit 8ae9bfb

Please sign in to comment.