-
Notifications
You must be signed in to change notification settings - Fork 40k
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
Document API/system design principles and patterns #6133
Comments
|
Status and spec principles: https://groups.google.com/forum/#!topic/kubernetes-dev/HKg8OD_PNfw |
Other things I noticed missing from api-conventions.md:
|
And pod-states.md is woefully out of date (e.g., it references "PodStatus" rather than "PodPhase"). |
Working on API-visible conventions first. |
Updated API conventions and other details, per #6133.
Another principle: all relevant API info should be represented in json. Relevant HTTP header fields should mirror the json fields. One example that came up just now: status codes (which are represented in Status). We've previously discussed using Etags and If-Match, also. We're going in this direction for URL query parameters, also. |
…rnetes#4182. # *** ERROR: *** docs are out of sync between cli and markdown # run hack/run-gendocs.sh > docs/kubectl.md to regenerate # # Your commit will be aborted unless you regenerate docs. COMMIT_BLOCKED_ON_GENDOCS
…rnetes#4182. # *** ERROR: *** docs are out of sync between cli and markdown # run hack/run-gendocs.sh > docs/kubectl.md to regenerate # # Your commit will be aborted unless you regenerate docs. COMMIT_BLOCKED_ON_GENDOCS
Related to #5476, #2003, #1007, #5620, and other issues.
The PR creation rate and number of contributors are both growing. In order to scale the effort, we need to better document the patterns we want additions to the system and API to follow, so that we can better parallelize the design and review effort. I'm filing this issue to solicit important principles and patterns to document. I volunteer to create the actual document and/or presentation slides.
What do you think isn't sufficiently covered by existing design docs and/or isn't sufficiently discoverable? What principles/patterns do you find yourself explaining over and over again? What properties would you be unhappy to have violated/degraded/changed by new PRs?
I'm thinking more about reasonably general issues rather than implementation-oriented invariants that apply to very specific/narrow parts of the code.
Examples (some areas, some principles):
Let's brainstorm first, and argue and prioritize afterward.
@smarterclayton @derekwaynecarr @thockin @erictune @lavalamp
The text was updated successfully, but these errors were encountered: