Skip to content

Commit 97f9065

Browse files
authored
Merge pull request #1797 from youngnick/update-gep-overview
Update GEP overview to clarify the GEP process
2 parents 1f9a255 + 293055a commit 97f9065

File tree

2 files changed

+34
-2
lines changed

2 files changed

+34
-2
lines changed

geps/overview.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,36 @@ process for the main Kubernetes project:
1111

1212
## Process
1313

14-
### 1. Circulate the Idea
14+
This diagram shows the state diagram of the GEP process at a high level, but the details are below.
15+
16+
<div align="center">
17+
```mermaid
18+
flowchart TD
19+
D([Discuss with<br />the community]) --> C
20+
C([Issue Created]) --> Provisional
21+
Provisional -->|GEP Doc PR<br />done| Implementable
22+
Provisional -->|If practical <br /> work needed| Prototyping
23+
Prototyping -->|GEP Doc PR<br />done| Implementable
24+
Implementable -->|Gateway API<br />work completed| Experimental
25+
Experimental -->|Supported in<br />multiple implementations<br />+ Conformance tests| Standard
26+
Standard -->|Entire change is GA or implemented| Completed
27+
```
28+
</div>
29+
30+
### 1. Discuss with the community
1531
Before creating a GEP, share your high level idea with the community. This can
1632
be in one of many forms:
1733

1834
- A [new GitHub Discussion](https://github.com/kubernetes-sigs/gateway-api/discussions/new)
1935
- On our [Slack Channel](https://kubernetes.slack.com/archives/CR0H13KGA)
2036
- On one of our [community meetings](https://gateway-api.sigs.k8s.io/contributing/?h=meetings#meetings)
2137

22-
### 2. Agree on the Goals
38+
### 2. Create an Issue
39+
[Create a GEP issue](https://github.com/kubernetes-sigs/gateway-api/issues/new?assignees=&labels=kind%2Ffeature&template=enhancement.md) in the repo describing your change.
40+
At this point, you should copy the outcome of any other conversations or documents
41+
into this document.
42+
43+
### 3. Agree on the Goals
2344
Although it can be tempting to start writing out all the details of your
2445
proposal, it's important to first ensure we all agree on the goals. The first
2546
version of your GEP should aim for a "Provisional" status and leave out any
@@ -58,6 +79,16 @@ any of the following:
5879
2. Graduating fields to "standard" by removing `<gateway:experimental>` tags
5980
3. Graduating a concept to "standard" by updating documentation
6081

82+
### 6. Close out the GEP issue
83+
84+
The GEP issue should only be closed once the feature has:
85+
- Moved to the standard channel for distribution (if necessary)
86+
- Moved to a "v1" `apiVersion` for CRDs
87+
- been completely implemented and has wide acceptance (for process changes).
88+
89+
In short, the GEP issue should only be closed when the work is "done" (whatever
90+
that means for that GEP).
91+
6192
## Status
6293

6394
Each GEP has a status field that defines it's current state. Each transition

hack/make-docs.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ esac
3131
}
3232

3333
# Move GEPs to site-src
34+
rm -rf site-src/geps
3435
cp -r geps site-src/geps
3536

3637
# Ensure site dir exists

0 commit comments

Comments
 (0)