WIP: Simplify godocs on APIs#4888
Draft
rikatz wants to merge 1 commit into
Draft
Conversation
Contributor
|
Skipping CI for Draft Pull Request. |
Member
Author
|
/hold |
Member
Author
|
/approve cancel |
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind cleanup
/kind documentation
What this PR does / why we need it:
This PR simplifies the exposed Godocs, moving user facing comments and implementers guides to proper places to reduce the burden of a user when reading the API docs, while making the docs still useful.
This is a WIP, written by claude based on the Documentation design and I wanted to see how far the changes would go. This is still to be (heavily) discussed
Which issue(s) this PR fixes:
Fixes #
Does this PR introduce a user-facing change?:
Claude Summary
Reorganize Gateway API godoc comments to separate user-facing documentation
from implementation details using
<gateway:util:excludeFromCRD>tags.User-facing text (what a field does, valid values, support level) stays visible
in CRDs,
kubectl explain, and API references. Implementation details(conditions to set, error handling, precedence rules, reconciliation behavior)
move behind the tags — still visible in Go source and
go doc, but strippedfrom generated CRDs.
Changes
30 changes across 5 files in
apis/v1/:gateway_types.go— 11 fields: Listeners, Hostname, AllowedRoutes,ProtocolType, ClientCertificateRef, CertificateRefs, CACertificateRefs,
Value, Addresses, SupportedKinds, AttachedRoutes
httproute_types.go— 8 fields: Hostnames, Matches, Filters, BackendRefs,Type, BackendRef (mirror), BackendRef (backend), ExternalAuthProtocol
grpcroute_types.go— 6 fields: Hostnames, Matches, Filters, BackendRefs,Type, BackendRef
backendtlspolicy_types.go— 2 fields: TargetRefs, CACertificateRefsshared_types.go— 3 fields: SectionName, Port, ParentRefsNot changed (struct-level comments): GatewayClass and GRPCRoute type
descriptions were left as-is because the CRD generator only processes
excludeFromCRDtags on field descriptions, not on type-level descriptions.CRD Size Reduction
Constraints
go doc)