Commit Graph

76 Commits

Author SHA1 Message Date
Jordan Liggitt 2e9f1ea2f0 Address comments 2021-03-08 17:56:58 -05:00
Jordan Liggitt 9fe0b4c7f9 Describe process for allowing a new enum value in an existing field 2021-03-06 17:01:58 -05:00
Riaan Kleinhans f8d9d7294a Update conformance promotion details round removal of bazel 2021-03-03 12:09:25 +13:00
Kubernetes Prow Robot 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
David Eads 86550d6f9b add guidance about avoiding cross namespace references from namespace resources 2021-02-22 15:50:08 -05:00
Khaled Henidak (Kal) 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
hasheddan 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
Nikhita Raghunath c0e8b136e5 Remove licensing subproject, move doc to vendor.md 2021-01-13 15:54:07 +05:30
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
Kubernetes Prow Robot 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
Kubernetes Prow Robot 7e31e7499e
Merge pull request #5300 from saschagrunert/platforms
Add guide for shipping alternative platforms
2021-01-04 08:05:57 -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
Sascha Grunert 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
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
Kubernetes Prow Robot 243f993094
Merge pull request #4773 from divya-mohan0209/patch-1
Updated api-conventions.md
2020-08-07 09:18:18 -07:00
knight42 1cf544cb29
doc: describe how to run conformance tests with kind
Signed-off-by: knight42 <anonymousknight96@gmail.com>
2020-08-03 11:00:57 +08:00
Aaron Crickenberger 8c0af106aa Fix formatting nit in example conformance comment 2020-07-28 16:41:04 -07:00
Erik L. Arneson 3302b378b4 Index all SIG contributions to the Developer Guide
The initial purpose of this is to make sure there are no orphaned
files in the Developer Guide, so we can make a complete map of all the
content there.
2020-07-15 09:22:06 -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
Stephen Heywood 6dab5060b7 Replace refs for conformance.txt to conformance.yaml 2020-06-10 07:30:38 +00: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 f0fdf1c914 Merge remote-tracking branch 'upstream/master' into unconventional 2020-03-27 14:38:06 -07:00
Robert Kielty 95fdc65c13
fixes contrib doc bug #4486 - kubetest replaces hack/e2e.go (#4563)
* fixes contrib doc bug #4486 - kubetest replaces hack/e2e.go

* Update contributors/devel/sig-testing/e2e-tests.md

Restoring original list formatting for doc consistency.

Co-Authored-By: Bob Killen <killen.bob@gmail.com>

* Update contributors/devel/sig-testing/e2e-tests.md

Co-Authored-By: Bob Killen <killen.bob@gmail.com>

Co-authored-by: Bob Killen <killen.bob@gmail.com>
2020-03-10 10:43:35 -07:00
Evan Anderson 3a2c17b495 Update Condition guidance 2020-02-14 14:46:56 -08:00
Aaron Crickenberger 2eb7d04ae5 Add two clarifications to conformance requirements
Based on conformance meeting today

- we want to allow a test to exercise the event API to verify it can
  be exercised; this isn't depending on a specific component to
  generate a specific event

- we don't want to allow tests which are attempting to exercise the
  componentstatus API as there is a KEP out to deprecate it, and all
  involved don't want to add more code around componentstatus
2020-01-14 15:19:22 -08:00
Nikhita Raghunath 4b9e4b4ca4 sig-arch/staging: add note about semver-like tags 2019-12-11 10:23:41 +05:30
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
Patrick Decat 174ea01d78 Update the location of the list of staging repositories published
Since https://github.com/kubernetes/publishing-bot/pull/148/, the list of staging repositories published has been externalized to https://raw.githubusercontent.com/kubernetes/kubernetes/master/staging/publishing/rules.yaml and https://raw.githubusercontent.com/kubernetes/kubernetes/master/staging/publishing/rules-godeps.yaml.

For repositories, refer to https://git.k8s.io/kubernetes/staging/README.md.

For branches, the output of the following command needs manual processing:

```
```

Also, refer to public CNCF cluster http://git.k8s.io/publishing-bot/k8s-publishing-bot.md
2019-11-19 01:37:03 +01:00
Caleb Woodbine b019e985f9 Add literal string requirement 2019-08-27 10:43:01 +12:00
Devan Carpenter 5663868a88
Conformance Tests: Reduce soak time for new tests
New tests don't need to be run for a full release-cycle before getting
promoted to Conformance. Two weeks is sufficient, and more practical.
2019-08-12 17:30:59 -07:00
Aaron Crickenberger caf0d1d618 Kubelet API access should not be allowed for conformance tests 2019-08-08 15:06:02 -07:00
Kubernetes Prow Robot 3074987725
Merge pull request #3948 from heyste/patch-1
Ensure that conformance.txt is regenerated
2019-08-01 09:38:15 -07:00
Stephen Heywood 5be295c8da
Ensure that conformance.txt is regenerated 2019-08-01 10:07:20 +12: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
Draven 7e4037b332
doc: add an extra space between document and for 2019-07-03 23:47:40 +08:00
Jordan Liggitt 47f58b5491 Add rationale for preserving persisted data for alpha fields 2019-06-25 08:18:34 -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
Timothy St. Clair d3a393ebe7 Update recommendations for tests that don't meet
conformance criteria.
2019-05-08 09:22:59 -05:00