Skip to content

Conversation

rikatz
Copy link
Member

@rikatz rikatz commented Oct 9, 2025

What type of PR is this?
/kind gep
/kind documentation

What this PR does / why we need it:
This PR adds the memorandum GEP on how implementor should be writing API documentation, in a way to reduce the CRD size, the burden on Gateway API users and still provide meaningful information for other developers

Which issue(s) this PR fixes:
Fixes #4012

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added kind/gep PRs related to Gateway Enhancement Proposal(GEP) release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Oct 9, 2025
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Oct 9, 2025
@rikatz rikatz force-pushed the gep-4012-improve-godoc branch from b9cd854 to e18fedd Compare October 9, 2025 20:15
@rikatz
Copy link
Member Author

rikatz commented Oct 9, 2025

/cc @kflynn @candita @Miciah @shaneutt

@k8s-ci-robot
Copy link
Contributor

@rikatz: GitHub didn't allow me to request PR reviews from the following users: Miciah.

Note that only kubernetes-sigs members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @kflynn @candita @Miciah @shaneutt

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@rikatz
Copy link
Member Author

rikatz commented Oct 9, 2025

and
/cc @youngnick

@k8s-ci-robot k8s-ci-robot requested a review from youngnick October 9, 2025 20:16
@rikatz rikatz force-pushed the gep-4012-improve-godoc branch from e18fedd to bff7eb9 Compare October 9, 2025 20:17
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: rikatz
Once this PR has been reviewed and has the lgtm label, please assign danwinship for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/documentation Categorizes issue or PR as related to documentation. kind/gep PRs related to Gateway Enhancement Proposal(GEP) release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GEP: Improve godoc/CRD readability

2 participants