Skip to content

Update GEP template with some clarifying sections #4073

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
k8s-ci-robot merged 2 commits into from
Sep 19, 2025
Merged

Update GEP template with some clarifying sections #4073

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bfd522f
Update GEP template with some clarifying sections
rikatz Sep 8, 2025
baeb5ab
Apply suggestions on GEP template update
rikatz Sep 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion geps/gep-696/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,27 @@

(Primary goals of this proposal.)

## Longer Term Goals (optional)

(goals that are not covered initially on this proposal but may be considered long term)

## Non-Goals

(What is out of scope for this proposal.)

## Introduction
## Introduction/Overview

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

Write here "What" we want to do. What is the idea of the proposal
Comment thread
rikatz marked this conversation as resolved.
Outdated

## Purpose (Why and Who)

Write here "Why" we want to do it. What problems are being solved? What personas are
the target of this proposal, and why this proposal will make their lifes better.
Comment thread
rikatz marked this conversation as resolved.
Outdated

## API
(... details, can point to PR with changes)

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

## Request flow
Example on the usage flow of this proposal/enhancement. It is suggested to contain
at least one manifest as example.

Example of a flow description:

* A client makes a request to https://foo.example.com.
* DNS resolves the name to a `Gateway` address.
* The reverse proxy receives the request on a `Listener` and does something with it
* The reverse proxy passes the request through `XPTORoute` modifying the headers to contain `XYZ`

## Conformance Details

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

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

It is desired that, when describing the new feature, some conformance tests are added as a "What/Why"
to guarantee that future implementors understand what "Conformance means" and what will be tested.
Comment thread
rikatz marked this conversation as resolved.
Outdated

## Alternatives

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