@@ -31,9 +31,29 @@ metadata:
31
31
- [KEP template](https://github.com/kubernetes/community/pull/1124)
32
32
```
33
33
34
+ ## Table of Contents
35
+
36
+ - [ Kubernetes Enhancement Proposal Process] ( #kubernetes-enhancement-proposal-process )
37
+ - [ Metadata] ( #metadata )
38
+ - [ Summary] ( #summary )
39
+ - [ Motivation] ( #motivation )
40
+ - [ Reference-level explanation] ( #reference-level-explanation )
41
+ - [ What type of work should be tracked by a KEP] ( #what-type-of-work-should-be-tracked-by-a-kep )
42
+ - [ KEP Template] ( #kep-template )
43
+ - [ KEP Workflow] ( #kep-workflow )
44
+ - [ Git and GitHub Implementation] ( #git-and-github-implementation )
45
+ - [ KEP Editor Role] ( #kep-editor-role )
46
+ - [ Important Metrics] ( #important-metrics )
47
+ - [ Prior Art] ( #prior-art )
48
+ - [ Graduation Criteria] ( #graduation-criteria )
49
+ - [ Drawbacks] ( #drawbacks )
50
+ - [ Alternatives] ( #alternatives )
51
+ - [ Unresolved Questions] ( #unresolved-questions )
52
+ - [ Mentors] ( #mentors )
53
+
34
54
## Summary
35
55
36
- A standardized development process for Kubernetes is proposed in order to:
56
+ A standardized development process for Kubernetes is proposed in order to
37
57
38
58
- provide a common structure for proposing changes to Kubernetes
39
59
- ensure that the motivation for a change is clear
@@ -53,7 +73,14 @@ A standardized development process for Kubernetes is proposed in order to:
53
73
represented throughout the process
54
74
55
75
This process is supported by a unit of work called a Kubernetes Enhancement
56
- Proposal or KEP.
76
+ Proposal or KEP. A KEP attempts to combine aspects of a
77
+
78
+ - feature, effort, and launch tracking document
79
+ - a product requirements document
80
+ - design document
81
+
82
+ into one file which is created incrementally in collaboration with one or more
83
+ Special Interest Groups (SIGs).
57
84
58
85
## Motivation
59
86
@@ -115,13 +142,13 @@ contained in [design proposals][] is both clear and efficient. The KEP process
115
142
is intended to create high quality uniform design and implementation documents
116
143
for SIGs to deliberate.
117
144
118
- [ tell a story] : https://blog.rust-lang.org/2017/08/31/Rust-1.20.html
145
+ [ tell a story ] : https://blog.rust-lang.org/2017/08/31/Rust-1.20.html
119
146
[ road to Go 2 ] : https://blog.golang.org/toward-go2
120
147
[ survey data ] : http://opensourcesurvey.org/2017/
121
148
[ design proposals ] : https://github.com/kubernetes/community/tree/master/contributors/design-proposals
122
149
123
150
124
- ## Detailed design
151
+ ## Reference-level explanation
125
152
126
153
### What type of work should be tracked by a KEP
127
154
@@ -148,7 +175,7 @@ As the local bodies of governance, SIGs should have broad latitude in describing
148
175
what constitutes an enhancement which should be tracked through the KEP process.
149
176
SIGs may find that helpful to enumerate what _ does not_ require a KEP rather
150
177
than what does. SIGs also have the freedom to customize the KEP template
151
- according to their SIG specific concerns. For example the KEP template used
178
+ according to their SIG specific concerns. For example the KEP template used
152
179
to track API changes will likely have different subsections than the template
153
180
for proposing governance changes.
154
181
@@ -181,10 +208,10 @@ with possible paths through the state space
181
208
182
209
- opened -> deferred (a)
183
210
- opened -> rejected (b)
184
- - opened -> orphaned (c)
211
+ - opened -> orphaned (c)
185
212
- opened -> accepted -> orphaned (d)
186
213
- opened -> accepted -> scoped -> superseded (e)
187
- - opened -> accepted -> scoped -> orphaned (f)
214
+ - opened -> accepted -> scoped -> orphaned (f)
188
215
- opened -> accepted -> scoped -> started -> retired (g)
189
216
- opened -> accepted -> scoped -> started -> orphaned (h)
190
217
- opened -> accepted -> scoped -> started -> superseded (i)
@@ -259,7 +286,7 @@ likely very similar to the [PEP editor responsibilities][] and will hopefully
259
286
provide another opportunity for people who do not write code daily to contribute
260
287
to Kubernetes.
261
288
262
- In keeping with the PEP editors which
289
+ In keeping with the PEP editors which
263
290
264
291
> Read the PEP to check if it is ready: sound and complete. The ideas must make
265
292
> technical sense, even if they don't seem likely to be accepted.
0 commit comments