Skip to content

Commit c6ce4da

Browse files
calebamilesErin A Boyd
authored and
Erin A Boyd
committed
address comments
from: @bgrant0607 - kubernetes#967 (comment)
1 parent 33135df commit c6ce4da

File tree

1 file changed

+35
-8
lines changed

1 file changed

+35
-8
lines changed

contributors/design-proposals/architecture/kubernetes-enhancement-proposal-process.md

+35-8
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,29 @@ metadata:
3131
- [KEP template](https://github.com/kubernetes/community/pull/1124)
3232
```
3333

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+
3454
## Summary
3555

36-
A standardized development process for Kubernetes is proposed in order to:
56+
A standardized development process for Kubernetes is proposed in order to
3757

3858
- provide a common structure for proposing changes to Kubernetes
3959
- ensure that the motivation for a change is clear
@@ -53,7 +73,14 @@ A standardized development process for Kubernetes is proposed in order to:
5373
represented throughout the process
5474

5575
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).
5784

5885
## Motivation
5986

@@ -115,13 +142,13 @@ contained in [design proposals][] is both clear and efficient. The KEP process
115142
is intended to create high quality uniform design and implementation documents
116143
for SIGs to deliberate.
117144

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
119146
[road to Go 2]: https://blog.golang.org/toward-go2
120147
[survey data]: http://opensourcesurvey.org/2017/
121148
[design proposals]: https://github.com/kubernetes/community/tree/master/contributors/design-proposals
122149

123150

124-
## Detailed design
151+
## Reference-level explanation
125152

126153
### What type of work should be tracked by a KEP
127154

@@ -148,7 +175,7 @@ As the local bodies of governance, SIGs should have broad latitude in describing
148175
what constitutes an enhancement which should be tracked through the KEP process.
149176
SIGs may find that helpful to enumerate what _does not_ require a KEP rather
150177
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
152179
to track API changes will likely have different subsections than the template
153180
for proposing governance changes.
154181

@@ -181,10 +208,10 @@ with possible paths through the state space
181208

182209
- opened -> deferred (a)
183210
- opened -> rejected (b)
184-
- opened -> orphaned (c)
211+
- opened -> orphaned (c)
185212
- opened -> accepted -> orphaned (d)
186213
- opened -> accepted -> scoped -> superseded (e)
187-
- opened -> accepted -> scoped -> orphaned (f)
214+
- opened -> accepted -> scoped -> orphaned (f)
188215
- opened -> accepted -> scoped -> started -> retired (g)
189216
- opened -> accepted -> scoped -> started -> orphaned (h)
190217
- opened -> accepted -> scoped -> started -> superseded (i)
@@ -259,7 +286,7 @@ likely very similar to the [PEP editor responsibilities][] and will hopefully
259286
provide another opportunity for people who do not write code daily to contribute
260287
to Kubernetes.
261288

262-
In keeping with the PEP editors which
289+
In keeping with the PEP editors which
263290

264291
> Read the PEP to check if it is ready: sound and complete. The ideas must make
265292
> technical sense, even if they don't seem likely to be accepted.

0 commit comments

Comments
 (0)