Cleaning up GEP Template

kubernetes-sigs · Aug 5, 2021 · dad9f3c · dad9f3c
1 parent 3a6ee42
commit dad9f3c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 43 deletions.
diff --git a/site-src/geps/gep-696.md b/site-src/geps/gep-696.md
@@ -1,7 +1,7 @@
 # GEP-696: GEP template
 
-* Issue URL: https://github.com/kubernetes-sigs/gateway-api/issues/696
-* Status: (provisional, implementable, implemented, deferred, rejected, withdrawn, or replaced)
+* Issue: [#696](https://github.com/kubernetes-sigs/gateway-api/issues/696)
+* Status: Provisional|Implementable|Implemented|Deferred|Rejected|Withdrawn|Replaced
 
 (See definitions in [Kubernetes KEP][kep-status].
 
@@ -11,7 +11,15 @@
 
 (1-2 sentence summary of the proposal)
 
-## Motivation/User Journeys/Background
+## Goals
+
+(Primary goals of this proposal.)
+
+## Non-Goals
+
+(What is out of scope for this proposal.)
+
+## Introduction
 
 (Can link to external doc -- but we should bias towards copying
 the content into the GEP as online documents are easier to lose
@@ -27,10 +35,6 @@ the content into the GEP as online documents are easier to lose
 (List other design alternatives and why we did not go in that
 direction)
 
-## Out of scope
-
-(What is out of scope for this proposal.)
-
 ## References
 
 (Add any additional document links. Again, we should try to avoid

diff --git a/site-src/v1alpha2/contributing/gep.md b/site-src/v1alpha2/contributing/gep.md
@@ -46,42 +46,7 @@ can easily find previous discussions and alternatives considered.
 
 ## Format
 
-``` markdown
-# GEP-1234: Add Chaosnet protocol support
-
-Status: (provisional, implementable, implemented, deferred, rejected, withdrawn, or replaced)
-
-(See definitions in: https://github.com/kubernetes/enhancements/blob/master/keps/NNNN-kep-template/kep.yaml#L9)
-
-## TLDR
-
-(1-2 sentence summary of the proposal)
-
-## Motivation/User Journeys/Background
-
-(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)
-
-## API
-
-(... details, can point to PR with changes)
-
-
-## Alternatives
-
-(List other design alternatives and why we did not go in that
-direction)
-
-## Out of scope
-
-(What is out of scope for this proposal.)
-
-## References
-
-(Add any additional document links. Again, we should try to avoid
-too much content not in version control to avoid broken links)
-```
+GEPs should match the format of the template found in [GEP-696](/geps/gep-696).
 
 ## Out of scope