-
Notifications
You must be signed in to change notification settings - Fork 607
GEP-4012 - Godoc improvements #4160
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
b9cd854 to
e18fedd
Compare
|
@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. |
|
and |
e18fedd to
bff7eb9
Compare
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: rikatz 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 |
| @@ -0,0 +1,163 @@ | |||
| # GEP-4012: API documentation and readability | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is really great content, thanks @rikatz! To me, this feels like something that doesn't really need to be a GEP though. I'd be very open to making this a direct addition to our docs, maybe something resembling https://gateway-api.sigs.k8s.io/contributing/devguide/.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree memorandum may not be a great fit, and that the dev guide does seem like a reasonable fit.
I suggest we reformat this content under the devguide, tagging it to the bottom.
Then, we may want to create a follow-up issue to look at general improvements to that section, if we're unhappy with it.
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?: