Repository navigation
Add guidance on API documentation - #4160
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
bff7eb9 to
98f4d40
Compare
98f4d40 to
0186976
Compare
youngnick
left a comment
There was a problem hiding this comment.
Some native-speaker suggestions for tidying up the English. English sucks.
|
thanks @youngnick ! Commited your suggestions here! |
|
The Kubernetes project currently lacks enough contributors to adequately respond to all PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
|
/remove-lifecycle stale |
7a8aef5 to
f67a62b
Compare
| * What is the main feature of the API and Field - Eg.: "`foo` allows configuring how a | ||
| a header should be forwarded to backends" | ||
| * What is the support level of the field - Eg.: "Support: Core/Extended/Implementation Specific" | ||
| * Caveats of that field - Eg.: "Setting `goo` field can have conflicts with `bar` field, and in this |
There was a problem hiding this comment.
| * Caveats of that field - Eg.: "Setting `goo` field can have conflicts with `bar` field, and in this | |
| * Caveats of that field - Eg.: "Setting `foo` field can have conflicts with `bar` field, and in this |
There was a problem hiding this comment.
updated on my last commit
|
@rikatz Thanks for sticking with this! I make one suggested edit to fix what looks like a typo, but I think we should land this. 🙂 |
|
👍 /lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: kflynn The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/hold |
Co-authored-by: Nick Young <inocuo@gmail.com>
1507301 to
18bb130
Compare
|
/hold cancel |
|
/lgtm |
|
/lgtm |
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?: