4f95b92105
Add note to api conventions about kind: List ( #5903 )
...
* Add note to api conventions about kind: List
* Wording change
* Fixed small typo
2021-10-12 11:32:33 -07:00
91bc44bf75
Merge pull request #5973 from robscott/kind-vs-resource-refs
...
Clarifying API Conventions regarding Kind and Resource in object refs
2021-09-14 06:27:09 -07:00
faebec1acf
Update API pluralization docs
...
Based on Service ClusterIPs pluralization.
2021-09-10 16:03:09 -07:00
99780a63a6
add auto resource release
2021-09-07 18:40:57 +00:00
83877032b5
Clarifying API Conventions regarding Kind and Resource in object refs
2021-09-01 15:22:29 -07:00
51b267d7a4
remove bazel build
2021-07-25 16:35:42 +08:00
f9798eb69c
Merge pull request #5869 from msau42/update-api-docs
...
Update steps on how to make a new API version
2021-07-16 05:16:09 -07:00
0c8bda6665
Update steps on how to make a new API version and add guidance around structuring commits for API promotions
2021-07-15 18:10:40 -07:00
a843caa9b1
Merge pull request #5832 from toumorokoshi/feature/consolidate-object-reference-guidance
...
consolidate object ref guidance in api conventions
2021-07-09 10:54:53 -07:00
00d73216d3
consolidate object ref guidance in api conventions
...
API conventions had two semi-duplicated sections for
object references, with slightly different guidance.
Consolidating guidance to point to the most recent
guidance.
Clarifying the naming recommendations for naming of lists
of object references, as the guidance was not explicit.
2021-06-18 13:46:40 -07:00
1cc043a0b8
Merge pull request #5825 from dims/add-guidance-on-SHA-vs-tags-in-dependencies
...
Add guidance on SHA vs tags in dependencies
2021-06-16 09:20:00 -07:00
e519a8ba75
Merge pull request #5630 from kikisdeliveryservice/feature-gates-doc
...
sig-arch: Working with feature gates doc
2021-06-14 18:58:00 -07:00
1445c6177a
Apply suggestions from code review
...
Co-authored-by: Shamsher Ansari <shaansar@redhat.com>
2021-06-13 17:56:42 -04:00
c7d7335957
Add guidance on SHA vs tags in dependencies
...
Signed-off-by: Davanum Srinivas <davanum@gmail.com>
2021-06-10 14:37:33 -04:00
744e270f33
Apply suggestions from code review
...
Co-authored-by: Jordan Liggitt <jordan@liggitt.net>
2021-06-03 22:44:36 -07:00
1df12ac90f
Adding object references security considerations
...
Clarifying practices around object references that help
prevent against privilege escalation.
2021-06-03 22:44:36 -07:00
1aed2f6904
Merge pull request #5782 from alculquicondor/patch-1
...
Explain use of feature labels for alpha and beta releases
2021-06-01 10:43:51 -07:00
545177d8db
Add note to ensure tests run in presubmits
2021-06-01 10:53:39 -04:00
ac7999cb51
Addressing comments
...
including blurb recommending using multi resource object references
if there is a chance it will be used that way.
2021-05-25 22:32:35 -07:00
bda0f5062e
Addressing feeedback
...
- new section around resources with different versions
- called out edge cases around resource not found
- removed very old todo
2021-05-24 21:51:07 -07:00
9b694b1b79
Update contributors/devel/sig-architecture/api-conventions.md
...
Co-authored-by: Daniel Smith <dbsmith@google.com>
2021-05-24 21:51:07 -07:00
fed5c1e6a6
Addressing feedback
...
- switching fieldpath syntax to reference best practices already in the
spec
- clarifying naming of the object reference field
- fixing a poor example with a kind used where a resource value should
have been.
2021-05-24 21:51:07 -07:00
e5fb87eafa
addressing comments
...
- switched from kind to resource.
- extended examples to four kinds of object references.
- clarified use of JSON Pointer to determine the path to the field.
2021-05-24 21:51:07 -07:00
b1f8f5975c
clarifying schema for multi-kind object references
...
There are a few types of patterns for multi-kind object references
that are currently included in the Kubernetes core resources
(EnvVarSource, ObjectReference).
Adding a section to clarify the preferred pattern for future
resources.
2021-05-24 21:51:07 -07:00
bffe980b66
Merge pull request #5470 from ccouzens/patch-1
...
API conventions: escape back-quotes when visible
2021-05-10 04:24:51 -07:00
27e1a81029
Include documentation for listTypes in api conventions
2021-04-05 15:42:41 -07:00
8828f0e589
update and refine feature-gates.md
2021-03-21 17:15:00 -07:00
544dc8c691
Update contributors/devel/sig-architecture/feature-gates.md
...
Co-authored-by: Elana Hashman <ehashman@users.noreply.github.com>
2021-03-13 17:45:22 -08:00
0d97e560fd
Update contributors/devel/sig-architecture/feature-gates.md
...
Co-authored-by: Elana Hashman <ehashman@users.noreply.github.com>
2021-03-13 17:45:22 -08:00
b6e823d655
Update contributors/devel/sig-architecture/feature-gates.md
...
Co-authored-by: Elana Hashman <ehashman@users.noreply.github.com>
2021-03-13 17:45:22 -08:00
eb43242e29
Add a doc on how we work with feature gates
...
Signed-off-by: Davanum Srinivas <davanum@gmail.com>
2021-03-13 17:45:22 -08:00
2e9f1ea2f0
Address comments
2021-03-08 17:56:58 -05:00
9fe0b4c7f9
Describe process for allowing a new enum value in an existing field
2021-03-06 17:01:58 -05:00
f8d9d7294a
Update conformance promotion details round removal of bazel
2021-03-03 12:09:25 +13:00
1847825a90
Merge pull request #5455 from deads2k/objectref-guidance
...
add guidance about avoiding cross namespace references from namespaced resource
2021-02-22 12:54:03 -08:00
86550d6f9b
add guidance about avoiding cross namespace references from namespace resources
2021-02-22 15:50:08 -05:00
d67ae0845e
minor update to api_changes to highlight gate on/off scenario ( #5521 )
...
* minor update to api_changes to highlight gate on/off scenario
* Update contributors/devel/sig-architecture/api_changes.md
Co-authored-by: Jordan Liggitt <jordan@liggitt.net>
* Update contributors/devel/sig-architecture/api_changes.md
Co-authored-by: Jordan Liggitt <jordan@liggitt.net>
* Update contributors/devel/sig-architecture/api_changes.md
Co-authored-by: Jordan Liggitt <jordan@liggitt.net>
* Update contributors/devel/sig-architecture/api_changes.md
Co-authored-by: Jordan Liggitt <jordan@liggitt.net>
* Update contributors/devel/sig-architecture/api_changes.md
Co-authored-by: Jordan Liggitt <jordan@liggitt.net>
Co-authored-by: Jordan Liggitt <jordan@liggitt.net>
2021-02-18 09:42:52 -08:00
7af4f21daf
API conventions: escape back-quotes when visible
...
> When referencing another field name, indicate the name in back-quotes. Example: "must be greater than `request`".
In this sentence, we're meant to see "request" surrounded by back-quotes.
In markdown, backticks (back-quotes) are used to create a code section, and thus aren't shown. By escaping them, they are shown to the user.
2021-02-05 17:28:04 +00:00
929c016930
Move new platform support guide to k/sig-release
...
Moves new platform support guide to live alongside documentation of
support tiers and tier 3 build docs.
Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
2021-02-02 10:44:10 -06:00
c0e8b136e5
Remove licensing subproject, move doc to vendor.md
2021-01-13 15:54:07 +05:30
ec191fa473
Minor corrections to the api conventions.
...
Fixed the API Group convention for readability.
2021-01-10 21:45:50 +09:00
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
952b06b6e2
Merge pull request #5356 from pweil-/fix-list-examples
...
Correct list api examples and add link to field selector documentation
2021-01-04 08:09:56 -08:00
7e31e7499e
Merge pull request #5300 from saschagrunert/platforms
...
Add guide for shipping alternative platforms
2021-01-04 08:05:57 -08:00
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
05334d450a
Correct list api examples and add link to field selector documentation
2020-12-08 13:30:48 -05:00
4c14c6faea
Add guide for shipping alternative platforms
...
This outline should help contributors to get an idea about what needs to
be done to add additional supported platforms to Kubernetes.
Signed-off-by: Sascha Grunert <sgrunert@suse.com>
2020-12-04 13:49:19 +01:00
c2a0c7613b
api-conventions: Typo in initials
2020-11-11 14:55:01 -05:00
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
04531ba1ae
Merge pull request #4521 from evankanderson/unconventional
...
Update Condition guidance
2020-09-24 09:42:05 -07:00
Chris Negus
Kubernetes Prow Robot
Tim Hockin
Khaled (Kal) Henidak
Rob Scott
SataQiu
Michelle Au
Yusuke Tsutsumi
Davanum Srinivas
Aldo Culquicondor
Antoine Pelisse
Kirsten Garrison
Jordan Liggitt
Riaan Kleinhans
David Eads
Chris Couzens
hasheddan
Nikhita Raghunath
Ashish Billore
bjhaid
Paul Weil
Sascha Grunert
Clayton Coleman