Update PeerAuth Documentation to indicate that API Dev is frozen

Open whitneygriffith opened this issue 1 year ago • 4 comments

I think we should update the API docs to indicate that the API is also frozen and likely to be replaced in ambient

Originally posted by @louiscryan in https://github.com/istio/api/issues/3112#issuecomment-1995142260

Mar 13 '24 23:03 whitneygriffith

@howardjohn should this just be a comment in both the v1beta1 and v1 resource? How do we set the source of truth for istio.io to be v1?

Also, how do I get the warning box similar to what was done for Istio Operator? https://istio.io/latest/docs/setup/install/operator/

Mar 13 '24 23:03 whitneygriffith

for istio.io, $mode: none is how to opt-out. So the one without that is the source of truth.

warning box is like

{{< warning >}}
blah
{{< /warning >}}

Mar 14 '24 15:03 howardjohn

@howardjohn I added $mode: none to v1beta1 and removed it from v1 but when make gen is run it reverses the changes, setting $mode: none on v1. Is this because of sync?

Mar 14 '24 17:03 whitneygriffith

The sync should only apply to lines after the sync-start line, which is after $mode

Mar 14 '24 17:03 howardjohn