From f63afb7fef0b09e85d53c61d7687bed0a5698740 Mon Sep 17 00:00:00 2001
From: Flaviu Vadan <flaviuvadan@gmail.com>
Date: Tue, 9 May 2023 08:10:40 -0600
Subject: [PATCH] add YAML optional dep doc (#623)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

<!-- Thank you for submitting a PR to Hera! 🚀 -->

**Pull Request Checklist**
- [ ] Fixes #<!--issue number goes here-->
- [ ] Tests added
- [ ] Documentation/examples added
- [ ] [Good commit messages](https://cbea.ms/git-commit/) and/or PR
title
<!-- Also remember to sign off commits or the DCO check will fail on
your PR! -->

**Description of PR**
<!-- If not linked to an issue, please describe your changes here -->

Currently, the optional YAML dep is not captured by docs

<!-- Piece of cake! ✨🍰✨ -->

Signed-off-by: Flaviu Vadan <flaviuvadan@gmail.com>
---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 85a77a926..65bb4b074 100644
--- a/README.md
+++ b/README.md
@@ -17,11 +17,13 @@ and its crew were specially protected by the goddess Hera.
 [![Versions](https://img.shields.io/pypi/pyversions/hera.svg)](https://github.com/argoproj-labs/hera)
 
 ### Stats after the [rename to Hera](https://github.com/argoproj-labs/hera/discussions/532)
+
 [![Downloads](https://pepy.tech/badge/hera)](https://pepy.tech/project/hera)
 [![Downloads/month](https://pepy.tech/badge/hera/month)](https://pepy.tech/project/hera)
 [![Downloads/week](https://pepy.tech/badge/hera/week)](https://pepy.tech/project/hera)
 
 ### Stats before the [rename to Hera](https://github.com/argoproj-labs/hera/discussions/532)
+
 [![Downloads](https://pepy.tech/badge/hera-workflows)](https://pepy.tech/project/hera-workflows)
 [![Downloads/month](https://pepy.tech/badge/hera-workflows/month)](https://pepy.tech/project/hera-workflows)
 [![Downloads/week](https://pepy.tech/badge/hera-workflows/week)](https://pepy.tech/project/hera-workflows)
@@ -76,6 +78,14 @@ publishes releases to both `hera` and `hera-workflows` for backwards compatibili
 | [Conda](https://anaconda.org/conda-forge/hera-workflows) | `conda install -c conda-forge hera-workflows`                                                        |
 | [GitHub repo](https://github.com/argoproj-labs/hera)     | `python -m pip install git+https://github.com/argoproj-labs/hera --ignore-installed`/`pip install .` |
 
+## Optional dependencies
+
+### yaml
+
+- Install via `hera[yaml]`
+- [PyYAML](https://pypi.org/project/PyYAML/) is required for the `yaml` output format, which is accessible via  
+  `hera.workflows.Workflow.to_yaml(*args, **kwargs)`. This enables GitOps practices and easier debugging
+
 # Examples
 
 ### Single step script