Hide unimplemented API fields in docs

[arkodg]

Description:

Describe the desired behavior, what scenario it enables and how it
would be used.

• Do not publish docs for fields with a non-implemented annotation

[optional Relevant Links:]

Any extra documentation required to understand the issue.

[yuluo-yx]

I want to try, pls assign to me. @arkodg

[arkodg]

thanks @yuluo-yx

• recommend looking at api: support release channel #2549 on how to add annotations
• tcpKeepAlive in backendTrafficPolicy can be used to test this out (its currently unimplemented)

  gateway/api/v1alpha1/backendtrafficpolicy_types.go

  Line 67 in d44f4be

  TCPKeepalive *TCPKeepalive `json:"tcpKeepalive,omitempty"`

• the logic to skip/hide from docs is probably in here https://github.com/envoyproxy/gateway/tree/main/tools/crd-ref-docs/templates
  cc @zirain

[yuluo-yx]

hi, @arkodg. I found out that this document is for generating custom crd resources, right?

Also, I didn't find any field comment with non-implemented in the project code or in the official documentation, how should I look for such a field?

[zirain]

FYI:
not all custom markers are supportted, see more below

https://github.com/elastic/crd-ref-docs/blob/9a3105b6ca763ea03393fa6f396046ad7b5d4e38/processor/processor.go#L482

[github-actions]

This issue has been automatically marked as stale because it has not had activity in the last 30 days.