aperture icon indicating copy to clipboard operation
aperture copied to clipboard

Doc generator reorders properties alphabetically

Open krdln opened this issue 2 years ago • 1 comments

See eg. https://aperture-tech-docs.netlify.app/docs/development/reference/configuration/policies#v1-rule. Since rego and extractor are required (mutually exclusive) variants of rule, they should go first and optional properties should go last. Now there's a sandwich.

Or see https://aperture-tech-docs.netlify.app/docs/development/reference/configuration/policies#-v1scheduler – the first fields are auto_tokens and default_workload, which require understanding workloads first, which is the last field.

Order of properties in docs should be the same as in definition. See envoy docs. This allows to control the reading order and put more important stuff on front.

This bug was fixed some time ago (https://github.com/fluxninja/cloud/pull/4349) (before moving to github issues), but now I see it was reintroduced.

krdln avatar Aug 30 '22 13:08 krdln

still relevant

DariaKunoichi avatar Sep 12 '23 19:09 DariaKunoichi