Document objects more explicitly, maybe as Istio documents its objects.

[dsbos]

Summary

Argo Rollouts's K8s objects are not documented very explicitly or clearly. (Some are documented with examples that try to show most options, but without clear specifications of semantics and maybe not all alternatives.)

Consider documenting objects (the top-level objects and the various sub-objects) the way Istio documents its objects and subjects. (For example, see the member-by-member documentation and the sub-object documentation for DestinationRule.)

Use Cases

When would you use this?

Lots of times. (When I'm trying to determine exactly what to put in some configuration I'm creating. When I'm trying to determine what options I have.)

---

Message from the maintainers:

Impacted by this bug? Give it a 👍. We prioritize the issues with the most 👍.