Skip to content

Commit 6b6e608

Browse files
rikatzyoungnick
andauthored
Update GEP template with some clarifying sections (#4073)
* Update GEP template with some clarifying sections * Apply suggestions on GEP template update Co-authored-by: Nick Young <inocuo@gmail.com> --------- Co-authored-by: Nick Young <inocuo@gmail.com>
1 parent 2d40c3d commit 6b6e608

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

geps/gep-696/index.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,27 @@
1313

1414
(Primary goals of this proposal.)
1515

16+
## Longer Term Goals (optional)
17+
18+
(goals that are not covered initially on this proposal but may be considered long term)
19+
1620
## Non-Goals
1721

1822
(What is out of scope for this proposal.)
1923

20-
## Introduction
24+
## Introduction/Overview
2125

2226
(Can link to external doc -- but we should bias towards copying
2327
the content into the GEP as online documents are easier to lose
2428
-- e.g. owner messes up the permissions, accidental deletion)
2529

30+
Write here "What" we want to do. What is the proposal aiming to do?
31+
32+
## Purpose (Why and Who)
33+
34+
Write here "Why" we want to do it. What problems are being solved? What personas are
35+
the target of this proposal, and why will this proposal will make their lives better?
36+
2637
## API
2738
(... details, can point to PR with changes)
2839

@@ -32,6 +43,17 @@ the content into the GEP as online documents are easier to lose
3243
### Gateway For Mesh (East/West)
3344
(Include East/West API considerations, examples, and if different - APIs)
3445

46+
## Request flow
47+
Example on the usage flow of this proposal/enhancement. It is suggested to contain
48+
at least one manifest as example.
49+
50+
Example of a flow description:
51+
52+
* A client makes a request to https://foo.example.com.
53+
* DNS resolves the name to a `Gateway` address.
54+
* The reverse proxy receives the request on a `Listener` and does something with it
55+
* The reverse proxy passes the request through `XPTORoute` modifying the headers to contain `XYZ`
56+
3557
## Conformance Details
3658

3759
(from https://github.com/kubernetes-sigs/gateway-api/blob/main/geps/gep-2162/index.md#standardize-features-and-conformance-tests-names)
@@ -60,6 +82,11 @@ In any case, the conformance tests file names should be meaningful and easy to u
6082

6183
(Make sure to also include conformance tests that cover mesh)
6284

85+
When describing the new feature, write down some conformance test scenarios the feature should manage,
86+
to guarantee that future implementors understand what "Conformance" means and what will be tested.
87+
88+
At least _some_ tests should be added at each phase, starting with Provisional.
89+
6390
## Alternatives
6491

6592
(List other design alternatives and why we did not go in that

0 commit comments

Comments
 (0)