Skip to content

Commit 4d834c3

Browse files
committed
npep add user-stores section
Change the NPEP template add a user-stories section, while also adding some notes on how to write good user stories. Signed-off-by: Andrew Stoycos <[email protected]>
1 parent 032c677 commit 4d834c3

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

npep/npep-95.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,39 @@
1313

1414
## Non-Goals
1515

16-
(What is out of scope for this proposal.)
16+
(What is explicitly out of scope for this proposal.)
1717

1818
## Introduction
1919

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

24+
## User-Stories/Use-Cases
25+
26+
(What new user-stories/use-cases does this proposal introduce?)
27+
28+
A user story should typically have a summary structured this way:
29+
30+
1. **As a** [user concerned by the story]
31+
2. **I want** [goal of the story]
32+
3. **so that** [reason for the story]
33+
34+
The “so that” part is optional if more details are provided in the description.
35+
A story can also be supplemented with examples, diagrams, or additional notes.
36+
37+
e.g
38+
39+
Story 1: Deny traffic at a cluster level
40+
41+
As a cluster admin, I want to apply non-overridable deny rules to certain pod(s)
42+
and(or) Namespace(s) that isolate the selected resources from all other cluster
43+
internal traffic.
44+
45+
For Example: The admin wishes to protect a sensitive namespace by applying an
46+
AdminNetworkPolicy which denies ingress from all other in-cluster resources
47+
for all ports and protocols.
48+
2449
## API
2550

2651
(... details, can point to PR with changes)

0 commit comments

Comments
 (0)