Commit Graph

25 Commits

Author SHA1 Message Date
David Eads 86550d6f9b add guidance about avoiding cross namespace references from namespace resources 2021-02-22 15:50:08 -05:00
Ashish Billore ec191fa473
Minor corrections to the api conventions.
Fixed the API Group convention for readability.
2021-01-10 21:45:50 +09:00
Kubernetes Prow Robot 22e4475215
Merge pull request #5371 from bjhaid/master
Add an entry for `DELETE` on a collection of resources.
2021-01-04 11:41:56 -08:00
bjhaid 2199f730a5 Add an entry for `DELETE` on a collection of resources.
This adds an entry that matches the `GET` on a list of resources.
2020-12-17 14:03:18 -06:00
Paul Weil 05334d450a Correct list api examples and add link to field selector documentation 2020-12-08 13:30:48 -05:00
Clayton Coleman c2a0c7613b
api-conventions: Typo in initials 2020-11-11 14:55:01 -05:00
Clayton Coleman fb6963ada1
api-conventions: Clarify that constant rules apply to flags and config
Also clarify the use of proper names and acronyms within constants with
examples from existing use cases.
2020-11-11 13:14:16 -05:00
Kubernetes Prow Robot 04531ba1ae
Merge pull request #4521 from evankanderson/unconventional
Update Condition guidance
2020-09-24 09:42:05 -07:00
Evan Anderson 0a9d1ebe84 Adjust with suggested language from lavalamp 2020-09-23 22:16:45 -07:00
Evan Anderson dd082f4d2c Add guidance on conditions for long-running reconciliations 2020-09-17 13:51:49 -07:00
Evan Anderson 305d8d8ac0 Fix typo 2020-07-03 11:18:37 -07:00
divya-mohan0209 c9ae4756d5 Updated content under Naming Conventions in api-conventiones.md 2020-06-26 16:30:28 +00:00
Evan Anderson 5f972cff41 Updated with general consensus around resource naming, removed positive-polarity preference 2020-06-25 23:48:12 -07:00
divya-mohan0209 19b6ff012e
Updated api-conventions.md
Modified the first two bullet points under Naming conventions
2020-05-13 18:57:29 +05:30
Evan Anderson 49d3a5aad7 Clarify language thanks to liggitt 2020-04-17 15:16:22 -07:00
Evan Anderson 5cab966cc5 Drop positive-polarity exception for Ready 2020-03-27 14:41:41 -07:00
Evan Anderson 3a2c17b495 Update Condition guidance 2020-02-14 14:46:56 -08:00
Michael Taufen 0f8ce103ad
Remove last-updated date line from api-conventions.md
Rationale: The line hasn't been updated since 2017, even though changes were still being made to the doc. We can already see the last-updated date from the git history, and if we just update it now folks will probably continue forgetting to do so in the future.
2019-11-25 13:52:07 -08:00
Eric Tune a2cdce51a0 Document version string pattern
Document that the version portion of an apiVersion should be a DNS_LABEL.
This is required for CRDs, as encoded here:
https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/validation/validation.go#L176-L178
It seems like an eminently reasonable convention to have for built-in and aggregated APIs too.
2019-07-30 08:49:53 -07:00
Jay Pipes 0a79b6dc1e Grammar and Markdown fixes for api-conventions
When going through the api-conventions markdown doc online, I noticed a
couple small grammar and Markdown formatting issues. This patch fixes
those up.
2019-05-31 17:24:31 -04:00
Wojciech Sciesinski 95bb2fbd88 Fix link in api-conventions.md (#3739)
* Correct the link target

* Make the link description more precise

* Correct the link target - once again.

Co-Authored-By: Christoph Blecker <admin@toph.ca>
2019-05-27 10:59:50 -07:00
Paul Morie f2ea353488 Remove inconsistent use of bool as example 2019-05-22 10:07:45 -04:00
Lance Bragstad 702d10d7a4 Update links in api conventions document
As I was reading through api-conventions.md, I noticed a couple of
broken links. This commit updates those links to resolve to their
previously linked content.
2019-03-29 19:03:26 +00:00
Ivan Akulov 745d689910
Fix the link to the Strategic Merge Patch doc 2019-03-06 10:59:17 +03:00
eduartua 06207d2363 Created tombstone files for files moved to /devel/sig-architecture - URLs updated in k/community 2019-01-24 16:48:03 -06:00