Commit Graph

157 Commits

Author SHA1 Message Date
Jordan Liggitt f88bbbabe8
Document short-names and categories 2023-05-17 08:45:17 -04:00
Kubernetes Prow Robot 594d391253
Merge pull request #7244 from ChristopherFry/cfry/api-conventions-kubernetes-docs-links
Fix kubernetes doc links in api conventions doc
2023-04-24 15:03:02 -07:00
Kubernetes Prow Robot f9ba4b9394
Merge pull request #7182 from mattcary/fuzz
Clarify fuzzer operation
2023-04-04 13:39:38 -07:00
Kubernetes Prow Robot bc2cb20754
Merge pull request #7063 from ninjaprox/patch-1
Correct `generateName` doc when in conflict
2023-04-04 13:35:39 -07:00
Kubernetes Prow Robot 84286d6754
Merge pull request #6559 from pohly/kubectl-get-tables
api changes: document how to support `kubectl get`
2023-04-04 13:31:39 -07:00
Chris Fry b8e17d97af Fix kubernetes doc links in api conventions doc 2023-04-04 20:13:12 +00:00
Matthew Cary c3c4496a89 Clarify fuzzer operation 2023-03-14 08:56:52 -07:00
Vinh Nguyen 1bf6d426e7
Update api-conventions.md 2023-03-14 22:04:17 +08:00
Vinh Nguyen f2f8ed71ce
Update contributors/devel/sig-architecture/api-conventions.md
Co-authored-by: Daniel Smith <dbsmith@google.com>
2023-03-10 11:16:08 +08:00
AhmedGrati 3f1dbcfe75 docs: fix api convention concurrency control and consistency part typo
Signed-off-by: AhmedGrati <ahmedgrati1999@gmail.com>
2023-02-26 11:02:35 +01:00
Kubernetes Prow Robot 822141d2d7
Merge pull request #7145 from hatfieldbrian/patch-1
Fix design-proposals links in API conventions
2023-02-22 06:51:56 -08:00
Kubernetes Prow Robot 8083aaac04
Merge pull request #7150 from kerthcet/cleanup/fix-anchor
Fix error anchor link of multiple-api-versions
2023-02-21 22:26:07 -08:00
Kante Yin 25e638d91b Fix error anchor link of multiple-api-versions
Signed-off-by: Kante Yin <kerthcet@gmail.com>
2023-02-20 17:48:04 +08:00
hatfieldbrian bd2ab6ed27
Fix design-proposals links in API conventions 2023-02-17 03:39:12 -07:00
Clayton Coleman deeb1086fa
Describe the demotion process for a conformance test
We have not previously documented demotion of a conformance test,
although we have several examples. A request for a backport of
demotion was questioned based on the lack of process and this update
clarifies that responsibility.
2023-01-26 15:35:59 -05:00
Vinh Nguyen 4631c307ea Correct `generateName` doc when in conflict 2023-01-24 10:19:24 +08:00
Kubernetes Prow Robot c318a6811f
Merge pull request #6264 from porridge/patch-1
Update stale reference to etcd modifiedIndex
2022-10-12 03:45:00 -07:00
Parthvi Vala d0cb25a2b3
Fix typos in the conformance-tests doc 2022-09-20 13:06:00 +05:30
Kubernetes Prow Robot 317f798301
Merge pull request #6690 from Sea-n/design-proposals-archive
Fix links for k/design-proposals-archive
2022-08-25 11:40:07 -07:00
Kubernetes Prow Robot aebb7a3860
Merge pull request #6816 from czunker/docs_beta_api
Fix some beta API documentation now that they are off by default
2022-08-25 06:04:07 -07:00
Christian Zunker b1fa3ee688 Incorporate review feedback
Signed-off-by: Christian Zunker <christian.zunker@gmail.com>
2022-08-24 08:46:24 +02:00
Ahmet Alp Balkan 5ba422e1aa
api-conventions: fix leftover merge conflict mark
This seems to be a leftover.
2022-08-21 22:56:17 -07:00
Kubernetes Prow Robot a329a26b15
Merge pull request #6558 from deads2k/metav1-Condition
update condition guidance to use metav1.Conditions
2022-08-20 17:13:57 -07:00
Christian Zunker 2ec502aa45 Fix some beta API documentation now that they are off by default 2022-08-19 10:58:22 +02:00
Tim Hockin b7bd632138 API conventions: add more on defaulting
In reviewing an issue/PR I realized this lesson had not been documented
anywhere.  This is not the ideal mechanism, IMO, but better than
nothing.
2022-08-16 08:44:49 -07:00
Kubernetes Prow Robot 885c29c9e2
Merge pull request #6787 from thockin/object-lifecycle
Add a short developer doc on object lifecycle
2022-08-15 14:05:55 -07:00
Tim Hockin f81812f956 Add a short doc on object lifecycle
Emphasis on "DELETING" as a distinct state.  I keep finding controllers
which do not handle it at all.
2022-08-15 13:59:22 -07:00
Tianyang 4990bb8cca
Update contributors/devel/sig-architecture/api_changes.md
Co-authored-by: Christoph Blecker <admin@toph.ca>
2022-08-14 10:51:16 +08:00
Tianyang 99ef2ff060
devel: fix/update script path in api_changes.md
Signed-off-by: tianyang ni tianzong48@gmail.com

/sig architecture
/kind cleanup documentation
2022-08-13 23:22:46 +08:00
Sean Wei 6690abcd6b Fix links for k/design-proposals-archive 2022-08-03 08:32:16 +08:00
Kubernetes Prow Robot 89d1fe2bd2
Merge pull request #6536 from Riaankl/update-conformance-tests.md
update conformance-tests.md
2022-04-03 15:26:09 -07:00
Riaan Kleinhans 7ebe82693f
Update conformance-tests.md 2022-03-31 06:35:46 +13:00
Patrick Ohly ea32ba1958 api changes: document how to support `kubectl get`
These pointers may help developers who are new to the code.
2022-03-23 17:00:56 +01:00
David Eads 4bee49a231 update condition guidance to use metav1.Conditions 2022-03-23 08:59:24 -04:00
David Eads 9a4dbd3878 Remove recommendation for condition heartbeat
Heartbeats previously caused significant standing load, they are not
recommended for API types.
2022-03-23 08:51:01 -04:00
Kubernetes Prow Robot 94ed8aaed7
Merge pull request #6541 from deads2k/api-off-by-default
add details for testing beta APIs now that they are off by default
2022-03-17 15:30:42 -07:00
David Eads d1c12d11d4 clarify how to name kubernetes label and annotation keys 2022-03-16 16:26:36 -04:00
David Eads 6bf340de5f add details for testing beta APIs now that they are off by default 2022-03-16 11:05:44 -04:00
Riaan Kleinhans 41e37715de
update conformance-tests.md 2022-03-14 14:26:37 +13:00
yuyang f1cd9abe6d fixed a tiny typo error 2022-03-10 11:23:07 +08:00
Elana Hashman f8148d406c
Note when PUT can create items
See https://github.com/kubernetes/community/issues/6041#issuecomment-1021176213
2022-01-25 11:44:36 -08:00
Tim Hockin b20f6135ee
Loosen the meaning of status in API conventions (#5842)
* Loosen the meaning of status in API conventions

As per KEP https://github.com/kubernetes/enhancements/issues/2527 -
remove the "from observation" guidance and add some discussion of when
to use status fields vs. additional types for allocated resources.

* Backtick spec and status

* Act on feedback
2022-01-10 14:42:25 -08:00
Kubernetes Prow Robot f058d9c79c
Merge pull request #5723 from Jefftree/default
Add default tag to api conventions
2022-01-10 10:33:12 -08:00
Madhav Jivrajani 1a8b4eb0c0 devel: fix/update links in api_changes.md
Signed-off-by: Madhav Jivrajani <madhav.jiv@gmail.com>
2022-01-06 11:09:28 +05:30
Ayushman 737df3cb8d
Changed all instances of k-dev@ and kubernetes-dev@ to dev@kubernetes.io (#6311)
* Changed all instancesof k-dev@ and kubernetes-dev@ to dev@kubernetes.io

Changes Removed From archive

updated the link

changes made

csv undo

changed links

* Fix last two instances of googlegroups.com

* Revert changes to election docs for past elections

Co-authored-by: Christoph Blecker <admin@toph.ca>
2022-01-04 21:36:32 -08:00
Marcin Owsiany 8b80565cb9
Update stale reference to etcd modifiedIndex 2021-12-03 09:26:55 +01:00
Claudiu Belu a48453ebf6 Removes [Exclude:WindowsDocker] test tag
We've removed support for Windows Docker in Kubernetes v1.24, so
we no longer need this tag.

Updates a few of the Windows tests considerations, since a few of them
are supported by Windows Containerd
2021-11-16 08:55:15 -08:00
Elana Hashman 8076461701
Document expectations of feature gate use per PRR 2021-11-18 08:48:15 -08:00
Chris Negus 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
Kubernetes Prow Robot 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