docs: update `examples/README.md` to its current usage - Githubissues

argoproj / argo-workflows

Workflow Engine for Kubernetes

https://argo-workflows.readthedocs.io/

Apache License 2.0

15.11k stars 3.21k forks source link

docs: update `examples/README.md` to its current usage #13812

Open agilgur5 opened 4 weeks ago

agilgur5 commented 4 weeks ago

Noticed this during https://github.com/argoproj/argo-workflows/pull/13645 et al when setting up embedded examples

Motivation

it previously said things were moved to the walk through, but the whole directory is still used
- perhaps in the past this README in the past was used like a walk through, but this is no longer accurate and is confusing / misleading

Modifications

update it to mention its usage in the docs, such as in embedded examples like in https://github.com/argoproj/argo-workflows/pull/13645 and the Field Reference
- could also remove the file entirely, but the directory is used, so I figure it could have a short summary of how/where it is used

Verification

markdown renders correctly (see rich diff)