Rollout Spec Docs Out of Date

[danielhelfand]

Summary

This was first brought up in #2018.

The Rollout spec documentation is missing quite a few properties. It should be updated to reflect the current state of the rollout spec.

Listed below are some of the undocumented properties:

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11080

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11111

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11141

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11150

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11230

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11285

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11294

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11307

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11320

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11346

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11358

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11415

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11424

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11437

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11597

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11606

https://github.com/argoproj/argo-rollouts/blob/b3647826d5dc740775f1def6ed27fe6e4fa9ff43/manifests/install.yaml#L11724

Use Cases

This will be incredibly important for users of Rollouts at all levels to be able to adopt Rollouts in general as well as new features.

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

[huikang]

It would be nice if the spec can be generated from the rollout API definition.

[danielhelfand]

Seems workflows has doc generation based on swagger/scripting. Maybe something similar could be done here.

https://github.com/argoproj/argo-workflows/blob/64a2b28a5fb51b50fe0e0a30185a8c3400d10548/Makefile#L596

[github-actions[bot]]

This issue is stale because it has been open 60 days with no activity.

[github-actions[bot]]

This issue is stale because it has been open 60 days with no activity.