Skip to content

Commit

Permalink
Adjust mkdocs and about pages
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 54ff0db commit 6269bc3
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 7 deletions.
6 changes: 5 additions & 1 deletion examples/workflows/upstream/about.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Upstream Examples

* Explain what upstream examples are
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.
5 changes: 3 additions & 2 deletions examples/workflows/use-cases/about.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Project Examples
# Use-Cases and Integrations Examples

* Explain what project examples are
These examples show how to use third-party technologies in your Workflows, along with use-cases to show more in-depth
uses of Hera.
13 changes: 9 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 6269bc3

Please sign in to comment.