From 6269bc3be7b6e080c2e59cb5bb5e28384193358f Mon Sep 17 00:00:00 2001 From: Elliot Gunton Date: Mon, 4 Dec 2023 14:08:24 +0000 Subject: [PATCH] Adjust mkdocs and about pages Signed-off-by: Elliot Gunton --- examples/workflows/upstream/about.md | 6 +++++- examples/workflows/use-cases/about.md | 5 +++-- mkdocs.yml | 13 +++++++++---- 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/examples/workflows/upstream/about.md b/examples/workflows/upstream/about.md index c5264d3e7..57dc67b25 100644 --- a/examples/workflows/upstream/about.md +++ b/examples/workflows/upstream/about.md @@ -1,3 +1,7 @@ # Upstream Examples -* Explain what upstream examples are \ No newline at end of file +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. \ No newline at end of file diff --git a/examples/workflows/use-cases/about.md b/examples/workflows/use-cases/about.md index 5262cf16e..978764489 100644 --- a/examples/workflows/use-cases/about.md +++ b/examples/workflows/use-cases/about.md @@ -1,3 +1,4 @@ -# Project Examples +# Use-Cases and Integrations Examples -* Explain what project examples are \ No newline at end of file +These examples show how to use third-party technologies in your Workflows, along with use-cases to show more in-depth +uses of Hera. diff --git a/mkdocs.yml b/mkdocs.yml index 86bad8030..09f369b70 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -34,16 +34,21 @@ nav: - Idiomatic Hera Examples: - Scripts: - ... | flat | examples/workflows/script/*.md - - DAGs and Steps: + - DAGs: - ... | flat | examples/workflows/dag/*.md + - Steps: - ... | flat | examples/workflows/steps/*.md - Loops: - ... | flat | examples/workflows/loops/*.md + - Artifacts: + - ... | flat | examples/workflows/artifacts/*.md - Experimental Features: - ... | flat | examples/workflows/experimental/*.md - - Project Examples: - - About: examples/workflows/projects/about.md - - ... | flat | examples/workflows/projects/*.md + - Unsorted Examples: + - ... | flat | examples/workflows/*.md + - Use-Cases and Integrations: + - About: examples/workflows/use-cases/about.md + - ... | flat | examples/workflows/use-cases/*.md - Upstream Examples: - About: examples/workflows/upstream/about.md - ... | flat | examples/workflows/upstream/*.md